Queue.java 63.0 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 com.google.common.collect.ImmutableList;
28
import hudson.AbortException;
29
import hudson.BulkChange;
30
import hudson.CopyOnWrite;
31 32
import hudson.ExtensionList;
import hudson.ExtensionPoint;
33
import hudson.Util;
K
kohsuke 已提交
34
import hudson.XmlFile;
K
kohsuke 已提交
35 36
import hudson.init.Initializer;
import static hudson.init.InitMilestone.JOB_LOADED;
37 38
import static hudson.util.Iterators.reverse;

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

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

97
import javax.servlet.ServletException;
K
kohsuke 已提交
98

99
import jenkins.model.Jenkins;
K
kohsuke 已提交
100
import org.acegisecurity.AccessDeniedException;
101 102
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.HttpResponses;
K
kohsuke 已提交
103 104 105 106 107
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.converters.basic.AbstractSingleValueConverter;
108
import org.kohsuke.stapler.QueryParameter;
K
kohsuke 已提交
109

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

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

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

161
    /**
162 163
     * {@link Task}s that are being handed over to the executor, but execution
     * has not started yet.
164 165 166
     */
    private final ItemList<BuildableItem> pendings = new ItemList<BuildableItem>();

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
    private final CachedItemList itemsView = new CachedItemList();

    /**
     * Maintains a copy of {@link Queue#getItems()}
     *
     * @see Queue#getApproximateItemsQuickly()
     */
    private class CachedItemList {
        /**
         * The current cached value.
         */
        @CopyOnWrite
        private volatile List<Item> itemsView = Collections.emptyList();
        /**
         * When does the cache info expire?
         */
        private final AtomicLong expires = new AtomicLong();

        List<Item> get() {
            long t = System.currentTimeMillis();
            long d = expires.get();
            if (t>d) {// need to refresh the cache
                long next = t+1000;
                if (expires.compareAndSet(d,next)) {
                    // avoid concurrent cache update via CAS.
                    // if the getItems() lock is contended,
                    // some threads will end up serving stale data,
                    // but that's OK.
                    itemsView = ImmutableList.copyOf(getItems());
                }
            }
            return itemsView;
        }
    }

K
kohsuke 已提交
202 203
    /**
     * Data structure created for each idle {@link Executor}.
204
     * This is a job offer from the queue to an executor.
205 206
     *
     * <p>
K
kohsuke 已提交
207 208
     * An idle executor (that calls {@link Queue#pop()} creates
     * a new {@link JobOffer} and gets itself {@linkplain Queue#parked parked},
209
     * and we'll eventually hand out an {@link #workUnit} to build.
K
kohsuke 已提交
210
     */
K
kohsuke 已提交
211
    public class JobOffer extends MappingWorksheet.ExecutorSlot {
K
kohsuke 已提交
212
        public final Executor executor;
K
kohsuke 已提交
213 214 215 216 217

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

K
kohsuke 已提交
220
        /**
221
         * The work unit that this {@link Executor} is going to handle.
K
kohsuke 已提交
222 223
         * (Or null, in which case event is used to trigger a queue maintenance.)
         */
224
        private WorkUnit workUnit;
K
kohsuke 已提交
225

K
kohsuke 已提交
226
        private JobOffer(Executor executor) {
K
kohsuke 已提交
227 228 229
            this.executor = executor;
        }

K
kohsuke 已提交
230 231
        @Override
        protected void set(WorkUnit p) {
232 233
            assert this.workUnit == null;
            this.workUnit = p;
K
kohsuke 已提交
234 235 236
            event.signal();
        }

K
kohsuke 已提交
237 238 239 240 241
        @Override
        public Executor getExecutor() {
            return executor;
        }

242 243 244
        /**
         * Verifies that the {@link Executor} represented by this object is capable of executing the given task.
         */
245
        public boolean canTake(BuildableItem item) {
246 247 248
            Node node = getNode();
            if (node==null)     return false;   // this executor is about to die

249
            if(node.canTake(item)!=null)
250
                return false;   // this node is not able to take the task
251

252
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all())
253
                if (d.canTake(node,item)!=null)
254
                    return false;
255 256 257 258 259 260 261

            return isAvailable();
        }

        /**
         * Is this executor ready to accept some tasks?
         */
K
kohsuke 已提交
262
        public boolean isAvailable() {
263
            return workUnit == null && !executor.getOwner().isOffline() && executor.getOwner().isAcceptingTasks();
K
kohsuke 已提交
264 265 266 267 268 269 270
        }

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

        public boolean isNotExclusive() {
271
            return getNode().getMode() == Mode.NORMAL;
K
kohsuke 已提交
272 273 274
        }
    }

S
stephenconnolly 已提交
275
    /**
K
kohsuke 已提交
276
     * The executors that are currently waiting for a job to run.
S
stephenconnolly 已提交
277
     */
K
kohsuke 已提交
278
    private final Map<Executor,JobOffer> parked = new HashMap<Executor,JobOffer>();
K
kohsuke 已提交
279

280
    private volatile transient LoadBalancer loadBalancer;
281

282
    private volatile transient QueueSorter sorter;
283

284 285
    public Queue(LoadBalancer loadBalancer) {
        this.loadBalancer =  loadBalancer.sanitize();
286 287 288 289 290
        // 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);
    }

291 292 293 294 295 296
    public LoadBalancer getLoadBalancer() {
        return loadBalancer;
    }

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

300 301 302 303 304 305 306 307
    public QueueSorter getSorter() {
        return sorter;
    }

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

K
kohsuke 已提交
308 309 310 311 312
    /**
     * Loads the queue contents that was {@link #save() saved}.
     */
    public synchronized void load() {
        try {
K
TAB->WS  
kohsuke 已提交
313
            // first try the old format
K
kohsuke 已提交
314
            File queueFile = getQueueFile();
K
kohsuke 已提交
315 316
            if (queueFile.exists()) {
                BufferedReader in = new BufferedReader(new InputStreamReader(new FileInputStream(queueFile)));
317 318 319 320 321 322 323 324 325
                try {
                    String line;
                    while ((line = in.readLine()) != null) {
                        AbstractProject j = Jenkins.getInstance().getItemByFullName(line, AbstractProject.class);
                        if (j != null)
                            j.scheduleBuild();
                    }
                } finally {
                    in.close();
K
TAB->WS  
kohsuke 已提交
326 327 328 329 330 331
                }
                // discard the queue file now that we are done
                queueFile.delete();
            } else {
                queueFile = getXMLQueueFile();
                if (queueFile.exists()) {
332
                    List list = (List) new XmlFile(XSTREAM, queueFile).read();
K
kohsuke 已提交
333 334 335
                    int maxId = 0;
                    for (Object o : list) {
                        if (o instanceof Task) {
336
                            // backward compatibility
337
                            schedule((Task)o, 0);
K
kohsuke 已提交
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
                        } 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 已提交
354
                    }
K
kohsuke 已提交
355
                    WaitingItem.COUNTER.set(maxId);
356 357 358 359 360 361 362 363 364

                    // 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 已提交
365 366 367
                    queueFile.delete();
                }
            }
368
        } catch (IOException e) {
369
            LOGGER.log(Level.WARNING, "Failed to load the queue file " + getXMLQueueFile(), e);
K
kohsuke 已提交
370 371 372 373 374 375 376
        }
    }

    /**
     * Persists the queue contents to the disk.
     */
    public synchronized void save() {
377 378
        if(BulkChange.contains(this))  return;
        
K
kohsuke 已提交
379
        // write out the tasks on the queue
380
    	ArrayList<Queue.Item> items = new ArrayList<Queue.Item>();
K
kohsuke 已提交
381
    	for (Item item: getItems()) {
K
kohsuke 已提交
382
            if(item.task instanceof TransientTask)  continue;
383
    	    items.add(item);
K
kohsuke 已提交
384
    	}
K
kohsuke 已提交
385

K
kohsuke 已提交
386
        try {
387 388 389
            XmlFile queueFile = new XmlFile(XSTREAM, getXMLQueueFile());
            queueFile.write(items);
            SaveableListener.fireOnChange(this, queueFile);
390
        } catch (IOException e) {
391
            LOGGER.log(Level.WARNING, "Failed to write out the queue file " + getXMLQueueFile(), e);
K
kohsuke 已提交
392 393 394
        }
    }

395 396 397
    /**
     * Wipes out all the items currently in the queue, as if all of them are cancelled at once.
     */
398
    @CLIMethod(name="clear-queue")
399
    public synchronized void clear() {
400
        Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
401 402
        for (WaitingItem i : waitingList)
            i.onCancelled();
403
        waitingList.clear();
404 405
        blockedProjects.cancelAll();
        buildables.cancelAll();
406 407 408
        scheduleMaintenance();
    }

K
kohsuke 已提交
409
    private File getQueueFile() {
410
        return new File(Jenkins.getInstance().getRootDir(), "queue.txt");
K
TAB->WS  
kohsuke 已提交
411
    }
K
kohsuke 已提交
412

413
    /*package*/ File getXMLQueueFile() {
414
        return new File(Jenkins.getInstance().getRootDir(), "queue.xml");
K
TAB->WS  
kohsuke 已提交
415
    }
K
kohsuke 已提交
416

417 418 419 420 421 422 423 424
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(AbstractProject)}
     */
    public boolean add(AbstractProject p) {
        return schedule(p)!=null;
    }

K
kohsuke 已提交
425 426
    /**
     * Schedule a new build for this project.
427
     *
428 429 430
     * @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 已提交
431
     */
432 433
    public WaitingItem schedule(AbstractProject p) {
        return schedule(p, p.getQuietPeriod());
434 435 436 437
    }

    /**
     * Schedules a new build with a custom quiet period.
438 439
     *
     * <p>
K
kohsuke 已提交
440 441
     * Left for backward compatibility with &lt;1.114.
     *
442
     * @since 1.105
443 444
     * @deprecated as of 1.311
     *      Use {@link #schedule(Task, int)}
445
     */
446 447
    public boolean add(AbstractProject p, int quietPeriod) {
        return schedule(p, quietPeriod)!=null;
K
kohsuke 已提交
448
    }
449 450 451 452

    /**
     * Schedules an execution of a task.
     *
453
     * @param actions
K
kohsuke 已提交
454 455 456
     *      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.
457
     *      For the convenience of the caller, this list can contain null, and those will be silently ignored.
458 459 460 461 462 463 464 465 466 467
     * @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) {
468 469 470 471 472 473 474
        // 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 已提交
475 476 477 478 479
    	for(QueueDecisionHandler h : QueueDecisionHandler.all())
    		if (!h.shouldSchedule(p, actions))
                return null;    // veto

        return scheduleInternal(p, quietPeriod, actions);
480
    }
481

482 483 484 485 486 487 488 489 490 491 492 493 494
    /**
     * 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 已提交
495
        Calendar due = new GregorianCalendar();
496
    	due.add(Calendar.SECOND, quietPeriod);
497

498
        // Do we already have this task in the queue? Because if so, we won't schedule a new one.
499
    	List<Item> duplicatesInQueue = new ArrayList<Item>();
K
kohsuke 已提交
500
    	for(Item item : getItems(p)) {
501
    		boolean shouldScheduleItem = false;
K
kohsuke 已提交
502 503
    		for (QueueAction action: item.getActions(QueueAction.class)) {
                shouldScheduleItem |= action.shouldSchedule(actions);
504
    		}
K
kohsuke 已提交
505 506
    		for (QueueAction action: Util.filter(actions,QueueAction.class)) {
                shouldScheduleItem |= action.shouldSchedule(item.getActions());
507 508 509 510 511
    		}
    		if(!shouldScheduleItem) {
    			duplicatesInQueue.add(item);
    		}
    	}
512
    	if (duplicatesInQueue.isEmpty()) {
513
    		LOGGER.fine(p.getFullDisplayName() + " added to queue");
514

515
    		// put the item in the queue
K
kohsuke 已提交
516 517 518 519 520
            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 已提交
521

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

K
kohsuke 已提交
524 525 526
        // but let the actions affect the existing stuff.
        for(Item item : duplicatesInQueue) {
            for(FoldableAction a : Util.filter(actions,FoldableAction.class)) {
527
                a.foldIntoExisting(item, p, actions);
K
kohsuke 已提交
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
            }
        }

        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 已提交
554
    }
555
    
556 557 558 559
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(Task, int)} 
     */
560
    public synchronized boolean add(Task p, int quietPeriod) {
561
    	return schedule(p, quietPeriod)!=null;
562 563
    }

564 565 566 567 568 569
    public synchronized WaitingItem schedule(Task p, int quietPeriod) {
    	return schedule(p, quietPeriod, new Action[0]);
    }

    /**
     * @deprecated as of 1.311
570
     *      Use {@link #schedule(Task, int, Action...)} 
571
     */
572
    public synchronized boolean add(Task p, int quietPeriod, Action... actions) {
573 574 575
    	return schedule(p, quietPeriod, actions)!=null;
    }

576
    /**
K
kohsuke 已提交
577
     * Convenience wrapper method around {@link #schedule(Task, int, List)}
578
     */
579 580
    public synchronized WaitingItem schedule(Task p, int quietPeriod, Action... actions) {
    	return schedule(p, quietPeriod, Arrays.asList(actions));
581
    }
K
kohsuke 已提交
582

K
kohsuke 已提交
583
    /**
584
     * Cancels the item in the queue. If the item is scheduled more than once, cancels the first occurrence.
K
kohsuke 已提交
585
     *
586 587
     * @return true if the project was indeed in the queue and was removed.
     *         false if this was no-op.
K
kohsuke 已提交
588
     */
K
kohsuke 已提交
589
    public synchronized boolean cancel(Task p) {
K
kohsuke 已提交
590
        LOGGER.fine("Cancelling " + p.getFullDisplayName());
K
kohsuke 已提交
591 592
        for (Iterator<WaitingItem> itr = waitingList.iterator(); itr.hasNext();) {
            Item item = itr.next();
K
kohsuke 已提交
593
            if (item.task.equals(p)) {
K
kohsuke 已提交
594
                itr.remove();
595
                item.onCancelled();
K
kohsuke 已提交
596
                return true;
K
kohsuke 已提交
597 598
            }
        }
K
kohsuke 已提交
599
        // use bitwise-OR to make sure that both branches get evaluated all the time
600
        return blockedProjects.cancel(p)!=null | buildables.cancel(p)!=null;
K
kohsuke 已提交
601
    }
602 603 604
    
    public synchronized boolean cancel(Item item) {
        LOGGER.fine("Cancelling " + item.task.getFullDisplayName() + " item#" + item.id);
605 606 607 608 609
        // 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;
610
    }
K
kohsuke 已提交
611

612 613 614 615 616 617 618 619 620 621 622
    /**
     * Called from {@code queue.jelly} and {@code entries.jelly}.
     */
    public HttpResponse doCancelItem(@QueryParameter int id) throws IOException, ServletException {
        Item item = getItem(id);
        if (item != null) {
            cancel(item);
        } // else too late, ignore (JENKINS-14813)
        return HttpResponses.forwardToPreviousPage();
    }

K
kohsuke 已提交
623
    public synchronized boolean isEmpty() {
624
        return waitingList.isEmpty() && blockedProjects.isEmpty() && buildables.isEmpty() && pendings.isEmpty();
K
kohsuke 已提交
625 626
    }

627
    private synchronized WaitingItem peek() {
628
        return waitingList.iterator().next();
K
kohsuke 已提交
629 630 631 632
    }

    /**
     * Gets a snapshot of items in the queue.
633 634 635
     *
     * Generally speaking the array is sorted such that the items that are most likely built sooner are
     * at the end.
K
kohsuke 已提交
636
     */
637
    @Exported(inline=true)
K
kohsuke 已提交
638
    public synchronized Item[] getItems() {
639
        Item[] r = new Item[waitingList.size() + blockedProjects.size() + buildables.size() + pendings.size()];
640 641
        waitingList.toArray(r);
        int idx = waitingList.size();
642 643
        for (BlockedItem p : blockedProjects.values())
            r[idx++] = p;
644
        for (BuildableItem p : reverse(buildables.values()))
645
            r[idx++] = p;
646 647
        for (BuildableItem p : reverse(pendings.values()))
            r[idx++] = p;
K
kohsuke 已提交
648 649
        return r;
    }
650 651 652 653 654

    /**
     * Like {@link #getItems()}, but returns an approximation that might not be completely up-to-date.
     *
     * <p>
J
Jesse Glick 已提交
655
     * At the expense of accuracy, this method does not usually lock {@link Queue} and therefore is faster
656 657 658 659
     * in a highly concurrent situation.
     *
     * <p>
     * The list obtained is an accurate snapshot of the queue at some point in the past. The snapshot
J
Jesse Glick 已提交
660
     * is updated and normally no more than one second old, but this is a soft commitment that might
661 662 663 664 665 666 667 668 669 670
     * get violated when the lock on {@link Queue} is highly contended.
     *
     * <p>
     * This method is primarily added to make UI threads run faster.
     *
     * @since 1.483
     */
    public List<Item> getApproximateItemsQuickly() {
        return itemsView.get();
    }
671 672 673 674 675
    
    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;
676
        for (Item item: pendings) if (item.id == id) return item;
677 678
    	return null;
    }
K
kohsuke 已提交
679

K
kohsuke 已提交
680 681 682
    /**
     * Gets all the {@link BuildableItem}s that are waiting for an executor in the given {@link Computer}.
     */
683 684
    public synchronized List<BuildableItem> getBuildableItems(Computer c) {
        List<BuildableItem> result = new ArrayList<BuildableItem>();
685 686 687 688 689 690
        _getBuildableItems(c, buildables, result);
        _getBuildableItems(c, pendings, result);
        return result;
    }

    private void _getBuildableItems(Computer c, ItemList<BuildableItem> col, List<BuildableItem> result) {
691
        Node node = c.getNode();
692
        for (BuildableItem p : col.values()) {
693
            if (node.canTake(p) == null)
694
                result.add(p);
695 696 697
        }
    }

K
kohsuke 已提交
698
    /**
699
     * Gets the snapshot of all {@link BuildableItem}s.
K
kohsuke 已提交
700 701
     */
    public synchronized List<BuildableItem> getBuildableItems() {
702 703 704
        ArrayList<BuildableItem> r = new ArrayList<BuildableItem>(buildables.values());
        r.addAll(pendings.values());
        return r;
K
kohsuke 已提交
705 706
    }

707 708 709 710 711 712 713
    /**
     * Gets the snapshot of all {@link BuildableItem}s.
     */
    public synchronized List<BuildableItem> getPendingItems() {
        return new ArrayList<BuildableItem>(pendings.values());
    }

714 715
    /**
     * Gets all items that are in the queue but not blocked
716 717
     *
     * @since 1.402
718
     */
719 720 721 722 723 724
    public synchronized List<Item> getUnblockedItems() {
    	List<Item> queuedNotBlocked = new ArrayList<Item>();
        queuedNotBlocked.addAll(waitingList);
        queuedNotBlocked.addAll(buildables);
        queuedNotBlocked.addAll(pendings);
        // but not 'blockedProjects'
725 726 727
        return queuedNotBlocked;
    }

728 729 730 731 732 733 734 735 736 737 738 739 740
    /**
     * 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;
    }

741 742 743 744 745 746 747 748 749 750
    /**
     * 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 已提交
751 752 753 754 755 756
    /**
     * 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())
757
            if(bi.getAssignedLabel()==l)
K
kohsuke 已提交
758
                r++;
759
        for (BuildableItem bi : pendings.values())
760
            if(bi.getAssignedLabel()==l)
761
                r++;
K
kohsuke 已提交
762 763 764
        return r;
    }

765 766 767 768 769 770 771
    /**
     * Counts all the {@link BuildableItem}s currently in the queue.
     */
    public synchronized int countBuildableItems() {
        return buildables.size()+pendings.size();
    }

K
kohsuke 已提交
772 773 774 775 776
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
777 778
    public synchronized Item getItem(Task t) {
        BlockedItem bp = blockedProjects.get(t);
779
        if (bp!=null)
780 781
            return bp;
        BuildableItem bi = buildables.get(t);
782 783 784
        if(bi!=null)
            return bi;
        bi = pendings.get(t);
785
        if(bi!=null)
786 787
            return bi;

788
        for (Item item : waitingList) {
789
            if (item.task == t)
K
kohsuke 已提交
790 791 792 793 794
                return item;
        }
        return null;
    }

795 796 797 798 799 800 801 802 803
    /**
     * 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));
804
        result.addAll(pendings.getAll(t));
805 806 807 808 809 810 811
        for (Item item : waitingList) {
            if (item.task == t)
                result.add(item);
        }
        return result;
    }

812 813
    /**
     * Left for backward compatibility.
814
     *
815 816
     * @see #getItem(Task)
    public synchronized Item getItem(AbstractProject p) {
817
        return getItem((Task) p);
818
    }
K
kohsuke 已提交
819
     */
820

K
kohsuke 已提交
821
    /**
K
kohsuke 已提交
822
     * Returns true if this queue contains the said project.
K
kohsuke 已提交
823
     */
824
    public synchronized boolean contains(Task t) {
825
        if (blockedProjects.containsKey(t) || buildables.containsKey(t) || pendings.containsKey(t))
K
kohsuke 已提交
826
            return true;
827
        for (Item item : waitingList) {
828
            if (item.task == t)
K
kohsuke 已提交
829 830 831 832 833 834 835
                return true;
        }
        return false;
    }

    /**
     * Called by the executor to fetch something to build next.
836
     * <p>
K
kohsuke 已提交
837 838
     * This method blocks until a next project becomes buildable.
     */
839
    public synchronized WorkUnit pop() throws InterruptedException {
K
kohsuke 已提交
840
        final Executor exec = Executor.currentExecutor();
841

842 843 844 845 846 847 848
        if (exec instanceof OneOffExecutor) {
            OneOffExecutor ooe = (OneOffExecutor) exec;
            final WorkUnit wu = ooe.getAssignedWorkUnit();
            pendings.remove(wu.context.item);
            return wu;
        }

K
kohsuke 已提交
849
        try {
850
            while (true) {
K
kohsuke 已提交
851 852 853
                final JobOffer offer = new JobOffer(exec);
                long sleep = -1;

854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
                // 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();

                // 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 已提交
872 873
                }

874
                if (sleep == -1)
K
kohsuke 已提交
875 876 877 878
                    offer.event.block();
                else
                    offer.event.block(sleep);

879 880 881 882 883
                // retract the offer object
                assert parked.get(exec) == offer;
                parked.remove(exec);

                // am I woken up because I have a project to build?
884
                if (offer.workUnit != null) {
885
                    // if so, just build it
886 887 888 889 890
                    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);
891

892
                    return offer.workUnit;
K
kohsuke 已提交
893
                }
894
                // otherwise run a queue maintenance
K
kohsuke 已提交
895 896
            }
        } finally {
897 898
            // remove myself from the parked list
            JobOffer offer = parked.remove(exec);
899 900
            if (offer != null && offer.workUnit != null) {
                // we are already assigned a project, but now we can't handle it.
901
                offer.workUnit.context.abort(new AbortException());
K
kohsuke 已提交
902
            }
903 904 905 906 907 908

            // 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 已提交
909 910 911 912 913
        }
    }

    /**
     * Checks the queue and runs anything that can be run.
914 915
     *
     * <p>
K
kohsuke 已提交
916
     * When conditions are changed, this method should be invoked.
917
     * <p>
K
kohsuke 已提交
918 919 920 921 922 923 924
     * 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()) {
925
            if (av.getValue().workUnit == null) {
K
kohsuke 已提交
926 927 928 929 930 931
                av.getValue().event.signal();
                return;
            }
        }
    }

932
    /**
933 934
     * Checks if the given item should be prevented from entering into the {@link #buildables} state
     * and instead stay in the {@link #blockedProjects} state.
935
     */
936
    private boolean isBuildBlocked(Item i) {
937
        if (i.task.isBuildBlocked() || !canRun(i.task.getResourceList()))
938 939 940 941 942 943 944 945
            return true;

        for (QueueTaskDispatcher d : QueueTaskDispatcher.all()) {
            if (d.canRun(i)!=null)
                return true;
        }

        return false;
946 947
    }

948
    /**
949 950
     * Make sure we don't queue two tasks of the same project to be built
     * unless that project allows concurrent builds.
951
     */
952 953 954 955 956 957 958
    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
        }
959
        return !buildables.containsKey(t) && !pendings.containsKey(t);
960
    }
961

K
kohsuke 已提交
962
    /**
K
kohsuke 已提交
963
     * Queue maintenance.
964
     *
965
     * <p>
966
     * Move projects between {@link #waitingList}, {@link #blockedProjects}, {@link #buildables}, and {@link #pendings}
K
kohsuke 已提交
967
     * appropriately.
968 969 970 971 972
     *
     * <p>
     * Jenkins internally invokes this method by itself whenever there's a change that can affect
     * the scheduling (such as new node becoming online, # of executors change, a task completes execution, etc.),
     * and it also gets invoked periodically (see {@link MaintainTask}.)
K
kohsuke 已提交
973
     */
974
    public synchronized void maintain() {
975 976
        if (LOGGER.isLoggable(Level.FINE))
            LOGGER.fine("Queue maintenance started " + this);
977

978 979 980 981 982 983 984 985 986 987
        {// blocked -> buildable
            Iterator<BlockedItem> itr = blockedProjects.values().iterator();
            while (itr.hasNext()) {
                BlockedItem p = itr.next();
                if (!isBuildBlocked(p) && allowNewBuildableTask(p.task)) {
                    // ready to be executed
                    LOGGER.fine(p.task.getFullDisplayName() + " no longer blocked");
                    itr.remove();
                    makeBuildable(new BuildableItem(p));
                }
K
kohsuke 已提交
988 989 990
            }
        }

991
        // waitingList -> buildable/blocked
992
        while (!waitingList.isEmpty()) {
993
            WaitingItem top = peek();
K
kohsuke 已提交
994

995
            if (!top.timestamp.before(new GregorianCalendar()))
996
                break; // finished moving all ready items from queue
K
kohsuke 已提交
997

998
            waitingList.remove(top);
999
            Task p = top.task;
1000
            if (!isBuildBlocked(top) && allowNewBuildableTask(p)) {
1001
                // ready to be executed immediately
K
kohsuke 已提交
1002
                LOGGER.fine(p.getFullDisplayName() + " ready to build");
1003
                makeBuildable(new BuildableItem(top));
K
kohsuke 已提交
1004
            } else {
1005
                // this can't be built now because another build is in progress
K
kohsuke 已提交
1006
                // set this project aside.
K
kohsuke 已提交
1007
                LOGGER.fine(p.getFullDisplayName() + " is blocked");
1008
                blockedProjects.put(p,new BlockedItem(top));
K
kohsuke 已提交
1009 1010
            }
        }
1011 1012 1013 1014

        final QueueSorter s = sorter;
        if (s != null)
        	s.sortBuildableItems(buildables);
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048

        // 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)) {
                itr.remove();
                blockedProjects.put(p.task,new BlockedItem(p));
                continue;
            }

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

            MappingWorksheet ws = new MappingWorksheet(p, candidates);
            Mapping m = loadBalancer.map(p.task, ws);
            if (m == 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;

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

            itr.remove();
            if (!wuc.getWorkUnits().isEmpty())
                pendings.add(p);
        }
K
kohsuke 已提交
1049 1050
    }

1051
    private void makeBuildable(BuildableItem p) {
1052
        if(Jenkins.FLYWEIGHT_SUPPORT && p.task instanceof FlyweightTask && !ifBlockedByHudsonShutdown(p.task)) {
1053 1054 1055 1056 1057
            ConsistentHash<Node> hash = new ConsistentHash<Node>(new Hash<Node>() {
                public String hash(Node node) {
                    return node.getNodeName();
                }
            });
1058
            Jenkins h = Jenkins.getInstance();
1059 1060 1061
            hash.add(h, h.getNumExecutors()*100);
            for (Node n : h.getNodes())
                hash.add(n,n.getNumExecutors()*100);
1062

1063
            Label lbl = p.getAssignedLabel();
1064 1065
            for (Node n : hash.list(p.task.getFullDisplayName())) {
                Computer c = n.toComputer();
K
kohsuke 已提交
1066
                if (c==null || c.isOffline())    continue;
1067
                if (lbl!=null && !lbl.contains(n))  continue;
1068
                if (n.canTake(p) != null) continue;
1069
                c.startFlyWeightTask(new WorkUnitContext(p).createWorkUnit(p.task));
1070
                pendings.add(p);
1071
                return;
1072 1073 1074 1075 1076 1077 1078 1079
            }
            // 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);
    }

1080
    public static boolean ifBlockedByHudsonShutdown(Task task) {
1081
        return Jenkins.getInstance().isQuietingDown() && !(task instanceof NonBlockingTask);
1082 1083
    }

1084 1085 1086 1087
    public Api getApi() {
        return new Api(this);
    }

K
kohsuke 已提交
1088 1089 1090 1091 1092 1093
    /**
     * Marks {@link Task}s that are not persisted.
     * @since 1.311
     */
    public interface TransientTask extends Task {}

1094 1095 1096 1097 1098 1099 1100
    /**
     * Marks {@link Task}s that do not consume {@link Executor}.
     * @see OneOffExecutor
     * @since 1.318
     */
    public interface FlyweightTask extends Task {}

K
kohsuke 已提交
1101
    /**
1102
     * Marks {@link Task}s that are not affected by the {@linkplain Jenkins#isQuietingDown()}  quieting down},
K
kohsuke 已提交
1103 1104 1105 1106 1107 1108
     * because these tasks keep other tasks executing.
     *
     * @since 1.336 
     */
    public interface NonBlockingTask extends Task {}

K
kohsuke 已提交
1109 1110
    /**
     * Task whose execution is controlled by the queue.
1111
     *
1112
     * <p>
K
kohsuke 已提交
1113 1114 1115
     * {@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.
1116 1117 1118
     *
     * <p>
     * Pending {@link Task}s are persisted when Hudson shuts down, so
K
kohsuke 已提交
1119 1120
     * it needs to be persistable via XStream. To create a non-persisted
     * transient Task, extend {@link TransientTask} marker interface.
1121 1122 1123 1124 1125
     *
     * <p>
     * Plugins are encouraged to extend from {@link AbstractQueueTask}
     * instead of implementing this interface directly, to maintain
     * compatibility with future changes to this interface.
1126 1127 1128 1129 1130 1131
     *
     * <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 已提交
1132
     */
1133
    public interface Task extends ModelObject, SubTask {
1134 1135 1136
        /**
         * Returns true if the execution should be blocked
         * for temporary reasons.
1137 1138
         *
         * <p>
1139
         * Short-hand for {@code getCauseOfBlockage()!=null}.
1140 1141 1142 1143
         */
        boolean isBuildBlocked();

        /**
1144 1145
         * @deprecated as of 1.330
         *      Use {@link CauseOfBlockage#getShortDescription()} instead.
1146 1147 1148
         */
        String getWhyBlocked();

1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
        /**
         * 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();

1162
        /**
K
kohsuke 已提交
1163
         * Unique name of this task.
K
kohsuke 已提交
1164
         *
K
kohsuke 已提交
1165 1166
         * <p>
         * This method is no longer used, left here for compatibility. Just return {@link #getDisplayName()}.
1167 1168 1169
         */
        String getName();

1170 1171 1172 1173 1174
        /**
         * @see hudson.model.Item#getFullDisplayName()
         */
        String getFullDisplayName();

1175 1176 1177 1178 1179 1180 1181
        /**
         * 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 已提交
1182 1183 1184 1185 1186 1187

        /**
         * Works just like {@link #checkAbortPermission()} except it indicates the status by a return value,
         * instead of exception.
         */
        boolean hasAbortPermission();
1188 1189
        
        /**
K
kohsuke 已提交
1190 1191 1192 1193 1194 1195 1196 1197
         * 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 '/'.
1198 1199
         */
        String getUrl();
1200 1201
        
        /**
K
Kohsuke Kawaguchi 已提交
1202 1203
         * True if the task allows concurrent builds, where the same {@link Task} is executed
         * by multiple executors concurrently on the same or different nodes.
1204 1205
         *
         * @since 1.338
1206 1207
         */
        boolean isConcurrentBuild();
1208

1209
        /**
1210
         * Obtains the {@link SubTask}s that constitute this task.
1211
         *
1212
         * <p>
1213 1214 1215
         * 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.
1216
         *
1217
         * <p>
1218
         * At least size 1.
1219
         *
1220 1221 1222 1223
         * <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 已提交
1224
         * @since 1.377
1225
         */
1226
        Collection<? extends SubTask> getSubTasks();
1227 1228
    }

1229
    /**
M
mindless 已提交
1230
     * Represents the real meat of the computation run by {@link Executor}.
1231 1232 1233 1234 1235
     *
     * <h2>Views</h2>
     * <p>
     * Implementation must have <tt>executorCell.jelly</tt>, which is
     * used to render the HTML that indicates this executable is executing.
1236
     */
1237 1238 1239
    public interface Executable extends Runnable {
        /**
         * Task from which this executable was created.
K
kohsuke 已提交
1240
         * Never null.
1241 1242
         *
         * <p>
M
mindless 已提交
1243
         * Since this method went through a signature change in 1.377, the invocation may results in
1244 1245
         * {@link AbstractMethodError}.
         * Use {@link Executables#getParentOf(Executable)} that avoids this.
1246
         */
1247
        SubTask getParent();
1248 1249 1250 1251 1252

        /**
         * Called by {@link Executor} to perform the task
         */
        void run();
1253 1254 1255 1256
        
        /**
         * Estimate of how long will it take to execute this executable.
         * Measured in milliseconds.
1257
         * 
1258
         * Please, consider using {@link Executables#getEstimatedDurationFor(Executable)}
1259
         * to protected against AbstractMethodErrors!
1260 1261 1262 1263 1264
         *
         * @return -1 if it's impossible to estimate.
         * @since 1.383
         */
        long getEstimatedDuration();
1265 1266 1267 1268

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

K
kohsuke 已提交
1272 1273 1274
    /**
     * Item in a queue.
     */
1275
    @ExportedBean(defaultVisibility = 999)
1276
    public static abstract class Item extends Actionable {
1277 1278 1279 1280
        /**
         * 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}.
         */
1281
        @Exported
1282 1283 1284
    	public final int id;
    	
		/**
K
kohsuke 已提交
1285 1286
         * Project to be built.
         */
1287
        @Exported
1288
        public final Task task;
1289

1290
        private /*almost final*/ transient FutureImpl future;
1291 1292
        
        private final long inQueueSince;
1293

1294
        /**
1295 1296 1297
         * Build is blocked because another build is in progress,
         * required {@link Resource}s are not available, or otherwise blocked
         * by {@link Task#isBuildBlocked()}.
1298
         */
K
kohsuke 已提交
1299
        @Exported
1300
        public boolean isBlocked() { return this instanceof BlockedItem; }
1301 1302 1303 1304 1305 1306

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

1310 1311 1312 1313 1314
        /**
         * True if the item is starving for an executor for too long.
         */
        @Exported
        public boolean isStuck() { return false; }
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
        
        /**
         * Since when is this item in the queue.
         * @return Unix timestamp
         */
        @Exported
        public long getInQueueSince() {
            return this.inQueueSince;
        }
        
C
Christoph Kutzinski 已提交
1325 1326 1327 1328 1329
        /**
         * Returns a human readable presentation of how long this item is already in the queue.
         * E.g. something like '3 minutes 40 seconds'
         */
        public String getInQueueForString() {
1330 1331 1332
            long duration = System.currentTimeMillis() - this.inQueueSince;
            return Util.getTimeSpanString(duration);
        }
1333

1334 1335 1336 1337 1338 1339 1340
        /**
         * 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; }

1341 1342 1343 1344 1345 1346 1347 1348
        /**
         * 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.
         * 
         * <p>
         * This code takes {@link LabelAssignmentAction} into account, then fall back to {@link SubTask#getAssignedLabel()}
         */
1349 1350 1351 1352 1353 1354 1355 1356
        public Label getAssignedLabel() {
            for (LabelAssignmentAction laa : getActions(LabelAssignmentAction.class)) {
                Label l = laa.getAssignedLabel(task);
                if (l!=null)    return l;
            }
            return task.getAssignedLabel();
        }

1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
        /**
         * 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();
        }

1370
        protected Item(Task task, List<Action> actions, int id, FutureImpl future) {
1371 1372
            this.task = task;
            this.id = id;
1373
            this.future = future;
1374 1375 1376 1377 1378 1379 1380 1381 1382
            this.inQueueSince = System.currentTimeMillis();
            for (Action action: actions) addAction(action);
        }
        
        protected Item(Task task, List<Action> actions, int id, FutureImpl future, long inQueueSince) {
            this.task = task;
            this.id = id;
            this.future = future;
            this.inQueueSince = inQueueSince;
1383 1384 1385 1386
            for (Action action: actions) addAction(action);
        }
        
        protected Item(Item item) {
1387
        	this(item.task, item.getActions(), item.id, item.future, item.inQueueSince);
K
kohsuke 已提交
1388 1389
        }

1390
        /**
1391
         * Gets a human-readable status message describing why it's in the queue.
1392
         */
K
kohsuke 已提交
1393
        @Exported
1394 1395 1396 1397 1398
        public final String getWhy() {
            CauseOfBlockage cob = getCauseOfBlockage();
            return cob!=null ? cob.getShortDescription() : null;
        }

K
kohsuke 已提交
1399 1400 1401
        /**
         * Gets an object that describes why this item is in the queue.
         */
1402 1403
        public abstract CauseOfBlockage getCauseOfBlockage();

1404 1405 1406 1407 1408 1409
        /**
         * Gets a human-readable message about the parameters of this item
         * @return String
         */
        @Exported
        public String getParams() {
K
kohsuke 已提交
1410
        	StringBuilder s = new StringBuilder();
1411 1412 1413 1414
        	for(Action action : getActions()) {
        		if(action instanceof ParametersAction) {
        			ParametersAction pa = (ParametersAction)action;
        			for (ParameterValue p : pa.getParameters()) {
K
kohsuke 已提交
1415
        				s.append('\n').append(p.getShortDescription());
1416 1417 1418
        			}
        		}
        	}
K
kohsuke 已提交
1419
        	return s.toString();
1420 1421
        }
        
1422 1423 1424
        public boolean hasCancelPermission() {
            return task.hasAbortPermission();
        }
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
        
        public String getDisplayName() {
			// TODO Auto-generated method stub
			return null;
		}

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

1436 1437
        /** @deprecated Use {@link #doCancelItem} instead. */
        @Deprecated
1438
        public HttpResponse doCancelQueue() throws IOException, ServletException {
1439
        	Jenkins.getInstance().getQueue().cancel(this);
1440
            return HttpResponses.forwardToPreviousPage();
1441
        }
1442 1443 1444 1445 1446 1447 1448 1449 1450

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

        private Object readResolve() {
1451
            this.future = new FutureImpl(task);
1452 1453
            return this;
        }
K
kohsuke 已提交
1454 1455 1456 1457 1458

        @Override
        public String toString() {
            return getClass().getName()+':'+task.toString();
        }
1459 1460 1461 1462 1463
    }
    
    /**
     * An optional interface for actions on Queue.Item.
     * Lets the action cooperate in queue management.
1464 1465
     * 
     * @since 1.300-ish.
1466 1467 1468 1469 1470 1471
     */
    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.
    	 */
1472
	    boolean shouldSchedule(List<Action> actions);
1473
    }
1474

1475
    /**
K
kohsuke 已提交
1476 1477 1478 1479 1480 1481
     * 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. 
1482 1483
     *
     * <p>
1484 1485
     * The other use case is to add additional {@link Action}s to the task
     * (for example {@link LabelAssignmentAction}) to tasks that are submitted to the queue.
1486 1487 1488 1489 1490
     *
     * @since 1.316
     */
    public static abstract class QueueDecisionHandler implements ExtensionPoint {
    	/**
K
kohsuke 已提交
1491
    	 * Returns whether the new item should be scheduled.
1492 1493 1494 1495
         *
         * @param actions
         *      List of actions that are to be made available as {@link AbstractBuild#getActions()}
         *      upon the start of the build. This list is live, and can be mutated.
1496 1497 1498 1499 1500 1501 1502 1503
    	 */
    	public abstract boolean shouldSchedule(Task p, List<Action> actions);
    	    	
    	/**
    	 * All registered {@link QueueDecisionHandler}s
    	 * @return
    	 */
    	public static ExtensionList<QueueDecisionHandler> all() {
1504
    		return Jenkins.getInstance().getExtensionList(QueueDecisionHandler.class);
1505 1506 1507
    	}
    }
    
1508 1509 1510
    /**
     * {@link Item} in the {@link Queue#waitingList} stage.
     */
1511 1512 1513
    public static final class WaitingItem extends Item implements Comparable<WaitingItem> {
    	private static final AtomicInteger COUNTER = new AtomicInteger(0);
    	
1514 1515 1516 1517 1518
        /**
         * This item can be run after this time.
         */
        @Exported
        public Calendar timestamp;
1519

1520
        public WaitingItem(Calendar timestamp, Task project, List<Action> actions) {
1521
            super(project, actions, COUNTER.incrementAndGet(), new FutureImpl(project));
1522 1523
            this.timestamp = timestamp;
        }
1524
        
1525 1526 1527 1528 1529 1530 1531
        public int compareTo(WaitingItem that) {
            int r = this.timestamp.getTime().compareTo(that.timestamp.getTime());
            if (r != 0) return r;

            return this.id - that.id;
        }

1532
        public CauseOfBlockage getCauseOfBlockage() {
1533
            long diff = timestamp.getTimeInMillis() - System.currentTimeMillis();
1534
            if (diff > 0)
1535
                return CauseOfBlockage.fromMessage(Messages._Queue_InQuietPeriod(Util.getTimeSpanString(diff)));
1536
            else
1537
                return CauseOfBlockage.fromMessage(Messages._Queue_Unknown());
1538 1539
        }
    }
K
kohsuke 已提交
1540

1541 1542 1543
    /**
     * Common part between {@link BlockedItem} and {@link BuildableItem}.
     */
1544
    public static abstract class NotWaitingItem extends Item {
1545 1546 1547 1548 1549 1550 1551
        /**
         * When did this job exit the {@link Queue#waitingList} phase?
         */
        @Exported
        public final long buildableStartMilliseconds;

        protected NotWaitingItem(WaitingItem wi) {
1552
            super(wi);
1553
            buildableStartMilliseconds = System.currentTimeMillis();
K
kohsuke 已提交
1554
        }
1555

1556
        protected NotWaitingItem(NotWaitingItem ni) {
1557
            super(ni);
1558
            buildableStartMilliseconds = ni.buildableStartMilliseconds;
1559
        }
1560
    }
1561

1562 1563 1564 1565 1566 1567 1568
    /**
     * {@link Item} in the {@link Queue#blockedProjects} stage.
     */
    public final class BlockedItem extends NotWaitingItem {
        public BlockedItem(WaitingItem wi) {
            super(wi);
        }
1569

1570 1571 1572 1573
        public BlockedItem(NotWaitingItem ni) {
            super(ni);
        }

1574
        public CauseOfBlockage getCauseOfBlockage() {
1575 1576 1577
            ResourceActivity r = getBlockingActivity(task);
            if (r != null) {
                if (r == task) // blocked by itself, meaning another build is in progress
1578 1579
                    return CauseOfBlockage.fromMessage(Messages._Queue_InProgress());
                return CauseOfBlockage.fromMessage(Messages._Queue_BlockedBy(r.getDisplayName()));
1580
            }
1581 1582 1583 1584 1585 1586 1587
            
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all()) {
                CauseOfBlockage cause = d.canRun(this);
                if (cause != null)
                    return cause;
            }
            
1588
            return task.getCauseOfBlockage();
1589
        }
1590
    }
1591

1592 1593 1594
    /**
     * {@link Item} in the {@link Queue#buildables} stage.
     */
1595
    public final static class BuildableItem extends NotWaitingItem {
1596 1597 1598 1599 1600 1601 1602 1603
        public BuildableItem(WaitingItem wi) {
            super(wi);
        }

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

1604
        public CauseOfBlockage getCauseOfBlockage() {
1605
            Jenkins jenkins = Jenkins.getInstance();
1606
            if(ifBlockedByHudsonShutdown(task))
1607
                return CauseOfBlockage.fromMessage(Messages._Queue_HudsonIsAboutToShutDown());
K
kohsuke 已提交
1608

1609
            Label label = getAssignedLabel();
1610 1611
            List<Node> allNodes = jenkins.getNodes();
            if (allNodes.isEmpty())
1612
                label = null;    // no master/slave. pointless to talk about nodes
1613

1614
            if (label != null) {
K
Kohsuke Kawaguchi 已提交
1615
                Set<Node> nodes = label.getNodes();
1616
                if (label.isOffline()) {
1617
                    if (nodes.size() != 1)      return new BecauseLabelIsOffline(label);
1618
                    else                        return new BecauseNodeIsOffline(nodes.iterator().next());
K
Kohsuke Kawaguchi 已提交
1619 1620 1621
                } else {
                    if (nodes.size() != 1)      return new BecauseLabelIsBusy(label);
                    else                        return new BecauseNodeIsBusy(nodes.iterator().next());
1622
                }
K
Kohsuke Kawaguchi 已提交
1623
            } else {
1624 1625 1626 1627 1628 1629 1630 1631
                CauseOfBlockage c = null;
                for (Node node : allNodes) {
                    if (node.toComputer().isPartiallyIdle()) {
                        c = canTake(node);
                        if (c==null)    break;
                    }
                }

K
Kohsuke Kawaguchi 已提交
1632
                return CauseOfBlockage.createNeedsMoreExecutor(Messages._Queue_WaitingForNextAvailableExecutor());
1633 1634
            }
        }
1635

1636 1637 1638 1639 1640 1641 1642 1643
        private CauseOfBlockage canTake(Node node) {
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all()) {
                CauseOfBlockage cause = d.canTake(node, this);
                if (cause!=null)    return cause;
            }
            return null;
        }

1644 1645
        @Override
        public boolean isStuck() {
1646
            Label label = getAssignedLabel();
1647 1648 1649 1650 1651 1652 1653
            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) {
1654
                // if we were running elsewhere, we would have done this build ten times.
1655
                return elapsed > Math.max(d,60000L)*10;
1656 1657
            } else {
                // more than a day in the queue
1658
                return TimeUnit2.MILLISECONDS.toHours(elapsed)>24;
1659 1660
            }
        }
K
kohsuke 已提交
1661 1662 1663
    }

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

1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
    /**
     * 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) {
1681
                Object item = Jenkins.getInstance().getItemByFullName(string);
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
                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]);
1704
				Job<?,?> job = (Job<?,?>) Jenkins.getInstance().getItemByFullName(projectName);
1705 1706
                if(job==null)  throw new NoSuchElementException("No such job exists: "+projectName);
				Run<?,?> run = job.getBuildByNumber(buildNumber);
K
kohsuke 已提交
1707
                if(run==null)  throw new NoSuchElementException("No such build: "+string);
1708 1709 1710 1711 1712 1713 1714 1715 1716
				return run;
			}

			@Override
			public String toString(Object object) {
				Run<?,?> run = (Run<?,?>) object;
				return run.getParent().getFullName() + "#" + run.getNumber();
			}
        });
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736

        /**
         * Reconnect every reference to {@link Queue} by the singleton.
         */
        XSTREAM.registerConverter(new AbstractSingleValueConverter() {
			@Override
			public boolean canConvert(Class klazz) {
				return Queue.class.isAssignableFrom(klazz);
			}

			@Override
			public Object fromString(String string) {
                return Jenkins.getInstance().getQueue();
			}

			@Override
			public String toString(Object item) {
                return "queue";
			}
        });
1737 1738
    }

1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
    /**
     * 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);

J
Jesse Glick 已提交
1749 1750 1751 1752 1753
            long interval = 5000;
            Timer timer = Trigger.timer;
            if (timer != null) {
                timer.schedule(this, interval, interval);
            }
1754 1755 1756 1757
        }

        protected void doRun() {
            Queue q = queue.get();
1758
            if (q != null)
1759 1760 1761 1762 1763
                q.maintain();
            else
                cancel();
        }
    }
1764 1765
    
    /**
1766
     * {@link ArrayList} of {@link Item} with more convenience methods.
1767
     */
1768
    private static class ItemList<T extends Item> extends ArrayList<T> {
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
    	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;
    	}
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835

        /**
         * 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();
        }
1836
    }
1837 1838 1839

    @CLIResolver
    public static Queue getInstance() {
1840
        return Jenkins.getInstance().getQueue();
1841
    }
K
kohsuke 已提交
1842 1843 1844 1845 1846

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