Queue.java 87.4 KB
Newer Older
K
kohsuke 已提交
1 2
/*
 * The MIT License
3
 *
M
mindless 已提交
4 5
 * Copyright (c) 2004-2010, Sun Microsystems, Inc., Kohsuke Kawaguchi,
 * Stephen Connolly, Tom Huybrechts, InfraDNA, Inc.
6
 *
K
kohsuke 已提交
7 8 9 10 11 12
 * 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:
13
 *
K
kohsuke 已提交
14 15
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
16
 *
K
kohsuke 已提交
17 18 19 20 21 22 23 24
 * 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 28
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
29
import com.google.common.collect.ImmutableList;
K
Kohsuke Kawaguchi 已提交
30
import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
31
import hudson.BulkChange;
32
import hudson.CopyOnWrite;
33 34
import hudson.ExtensionList;
import hudson.ExtensionPoint;
35
import hudson.Util;
K
kohsuke 已提交
36
import hudson.XmlFile;
K
kohsuke 已提交
37 38
import hudson.init.Initializer;
import static hudson.init.InitMilestone.JOB_LOADED;
39 40
import static hudson.util.Iterators.reverse;

41 42
import hudson.cli.declarative.CLIMethod;
import hudson.cli.declarative.CLIResolver;
43
import hudson.model.labels.LabelAssignmentAction;
44
import hudson.model.queue.AbstractQueueTask;
45
import hudson.model.queue.Executables;
46
import hudson.model.queue.QueueListener;
K
Kohsuke Kawaguchi 已提交
47
import hudson.model.queue.QueueTaskFuture;
K
Kohsuke Kawaguchi 已提交
48 49
import hudson.model.queue.ScheduleResult;
import hudson.model.queue.ScheduleResult.Created;
50
import hudson.model.queue.SubTask;
51
import hudson.model.queue.FutureImpl;
52 53
import hudson.model.queue.MappingWorksheet;
import hudson.model.queue.MappingWorksheet.Mapping;
54
import hudson.model.queue.QueueSorter;
55
import hudson.model.queue.QueueTaskDispatcher;
56
import hudson.model.queue.Tasks;
57
import hudson.model.queue.WorkUnit;
K
kohsuke 已提交
58
import hudson.model.Node.Mode;
59
import hudson.model.listeners.SaveableListener;
60
import hudson.model.queue.CauseOfBlockage;
K
kohsuke 已提交
61
import hudson.model.queue.FoldableAction;
62 63 64 65
import hudson.model.queue.CauseOfBlockage.BecauseLabelIsBusy;
import hudson.model.queue.CauseOfBlockage.BecauseNodeIsOffline;
import hudson.model.queue.CauseOfBlockage.BecauseLabelIsOffline;
import hudson.model.queue.CauseOfBlockage.BecauseNodeIsBusy;
66
import hudson.model.queue.WorkUnitContext;
67
import hudson.security.ACL;
68
import jenkins.security.QueueItemAuthenticatorProvider;
69
import jenkins.util.Timer;
70
import hudson.triggers.SafeTimerTask;
71
import hudson.util.TimeUnit2;
72
import hudson.util.XStream2;
73 74
import hudson.util.ConsistentHash;
import hudson.util.ConsistentHash.Hash;
K
kohsuke 已提交
75

76 77 78 79 80
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
81
import java.lang.ref.WeakReference;
K
kohsuke 已提交
82
import java.util.ArrayList;
83
import java.util.Arrays;
K
kohsuke 已提交
84
import java.util.Calendar;
85
import java.util.Collection;
86
import java.util.Collections;
K
kohsuke 已提交
87 88
import java.util.GregorianCalendar;
import java.util.HashMap;
89
import java.util.HashSet;
K
kohsuke 已提交
90
import java.util.Iterator;
91
import java.util.LinkedHashSet;
K
kohsuke 已提交
92 93
import java.util.List;
import java.util.Map;
94
import java.util.NoSuchElementException;
K
kohsuke 已提交
95 96
import java.util.Set;
import java.util.TreeSet;
97
import java.util.concurrent.Callable;
98
import java.util.concurrent.TimeUnit;
99
import java.util.concurrent.atomic.AtomicInteger;
100
import java.util.concurrent.Future;
101
import java.util.concurrent.atomic.AtomicLong;
102 103 104
import java.util.concurrent.locks.Condition;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
K
kohsuke 已提交
105 106 107
import java.util.logging.Level;
import java.util.logging.Logger;

108
import javax.annotation.Nonnull;
109
import javax.servlet.ServletException;
K
kohsuke 已提交
110

111
import jenkins.model.Jenkins;
112
import jenkins.security.QueueItemAuthenticator;
113
import jenkins.util.AtmostOneTaskExecutor;
K
kohsuke 已提交
114
import org.acegisecurity.AccessDeniedException;
115
import org.acegisecurity.Authentication;
116
import org.jenkinsci.bytecode.AdaptField;
117 118
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.HttpResponses;
K
kohsuke 已提交
119 120 121
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;

122 123 124
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.DoNotUse;

K
kohsuke 已提交
125 126
import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.converters.basic.AbstractSingleValueConverter;
127
import javax.annotation.CheckForNull;
128
import org.kohsuke.stapler.QueryParameter;
J
Jesse Glick 已提交
129
import org.kohsuke.stapler.interceptor.RequirePOST;
K
kohsuke 已提交
130

K
kohsuke 已提交
131 132
/**
 * Build queue.
133 134
 *
 * <p>
135 136
 * 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}
137
 * so that we can keep track of additional data used for deciding what to execute when.
138 139
 *
 * <p>
140 141 142 143 144 145
 * Items in queue goes through several stages, as depicted below:
 * <pre>
 * (enter) --> waitingList --+--> blockedProjects
 *                           |        ^
 *                           |        |
 *                           |        v
146
 *                           +--> buildables ---> pending ---> left
147 148 149
 *                                    ^              |
 *                                    |              |
 *                                    +---(rarely)---+
150
 * </pre>
151 152
 *
 * <p>
153 154 155 156 157 158 159 160
 * Note: In the normal case of events pending items only move to left. However they can move back
 * if the node they are assigned to execute on disappears before their {@link Executor} thread
 * starts, where the node is removed before the {@link Executable} has been instantiated it
 * is safe to move the pending item back to buildable. Once the {@link Executable} has been
 * instantiated the only option is to let the {@link Executable} bomb out as soon as it starts
 * to try an execute on the node that no longer exists.
 *
 * <p>
161 162 163
 * 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 已提交
164
 * @author Kohsuke Kawaguchi
165 166
 * @see QueueListener
 * @see QueueTaskDispatcher
K
kohsuke 已提交
167
 */
168
@ExportedBean
169
public class Queue extends ResourceController implements Saveable {
170 171 172 173

    /**
     * Defines the refresh period for of the internal cache ({@link #itemsView}).
     * Data should be defined in milliseconds, default value - 1000;
O
Oliver Gondža 已提交
174
     * @since 1.577
175 176
     */
    private static int CACHE_REFRESH_PERIOD = Integer.getInteger(Queue.class.getName() + ".cacheRefreshPeriod", 1000);
177

K
kohsuke 已提交
178
    /**
179
     * Items that are waiting for its quiet period to pass.
180 181
     *
     * <p>
K
kohsuke 已提交
182 183 184
     * This consists of {@link Item}s that cannot be run yet
     * because its time has not yet come.
     */
185
    private final Set<WaitingItem> waitingList = new TreeSet<WaitingItem>();
K
kohsuke 已提交
186 187

    /**
188
     * {@link Task}s that can be built immediately
189
     * but blocked because another build is in progress,
190 191 192
     * required {@link Resource}s are not available,
     * blocked via {@link QueueTaskDispatcher#canRun(Item)},
     * or otherwise blocked by {@link Task#isBuildBlocked()}.
K
kohsuke 已提交
193
     */
194
    private final ItemList<BlockedItem> blockedProjects = new ItemList<BlockedItem>();
K
kohsuke 已提交
195 196

    /**
197
     * {@link Task}s that can be built immediately
K
kohsuke 已提交
198
     * that are waiting for available {@link Executor}.
199
     * This list is sorted in such a way that earlier items are built earlier.
K
kohsuke 已提交
200
     */
201
    private final ItemList<BuildableItem> buildables = new ItemList<BuildableItem>();
202

203
    /**
204 205
     * {@link Task}s that are being handed over to the executor, but execution
     * has not started yet.
206 207 208
     */
    private final ItemList<BuildableItem> pendings = new ItemList<BuildableItem>();

209 210
    private transient volatile Snapshot snapshot = new Snapshot(waitingList, blockedProjects, buildables, pendings);

211
    /**
212
     * Items that left queue would stay here for a while to enable tracking via {@link Item#getId()}.
213 214 215
     *
     * This map is forgetful, since we can't remember everything that executed in the past.
     */
216
    private final Cache<Long,LeftItem> leftItems = CacheBuilder.newBuilder().expireAfterWrite(5*60, TimeUnit.SECONDS).build();
217

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
    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
240
                long next = t+CACHE_REFRESH_PERIOD;
241 242 243 244 245 246 247 248 249 250 251 252
                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 已提交
253 254
    /**
     * Data structure created for each idle {@link Executor}.
255
     * This is a job offer from the queue to an executor.
256 257
     *
     * <p>
K
Kohsuke Kawaguchi 已提交
258 259 260
     * For each idle executor, this gets created to allow the scheduling logic
     * to assign a work. Once a work is assigned, the executor actually gets
     * started to carry out the task in question.
K
kohsuke 已提交
261
     */
K
kohsuke 已提交
262
    public class JobOffer extends MappingWorksheet.ExecutorSlot {
K
kohsuke 已提交
263
        public final Executor executor;
K
kohsuke 已提交
264 265

        /**
266
         * The work unit that this {@link Executor} is going to handle.
K
kohsuke 已提交
267
         */
268
        private WorkUnit workUnit;
K
kohsuke 已提交
269

K
kohsuke 已提交
270
        private JobOffer(Executor executor) {
K
kohsuke 已提交
271 272 273
            this.executor = executor;
        }

K
kohsuke 已提交
274 275
        @Override
        protected void set(WorkUnit p) {
276 277
            assert this.workUnit == null;
            this.workUnit = p;
K
Kohsuke Kawaguchi 已提交
278 279
            assert executor.isParking();
            executor.start(workUnit);
280
            // LOGGER.info("Starting "+executor.getName());
K
kohsuke 已提交
281 282
        }

K
kohsuke 已提交
283 284 285 286 287
        @Override
        public Executor getExecutor() {
            return executor;
        }

288 289 290
        /**
         * Verifies that the {@link Executor} represented by this object is capable of executing the given task.
         */
291
        public boolean canTake(BuildableItem item) {
292 293 294
            Node node = getNode();
            if (node==null)     return false;   // this executor is about to die

295
            if(node.canTake(item)!=null)
296
                return false;   // this node is not able to take the task
297

298
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all())
299
                if (d.canTake(node,item)!=null)
300
                    return false;
301 302 303 304 305 306 307

            return isAvailable();
        }

        /**
         * Is this executor ready to accept some tasks?
         */
K
kohsuke 已提交
308
        public boolean isAvailable() {
309
            return workUnit == null && !executor.getOwner().isOffline() && executor.getOwner().isAcceptingTasks();
K
kohsuke 已提交
310 311
        }

312
        @CheckForNull
K
kohsuke 已提交
313 314 315 316 317
        public Node getNode() {
            return executor.getOwner().getNode();
        }

        public boolean isNotExclusive() {
318
            return getNode().getMode() == Mode.NORMAL;
K
kohsuke 已提交
319
        }
320 321 322 323 324

        @Override
        public String toString() {
            return String.format("JobOffer[%s #%d]",executor.getOwner().getName(), executor.getNumber());
        }
K
kohsuke 已提交
325 326
    }

327
    private volatile transient LoadBalancer loadBalancer;
328

329
    private volatile transient QueueSorter sorter;
330

331 332 333 334 335 336 337 338
    private transient final AtmostOneTaskExecutor<Void> maintainerThread = new AtmostOneTaskExecutor<Void>(new Callable<Void>() {
        @Override
        public Void call() throws Exception {
            maintain();
            return null;
        }
    });

339 340 341 342
    private transient final Lock lock = new ReentrantLock();

    private transient final Condition condition = lock.newCondition();

343
    public Queue(@Nonnull LoadBalancer loadBalancer) {
344
        this.loadBalancer =  loadBalancer.sanitize();
345 346
        // 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.
K
Kohsuke Kawaguchi 已提交
347
        new MaintainTask(this).periodic();
348 349
    }

350 351 352 353
    public LoadBalancer getLoadBalancer() {
        return loadBalancer;
    }

354
    public void setLoadBalancer(@Nonnull LoadBalancer loadBalancer) {
355
        if(loadBalancer==null)  throw new IllegalArgumentException();
356
        this.loadBalancer = loadBalancer.sanitize();
357 358
    }

359 360 361 362 363 364 365 366
    public QueueSorter getSorter() {
        return sorter;
    }

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

367 368 369 370 371 372 373 374
    /**
     * Simple queue state persistence object.
     */
    static class State {
        public long counter;
        public List<Item> items = new ArrayList<Item>();
    }

K
kohsuke 已提交
375 376 377
    /**
     * Loads the queue contents that was {@link #save() saved}.
     */
378 379
    public void load() {
        lock.lock();
380
        try { try {
K
TAB->WS  
kohsuke 已提交
381
            // first try the old format
K
kohsuke 已提交
382
            File queueFile = getQueueFile();
K
kohsuke 已提交
383 384
            if (queueFile.exists()) {
                BufferedReader in = new BufferedReader(new InputStreamReader(new FileInputStream(queueFile)));
385 386 387 388 389 390 391 392 393
                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 已提交
394 395 396 397 398 399
                }
                // discard the queue file now that we are done
                queueFile.delete();
            } else {
                queueFile = getXMLQueueFile();
                if (queueFile.exists()) {
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
                    Object unmarshaledObj = new XmlFile(XSTREAM, queueFile).read();
                    List items;

                    if (unmarshaledObj instanceof State) {
                        State state = (State) unmarshaledObj;
                        items = state.items;
                        WaitingItem.COUNTER.set(state.counter);
                    } else {
                        // backward compatibility - it's an old List queue.xml
                        items = (List) unmarshaledObj;
                        long maxId = 0;
                        for (Object o : items) {
                            if (o instanceof Item) {
                                maxId = Math.max(maxId, ((Item)o).id);
                            }
                        }
                        WaitingItem.COUNTER.set(maxId);
                    }

                    for (Object o : items) {
K
kohsuke 已提交
420
                        if (o instanceof Task) {
421
                            // backward compatibility
422
                            schedule((Task)o, 0);
K
kohsuke 已提交
423 424
                        } else if (o instanceof Item) {
                            Item item = (Item)o;
425 426

                            if (item.task == null) {
K
kohsuke 已提交
427
                                continue;   // botched persistence. throw this one away
428
                            }
K
kohsuke 已提交
429 430

                            if (item instanceof WaitingItem) {
431
                                item.enter(this);
K
kohsuke 已提交
432
                            } else if (item instanceof BlockedItem) {
433
                                item.enter(this);
K
kohsuke 已提交
434
                            } else if (item instanceof BuildableItem) {
435
                                item.enter(this);
K
kohsuke 已提交
436 437 438
                            } else {
                                throw new IllegalStateException("Unknown item type! " + item);
                            }
439
                        }
K
TAB->WS  
kohsuke 已提交
440
                    }
441 442 443 444 445 446 447 448 449

                    // 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 已提交
450 451 452
                    queueFile.delete();
                }
            }
453
        } catch (IOException e) {
454
            LOGGER.log(Level.WARNING, "Failed to load the queue file " + getXMLQueueFile(), e);
455
        } finally { updateSnapshot(); } } finally {
456
            lock.unlock();
K
kohsuke 已提交
457 458 459 460 461 462
        }
    }

    /**
     * Persists the queue contents to the disk.
     */
463
    public void save() {
464
        if(BulkChange.contains(this))  return;
465

466
        lock.lock();
K
kohsuke 已提交
467
        try {
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
            // write out the queue state we want to save
            State state = new State();
            state.counter = WaitingItem.COUNTER.longValue();

            // write out the tasks on the queue
            for (Item item: getItems()) {
                if(item.task instanceof TransientTask)  continue;
            state.items.add(item);
            }

            try {
                XmlFile queueFile = new XmlFile(XSTREAM, getXMLQueueFile());
                queueFile.write(state);
                SaveableListener.fireOnChange(this, queueFile);
            } catch (IOException e) {
                LOGGER.log(Level.WARNING, "Failed to write out the queue file " + getXMLQueueFile(), e);
            }
        } finally {
            lock.unlock();
K
kohsuke 已提交
487 488 489
        }
    }

490 491 492
    /**
     * Wipes out all the items currently in the queue, as if all of them are cancelled at once.
     */
493
    @CLIMethod(name="clear-queue")
494
    public void clear() {
495
        Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
496
        lock.lock();
497
        try { try {
498 499 500 501 502 503
            for (WaitingItem i : new ArrayList<WaitingItem>(
                    waitingList))   // copy the list as we'll modify it in the loop
                i.cancel(this);
            blockedProjects.cancelAll();
            pendings.cancelAll();
            buildables.cancelAll();
504 505
        } finally { updateSnapshot(); } } finally {
            lock.unlock();
506 507
            lock.unlock();
        }
508 509 510
        scheduleMaintenance();
    }

K
kohsuke 已提交
511
    private File getQueueFile() {
512
        return new File(Jenkins.getInstance().getRootDir(), "queue.txt");
K
TAB->WS  
kohsuke 已提交
513
    }
K
kohsuke 已提交
514

515
    /*package*/ File getXMLQueueFile() {
516
        return new File(Jenkins.getInstance().getRootDir(), "queue.xml");
K
TAB->WS  
kohsuke 已提交
517
    }
K
kohsuke 已提交
518

519 520 521 522 523 524 525 526
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(AbstractProject)}
     */
    public boolean add(AbstractProject p) {
        return schedule(p)!=null;
    }

K
kohsuke 已提交
527 528
    /**
     * Schedule a new build for this project.
529
     * @see #schedule(Task, int)
K
kohsuke 已提交
530
     */
531
    public @CheckForNull WaitingItem schedule(AbstractProject p) {
532
        return schedule(p, p.getQuietPeriod());
533 534 535 536
    }

    /**
     * Schedules a new build with a custom quiet period.
537 538
     *
     * <p>
K
kohsuke 已提交
539 540
     * Left for backward compatibility with &lt;1.114.
     *
541
     * @since 1.105
542 543
     * @deprecated as of 1.311
     *      Use {@link #schedule(Task, int)}
544
     */
545 546
    public boolean add(AbstractProject p, int quietPeriod) {
        return schedule(p, quietPeriod)!=null;
K
kohsuke 已提交
547
    }
548

K
Kohsuke Kawaguchi 已提交
549 550 551 552
    /**
     * @deprecated as of 1.521
     *  Use {@link #schedule2(Task, int, List)}
     */
553
    public WaitingItem schedule(Task p, int quietPeriod, List<Action> actions) {
K
Kohsuke Kawaguchi 已提交
554 555 556
        return schedule2(p, quietPeriod, actions).getCreateItem();
    }

557 558 559
    /**
     * Schedules an execution of a task.
     *
560
     * @param actions
K
kohsuke 已提交
561 562 563
     *      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.
564
     *      For the convenience of the caller, this list can contain null, and those will be silently ignored.
565 566
     * @since 1.311
     * @return
567
     *      {@link hudson.model.queue.ScheduleResult.Refused} if Jenkins refused to add this task into the queue (for example because the system
K
Kohsuke Kawaguchi 已提交
568
     *      is about to shutdown.) Otherwise the task is either merged into existing items in the queue
569
     *      (in which case you get {@link hudson.model.queue.ScheduleResult.Existing} instance back), or a new item
K
Kohsuke Kawaguchi 已提交
570 571 572
     *      gets created in the queue (in which case you get {@link Created}.
     *
     *      Note the nature of the queue
573 574 575
     *      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.
     *
576
     *      That said, one can still look at {@link Queue.Item#future}, {@link Queue.Item#getId()}, etc.
577
     */
578
    public @Nonnull ScheduleResult schedule2(Task p, int quietPeriod, List<Action> actions) {
579 580 581 582 583 584 585
        // remove nulls
        actions = new ArrayList<Action>(actions);
        for (Iterator<Action> itr = actions.iterator(); itr.hasNext();) {
            Action a =  itr.next();
            if (a==null)    itr.remove();
        }

586
        lock.lock();
587
        try { try {
588 589 590
            for (QueueDecisionHandler h : QueueDecisionHandler.all())
                if (!h.shouldSchedule(p, actions))
                    return ScheduleResult.refused();    // veto
K
kohsuke 已提交
591

592
            return scheduleInternal(p, quietPeriod, actions);
593
        } finally { updateSnapshot(); } } finally {
594 595
            lock.unlock();
        }
596
    }
597

598 599 600 601 602
    /**
     * Schedules an execution of a task.
     *
     * @since 1.311
     * @return
603 604 605
     *      {@link hudson.model.queue.ScheduleResult.Existing} if this task is already in the queue and
     *      therefore the add operation was no-op. Otherwise {@link hudson.model.queue.ScheduleResult.Created}
     *      indicates the {@link WaitingItem} object added, although the nature of the queue
606 607 608
     *      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.
     *
609
     *      That said, one can still look at {@link WaitingItem#future}, {@link WaitingItem#getId()}, etc.
610
     */
611 612
    private @Nonnull ScheduleResult scheduleInternal(Task p, int quietPeriod, List<Action> actions) {
        lock.lock();
613
        try { try {
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
            Calendar due = new GregorianCalendar();
            due.add(Calendar.SECOND, quietPeriod);

            // Do we already have this task in the queue? Because if so, we won't schedule a new one.
            List<Item> duplicatesInQueue = new ArrayList<Item>();
            for (Item item : liveGetItems(p)) {
                boolean shouldScheduleItem = false;
                for (QueueAction action : item.getActions(QueueAction.class)) {
                    shouldScheduleItem |= action.shouldSchedule(actions);
                }
                for (QueueAction action : Util.filter(actions, QueueAction.class)) {
                    shouldScheduleItem |= action.shouldSchedule((new ArrayList<Action>(item.getAllActions())));
                }
                if (!shouldScheduleItem) {
                    duplicatesInQueue.add(item);
                }
            }
            if (duplicatesInQueue.isEmpty()) {
                LOGGER.log(Level.FINE, "{0} added to queue", p);

                // put the item in the queue
                WaitingItem added = new WaitingItem(due, p, actions);
                added.enter(this);
                scheduleMaintenance();   // let an executor know that a new item is in the queue.
                return ScheduleResult.created(added);
            }
K
kohsuke 已提交
640

641
            LOGGER.log(Level.FINE, "{0} is already in the queue", p);
642

643 644 645 646 647
            // but let the actions affect the existing stuff.
            for (Item item : duplicatesInQueue) {
                for (FoldableAction a : Util.filter(actions, FoldableAction.class)) {
                    a.foldIntoExisting(item, p, actions);
                }
K
kohsuke 已提交
648 649
            }

650 651 652 653 654 655 656 657 658 659 660 661 662
            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
                }
K
kohsuke 已提交
663

664 665 666 667 668 669
                // waitingList is sorted, so when we change a timestamp we need to maintain order
                wi.leave(this);
                wi.timestamp = due;
                wi.enter(this);
                queueUpdated = true;
            }
K
kohsuke 已提交
670

671
            if (queueUpdated) scheduleMaintenance();
K
Kohsuke Kawaguchi 已提交
672

673 674 675 676 677
            // REVISIT: when there are multiple existing items in the queue that matches the incoming one,
            // whether the new one should affect all existing ones or not is debatable. I for myself
            // thought this would only affect one, so the code was bit of surprise, but I'm keeping the current
            // behaviour.
            return ScheduleResult.existing(duplicatesInQueue.get(0));
678
        } finally { updateSnapshot(); } } finally {
679 680
            lock.unlock();
        }
K
kohsuke 已提交
681
    }
682 683


684 685
    /**
     * @deprecated as of 1.311
686
     *      Use {@link #schedule(Task, int)}
687
     */
688
    public boolean add(Task p, int quietPeriod) {
689
    	return schedule(p, quietPeriod)!=null;
690 691
    }

692
    public @CheckForNull WaitingItem schedule(Task p, int quietPeriod) {
693 694 695 696 697
    	return schedule(p, quietPeriod, new Action[0]);
    }

    /**
     * @deprecated as of 1.311
698
     *      Use {@link #schedule(Task, int, Action...)}
699
     */
700
    public boolean add(Task p, int quietPeriod, Action... actions) {
701 702 703
    	return schedule(p, quietPeriod, actions)!=null;
    }

704
    /**
K
kohsuke 已提交
705
     * Convenience wrapper method around {@link #schedule(Task, int, List)}
706
     */
707
    public @CheckForNull WaitingItem schedule(Task p, int quietPeriod, Action... actions) {
K
Kohsuke Kawaguchi 已提交
708 709 710 711 712 713
    	return schedule2(p, quietPeriod, actions).getCreateItem();
    }

    /**
     * Convenience wrapper method around {@link #schedule2(Task, int, List)}
     */
714
    public @Nonnull ScheduleResult schedule2(Task p, int quietPeriod, Action... actions) {
K
Kohsuke Kawaguchi 已提交
715
    	return schedule2(p, quietPeriod, Arrays.asList(actions));
716
    }
K
kohsuke 已提交
717

K
kohsuke 已提交
718
    /**
719
     * Cancels the item in the queue. If the item is scheduled more than once, cancels the first occurrence.
K
kohsuke 已提交
720
     *
721 722
     * @return true if the project was indeed in the queue and was removed.
     *         false if this was no-op.
K
kohsuke 已提交
723
     */
724 725
    public boolean cancel(Task p) {
        lock.lock();
726
        try { try {
727 728 729 730 731
            LOGGER.log(Level.FINE, "Cancelling {0}", p);
            for (WaitingItem item : waitingList) {
                if (item.task.equals(p)) {
                    return item.cancel(this);
                }
K
kohsuke 已提交
732
            }
733 734
            // use bitwise-OR to make sure that both branches get evaluated all the time
            return blockedProjects.cancel(p) != null | buildables.cancel(p) != null;
735 736
        } finally { updateSnapshot(); } } finally {
            lock.unlock();
737
            lock.unlock();
K
kohsuke 已提交
738 739
        }
    }
740

741 742 743 744 745
    private void updateSnapshot() {
        snapshot = new Snapshot(waitingList, blockedProjects, buildables, pendings);
    }

    public boolean cancel(Item item) {
746
        LOGGER.log(Level.FINE, "Cancelling {0} item#{1}", new Object[] {item.task, item.id});
S
Stephen Connolly 已提交
747
        lock.lock();
748
        try { try {
S
Stephen Connolly 已提交
749
            return item.cancel(this);
750
        } finally { updateSnapshot(); } } finally {
S
Stephen Connolly 已提交
751 752
            lock.unlock();
        }
753
    }
K
kohsuke 已提交
754

755 756 757
    /**
     * Called from {@code queue.jelly} and {@code entries.jelly}.
     */
J
Jesse Glick 已提交
758
    @RequirePOST
759
    public HttpResponse doCancelItem(@QueryParameter long id) throws IOException, ServletException {
760 761 762 763 764 765 766
        Item item = getItem(id);
        if (item != null) {
            cancel(item);
        } // else too late, ignore (JENKINS-14813)
        return HttpResponses.forwardToPreviousPage();
    }

767 768 769 770
    public boolean isEmpty() {
        Snapshot snapshot = this.snapshot;
        return snapshot.waitingList.isEmpty() && snapshot.blockedProjects.isEmpty() && snapshot.buildables.isEmpty()
                && snapshot.pendings.isEmpty();
K
kohsuke 已提交
771 772
    }

773
    private WaitingItem peek() {
774
        return waitingList.iterator().next();
K
kohsuke 已提交
775 776 777 778
    }

    /**
     * Gets a snapshot of items in the queue.
779 780 781
     *
     * Generally speaking the array is sorted such that the items that are most likely built sooner are
     * at the end.
K
kohsuke 已提交
782
     */
783
    @Exported(inline=true)
784 785 786 787 788 789 790
    public Item[] getItems() {
        Snapshot s = this.snapshot;
        Item[] r = new Item[s.waitingList.size() + s.blockedProjects.size() + s.buildables.size() +
                s.pendings.size()];
        s.waitingList.toArray(r);
        int idx = s.waitingList.size();
        for (BlockedItem p : s.blockedProjects) {
791
            r[idx++] = p;
792 793
        }
        for (BuildableItem p : reverse(s.buildables)) {
794
            r[idx++] = p;
795 796
        }
        for (BuildableItem p : reverse(s.pendings)) {
797
            r[idx++] = p;
798
        }
K
kohsuke 已提交
799 800
        return r;
    }
801 802 803 804 805

    /**
     * Like {@link #getItems()}, but returns an approximation that might not be completely up-to-date.
     *
     * <p>
J
Jesse Glick 已提交
806
     * At the expense of accuracy, this method does not usually lock {@link Queue} and therefore is faster
807 808 809 810
     * 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 已提交
811
     * is updated and normally no more than one second old, but this is a soft commitment that might
812 813 814 815 816 817 818 819 820 821
     * 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();
    }
822

823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
    public Item getItem(long id) {
        Snapshot snapshot = this.snapshot;
        for (Item item : snapshot.blockedProjects) {
            if (item.id == id)
                return item;
        }
        for (Item item : snapshot.buildables) {
            if (item.id == id)
                return item;
        }
        for (Item item : snapshot.pendings) {
            if (item.id == id)
                return item;
        }
        for (Item item : snapshot.waitingList) {
            if (item.id == id) {
                return item;
            }
        }
842
        return leftItems.getIfPresent(id);
843
    }
K
kohsuke 已提交
844

K
kohsuke 已提交
845 846 847
    /**
     * Gets all the {@link BuildableItem}s that are waiting for an executor in the given {@link Computer}.
     */
848 849
    public List<BuildableItem> getBuildableItems(Computer c) {
        Snapshot snapshot = this.snapshot;
850
        List<BuildableItem> result = new ArrayList<BuildableItem>();
851 852
        _getBuildableItems(c, snapshot.buildables, result);
        _getBuildableItems(c, snapshot.pendings, result);
853 854 855
        return result;
    }

856
    private void _getBuildableItems(Computer c, List<BuildableItem> col, List<BuildableItem> result) {
857
        Node node = c.getNode();
858
        if (node == null)   // Deleted computers cannot take build items...
859
            return;
860
        for (BuildableItem p : col) {
861
            if (node.canTake(p) == null)
862
                result.add(p);
863 864 865
        }
    }

K
kohsuke 已提交
866
    /**
867
     * Gets the snapshot of all {@link BuildableItem}s.
K
kohsuke 已提交
868
     */
869 870 871 872
    public List<BuildableItem> getBuildableItems() {
        Snapshot snapshot = this.snapshot;
        ArrayList<BuildableItem> r = new ArrayList<BuildableItem>(snapshot.buildables);
        r.addAll(snapshot.pendings);
873
        return r;
K
kohsuke 已提交
874 875
    }

876 877 878
    /**
     * Gets the snapshot of all {@link BuildableItem}s.
     */
879 880
    public List<BuildableItem> getPendingItems() {
        return new ArrayList<BuildableItem>(snapshot.pendings);
881 882
    }

883 884
    /**
     * Returns the snapshot of all {@link LeftItem}s.
885 886
     *
     * @since 1.519
887 888 889 890 891
     */
    public Collection<LeftItem> getLeftItems() {
        return Collections.unmodifiableCollection(leftItems.asMap().values());
    }

892 893 894 895 896 897 898 899 900
    /**
     * Immediately clear the {@link #getLeftItems} cache.
     * Useful for tests which need to verify that no links to a build remain.
     * @since 1.519
     */
    public void clearLeftItems() {
        leftItems.invalidateAll();
    }

901 902
    /**
     * Gets all items that are in the queue but not blocked
903 904
     *
     * @since 1.402
905
     */
906 907 908 909 910 911
    public List<Item> getUnblockedItems() {
        Snapshot snapshot = this.snapshot;
        List<Item> queuedNotBlocked = new ArrayList<Item>();
        queuedNotBlocked.addAll(snapshot.waitingList);
        queuedNotBlocked.addAll(snapshot.buildables);
        queuedNotBlocked.addAll(snapshot.pendings);
912
        // but not 'blockedProjects'
913 914 915
        return queuedNotBlocked;
    }

916 917 918 919 920
    /**
     * Works just like {@link #getUnblockedItems()} but return tasks.
     *
     * @since 1.402
     */
921
    public Set<Task> getUnblockedTasks() {
922 923 924 925 926 927 928
        List<Item> items = getUnblockedItems();
        Set<Task> unblockedTasks = new HashSet<Task>(items.size());
        for (Queue.Item t : items)
            unblockedTasks.add(t.task);
        return unblockedTasks;
    }

929 930 931
    /**
     * Is the given task currently pending execution?
     */
932 933 934
    public boolean isPending(Task t) {
        Snapshot snapshot = this.snapshot;
        for (BuildableItem i : snapshot.pendings)
935 936 937 938 939
            if (i.task.equals(t))
                return true;
        return false;
    }

K
kohsuke 已提交
940 941 942
    /**
     * How many {@link BuildableItem}s are assigned for the given label?
     */
943 944
    public int countBuildableItemsFor(Label l) {
        Snapshot snapshot = this.snapshot;
K
kohsuke 已提交
945
        int r = 0;
946
        for (BuildableItem bi : snapshot.buildables)
K
Kohsuke Kawaguchi 已提交
947
            for (SubTask st : bi.task.getSubTasks())
948
                if (null == l || bi.getAssignedLabelFor(st) == l)
K
Kohsuke Kawaguchi 已提交
949
                    r++;
950
        for (BuildableItem bi : snapshot.pendings)
K
Kohsuke Kawaguchi 已提交
951
            for (SubTask st : bi.task.getSubTasks())
952
                if (null == l || bi.getAssignedLabelFor(st) == l)
K
Kohsuke Kawaguchi 已提交
953
                    r++;
K
kohsuke 已提交
954 955 956
        return r;
    }

957 958 959
    /**
     * Counts all the {@link BuildableItem}s currently in the queue.
     */
960
    public int countBuildableItems() {
961
        return countBuildableItemsFor(null);
962 963
    }

K
kohsuke 已提交
964 965 966 967 968
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
    public Item getItem(Task t) {
        Snapshot snapshot = this.snapshot;
        for (Item item : snapshot.blockedProjects) {
            if (item.task.equals(t))
                return item;
        }
        for (Item item : snapshot.buildables) {
            if (item.task.equals(t))
                return item;
        }
        for (Item item : snapshot.pendings) {
            if (item.task.equals(t))
                return item;
        }
        for (Item item : snapshot.waitingList) {
984
            if (item.task.equals(t)) {
K
kohsuke 已提交
985
                return item;
986
            }
K
kohsuke 已提交
987 988 989 990
        }
        return null;
    }

991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     * @since 1.FIXME
     */
    private List<Item> liveGetItems(Task t) {
        lock.lock();
        try {
            List<Item> result = new ArrayList<Item>();
            result.addAll(blockedProjects.getAll(t));
            result.addAll(buildables.getAll(t));
            result.addAll(pendings.getAll(t));
            for (Item item : waitingList) {
                if (item.task.equals(t)) {
                    result.add(item);
                }
            }
            return result;
        } finally {
            lock.unlock();
        }
    }

1015 1016 1017 1018 1019
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
    public List<Item> getItems(Task t) {
        Snapshot snapshot = this.snapshot;
        List<Item> result = new ArrayList<Item>();
        for (Item item : snapshot.blockedProjects) {
            if (item.task.equals(t)) {
                result.add(item);
            }
        }
        for (Item item : snapshot.buildables) {
            if (item.task.equals(t)) {
                result.add(item);
            }
        }
        for (Item item : snapshot.pendings) {
            if (item.task.equals(t)) {
                result.add(item);
            }
        }
        for (Item item : snapshot.waitingList) {
1039
            if (item.task.equals(t)) {
1040
                result.add(item);
1041
            }
1042 1043 1044 1045
        }
        return result;
    }

1046 1047
    /**
     * Left for backward compatibility.
1048
     *
1049
     * @see #getItem(Task)
1050
    public Item getItem(AbstractProject p) {
1051
        return getItem((Task) p);
1052
    }
K
kohsuke 已提交
1053
     */
1054

K
kohsuke 已提交
1055
    /**
K
kohsuke 已提交
1056
     * Returns true if this queue contains the said project.
K
kohsuke 已提交
1057
     */
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
    public boolean contains(Task t) {
        final Snapshot snapshot = this.snapshot;
        for (Item item : snapshot.blockedProjects) {
            if (item.task.equals(t))
                return true;
        }
        for (Item item : snapshot.buildables) {
            if (item.task.equals(t))
                return true;
        }
        for (Item item : snapshot.pendings) {
            if (item.task.equals(t))
                return true;
        }
        for (Item item : snapshot.waitingList) {
1073
            if (item.task.equals(t)) {
K
kohsuke 已提交
1074
                return true;
1075
            }
K
kohsuke 已提交
1076 1077 1078 1079 1080
        }
        return false;
    }

    /**
K
Kohsuke Kawaguchi 已提交
1081 1082 1083
     * Called when the executor actually starts executing the assigned work unit.
     *
     * This moves the task from the pending state to the "left the queue" state.
K
kohsuke 已提交
1084
     */
1085 1086
    /*package*/ void onStartExecuting(Executor exec) throws InterruptedException {
        lock.lock();
1087
        try { try {
1088 1089
            final WorkUnit wu = exec.getCurrentWorkUnit();
            pendings.remove(wu.context.item);
1090

1091 1092
            LeftItem li = new LeftItem(wu.context);
            li.enter(this);
1093
        } finally { updateSnapshot(); } } finally {
1094 1095
            lock.unlock();
        }
K
kohsuke 已提交
1096 1097 1098 1099
    }

    /**
     * Checks the queue and runs anything that can be run.
1100 1101
     *
     * <p>
K
kohsuke 已提交
1102
     * When conditions are changed, this method should be invoked.
1103
     * <p>
K
kohsuke 已提交
1104 1105
     * This wakes up one {@link Executor} so that it will maintain a queue.
     */
1106 1107
    @WithBridgeMethods(void.class)
    public Future<?> scheduleMaintenance() {
1108
        // LOGGER.info("Scheduling maintenance");
1109
        return maintainerThread.submit();
K
kohsuke 已提交
1110 1111
    }

1112
    /**
1113 1114
     * Checks if the given item should be prevented from entering into the {@link #buildables} state
     * and instead stay in the {@link #blockedProjects} state.
1115
     */
1116
    private boolean isBuildBlocked(Item i) {
1117
        if (i.task.isBuildBlocked() || !canRun(i.task.getResourceList()))
1118 1119 1120 1121 1122 1123 1124 1125
            return true;

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

        return false;
1126 1127
    }

1128
    /**
1129 1130
     * Make sure we don't queue two tasks of the same project to be built
     * unless that project allows concurrent builds.
1131
     */
1132 1133 1134 1135 1136 1137 1138
    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
        }
1139
        return !buildables.containsKey(t) && !pendings.containsKey(t);
1140
    }
1141

1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
    /**
     * Some operations require to be performed with the {@link Queue} lock held. Use one of these methods rather
     * than locking directly on Queue in order to allow for future refactoring.
     * @param runnable the operation to perform.
     * @since 1.592
     */
    public static void withLock(Runnable runnable) {
        final Jenkins jenkins = Jenkins.getInstance();
        final Queue queue = jenkins == null ? null : jenkins.getQueue();
        if (queue == null) {
            runnable.run();
        } else {
            queue._withLock(runnable);
        }
    }

    /**
     * Some operations require to be performed with the {@link Queue} lock held. Use one of these methods rather
     * than locking directly on Queue in order to allow for future refactoring.
     *
     * @param callable the operation to perform.
     * @param <V>      the type of return value
     * @param <T>      the type of exception.
     * @return the result of the callable.
     * @throws T the exception of the callable
     * @since 1.592
     */
    public static <V, T extends Throwable> V withLock(hudson.remoting.Callable<V, T> callable) throws T {
        final Jenkins jenkins = Jenkins.getInstance();
        final Queue queue = jenkins == null ? null : jenkins.getQueue();
        if (queue == null) {
            return callable.call();
        } else {
            return queue._withLock(callable);
        }
    }

    /**
     * Some operations require to be performed with the {@link Queue} lock held. Use one of these methods rather
     * than locking directly on Queue in order to allow for future refactoring.
     *
     * @param callable the operation to perform.
     * @param <V>      the type of return value
     * @return the result of the callable.
     * @throws Exception if the callable throws an exception.
     * @since 1.592
     */
    public static <V> V withLock(java.util.concurrent.Callable<V> callable) throws Exception {
        final Jenkins jenkins = Jenkins.getInstance();
        final Queue queue = jenkins == null ? null : jenkins.getQueue();
        if (queue == null) {
            return callable.call();
        } else {
            return queue._withLock(callable);
        }
    }

1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
    @Override
    protected void _await() throws InterruptedException {
        condition.await();
    }

    @Override
    protected void _signalAll() {
        condition.signalAll();
    }

1209 1210 1211 1212 1213 1214
    /**
     * Some operations require to be performed with the {@link Queue} lock held. Use one of these methods rather
     * than locking directly on Queue in order to allow for future refactoring.
     * @param runnable the operation to perform.
     * @since 1.592
     */
1215 1216 1217 1218 1219 1220 1221
    protected void _withLock(Runnable runnable) {
        lock.lock();
        try {
            runnable.run();
        } finally {
            lock.unlock();
        }
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
    }

    /**
     * Some operations require to be performed with the {@link Queue} lock held. Use one of these methods rather
     * than locking directly on Queue in order to allow for future refactoring.
     *
     * @param callable the operation to perform.
     * @param <V>      the type of return value
     * @param <T>      the type of exception.
     * @return the result of the callable.
     * @throws T the exception of the callable
     * @since 1.592
     */
1235 1236 1237 1238 1239 1240 1241
    protected <V, T extends Throwable> V _withLock(hudson.remoting.Callable<V, T> callable) throws T {
        lock.lock();
        try {
            return callable.call();
        } finally {
            lock.unlock();
        }
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
    }

    /**
     * Some operations require to be performed with the {@link Queue} lock held. Use one of these methods rather
     * than locking directly on Queue in order to allow for future refactoring.
     *
     * @param callable the operation to perform.
     * @param <V>      the type of return value
     * @return the result of the callable.
     * @throws Exception if the callable throws an exception.
     * @since 1.592
     */
1254 1255 1256 1257 1258 1259 1260
    protected <V> V _withLock(java.util.concurrent.Callable<V> callable) throws Exception {
        lock.lock();
        try {
            return callable.call();
        } finally {
            lock.unlock();
        }
1261 1262
    }

K
kohsuke 已提交
1263
    /**
K
kohsuke 已提交
1264
     * Queue maintenance.
1265
     *
1266
     * <p>
1267
     * Move projects between {@link #waitingList}, {@link #blockedProjects}, {@link #buildables}, and {@link #pendings}
K
kohsuke 已提交
1268
     * appropriately.
1269 1270 1271 1272
     *
     * <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.),
1273
     * and it also gets invoked periodically (see {@link Queue.MaintainTask}.)
K
kohsuke 已提交
1274
     */
1275 1276
    public void maintain() {
        lock.lock();
1277
        try { try {
1278 1279

            LOGGER.log(Level.FINE, "Queue maintenance started {0}", this);
1280

1281 1282
            // The executors that are currently waiting for a job to run.
            Map<Executor, JobOffer> parked = new HashMap<Executor, JobOffer>();
1283

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
            {// update parked (and identify any pending items who's executor has disappeared)
                List<BuildableItem> lostPendings = new ArrayList<BuildableItem>(pendings);
                for (Computer c : Jenkins.getInstance().getComputers()) {
                    for (Executor e : c.getExecutors()) {
                        if (e.isParking()) {
                            parked.put(e, new JobOffer(e));
                        }
                        final WorkUnit workUnit = e.getCurrentWorkUnit();
                        if (workUnit != null) {
                            lostPendings.remove(workUnit.context.item);
                        }
K
Kohsuke Kawaguchi 已提交
1295 1296
                    }
                }
1297 1298 1299 1300 1301 1302 1303 1304 1305
                // pending -> buildable
                for (BuildableItem p: lostPendings) {
                    LOGGER.log(Level.INFO,
                            "BuildableItem {0}: pending -> buildable as the assigned executor disappeared",
                            p.task.getFullDisplayName());
                    p.isPending = false;
                    pendings.remove(p);
                    makeBuildable(p);
                }
K
Kohsuke Kawaguchi 已提交
1306 1307 1308
            }


1309 1310 1311 1312 1313 1314 1315 1316 1317
            {// blocked -> buildable
                for (BlockedItem p : new ArrayList<BlockedItem>(blockedProjects.values())) {// copy as we'll mutate the list
                    if (!isBuildBlocked(p) && allowNewBuildableTask(p.task)) {
                        // ready to be executed
                        Runnable r = makeBuildable(new BuildableItem(p));
                        if (r != null) {
                            p.leave(this);
                            r.run();
                        }
1318
                    }
1319
                }
K
kohsuke 已提交
1320 1321
            }

1322 1323 1324
            // waitingList -> buildable/blocked
            while (!waitingList.isEmpty()) {
                WaitingItem top = peek();
K
kohsuke 已提交
1325

1326 1327
                if (top.timestamp.compareTo(new GregorianCalendar()) > 0)
                    break; // finished moving all ready items from queue
K
kohsuke 已提交
1328

1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
                top.leave(this);
                Task p = top.task;
                if (!isBuildBlocked(top) && allowNewBuildableTask(p)) {
                    // ready to be executed immediately
                    Runnable r = makeBuildable(new BuildableItem(top));
                    if (r != null) {
                        r.run();
                    } else {
                        new BlockedItem(top).enter(this);
                    }
1339
                } else {
1340 1341
                    // this can't be built now because another build is in progress
                    // set this project aside.
1342 1343
                    new BlockedItem(top).enter(this);
                }
K
kohsuke 已提交
1344
            }
1345

1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
            final QueueSorter s = sorter;
            if (s != null)
                s.sortBuildableItems(buildables);

            // allocate buildable jobs to executors
            for (BuildableItem p : new ArrayList<BuildableItem>(
                    buildables)) {// copy as we'll mutate the list in the loop
                // one last check to make sure this build is not blocked.
                if (isBuildBlocked(p)) {
                    p.leave(this);
                    new BlockedItem(p).enter(this);
                    LOGGER.log(Level.FINE, "Catching that {0} is blocked in the last minute", p);
                    continue;
                }
1360

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
                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
                    LOGGER.log(Level.FINER, "Failed to map {0} to executors. candidates={1} parked={2}",
                            new Object[]{p, candidates, parked.values()});
                    continue;
                }
1376

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

1381 1382 1383 1384 1385 1386
                p.leave(this);
                if (!wuc.getWorkUnits().isEmpty())
                    makePending(p);
                else
                    LOGGER.log(Level.FINE, "BuildableItem {0} with empty work units!?", p);
            }
1387
        } finally { updateSnapshot(); } } finally {
1388
            lock.unlock();
1389
        }
K
kohsuke 已提交
1390 1391
    }

1392 1393 1394 1395 1396 1397 1398 1399
    /**
     * Tries to make an item ready to build.
     * @param p a proposed buildable item
     * @return a thunk to actually prepare it (after leaving an earlier list), or null if it cannot be run now
     */
    private @CheckForNull Runnable makeBuildable(final BuildableItem p) {
        if (p.task instanceof FlyweightTask) {
            if (!isBlockedByShutdown(p.task)) {
1400
            Jenkins h = Jenkins.getInstance();
1401 1402
            Map<Node,Integer> hashSource = new HashMap<Node, Integer>(h.getNodes().size());

1403
            // Even if master is configured with zero executors, we may need to run a flyweight task like MatrixProject on it.
1404
            hashSource.put(h, Math.max(h.getNumExecutors() * 100, 1));
1405 1406

            for (Node n : h.getNodes()) {
1407
                hashSource.put(n, n.getNumExecutors() * 100);
1408 1409
            }

1410 1411
            ConsistentHash<Node> hash = new ConsistentHash<Node>(NODE_HASH);
            hash.addAll(hashSource);
1412

1413
            Label lbl = p.getAssignedLabel();
1414
            for (Node n : hash.list(p.task.getFullDisplayName())) {
1415
                final Computer c = n.toComputer();
K
kohsuke 已提交
1416
                if (c==null || c.isOffline())    continue;
1417
                if (lbl!=null && !lbl.contains(n))  continue;
1418
                if (n.canTake(p) != null) continue;
1419 1420 1421 1422 1423 1424 1425
                return new Runnable() {
                    @Override public void run() {
                        c.startFlyWeightTask(new WorkUnitContext(p).createWorkUnit(p.task));
                        makePending(p);
                    }
                };
            }
1426 1427
            }
            // if the execution get here, it means we couldn't schedule it anywhere.
1428 1429 1430 1431 1432 1433 1434
            return null;
        } else { // regular heavyweight task
            return new Runnable() {
                @Override public void run() {
                    p.enter(Queue.this);
                }
            };
1435 1436 1437
        }
    }

1438 1439 1440 1441 1442 1443 1444

    private static Hash<Node> NODE_HASH = new Hash<Node>() {
        public String hash(Node node) {
            return node.getNodeName();
        }
    };

1445
    private boolean makePending(BuildableItem p) {
1446
        // LOGGER.info("Making "+p.task+" pending"); // REMOVE
1447 1448 1449 1450
        p.isPending = true;
        return pendings.add(p);
    }

1451
    /** @deprecated Use {@link #isBlockedByShutdown} instead. */
1452
    public static boolean ifBlockedByHudsonShutdown(Task task) {
1453 1454 1455 1456 1457 1458 1459
        return isBlockedByShutdown(task);
    }

    /**
     * Checks whether a task should not be scheduled because {@link Jenkins#isQuietingDown()}.
     * @param task some queue task
     * @return true if {@link Jenkins#isQuietingDown()} unless this is a {@link NonBlockingTask}
1460
     * @since 1.598
1461 1462
     */
    public static boolean isBlockedByShutdown(Task task) {
1463
        return Jenkins.getInstance().isQuietingDown() && !(task instanceof NonBlockingTask);
1464 1465
    }

1466 1467 1468 1469
    public Api getApi() {
        return new Api(this);
    }

K
kohsuke 已提交
1470 1471 1472 1473 1474 1475
    /**
     * Marks {@link Task}s that are not persisted.
     * @since 1.311
     */
    public interface TransientTask extends Task {}

1476 1477 1478 1479 1480 1481 1482
    /**
     * Marks {@link Task}s that do not consume {@link Executor}.
     * @see OneOffExecutor
     * @since 1.318
     */
    public interface FlyweightTask extends Task {}

K
kohsuke 已提交
1483
    /**
1484
     * Marks {@link Task}s that are not affected by the {@linkplain Jenkins#isQuietingDown()}  quieting down},
K
kohsuke 已提交
1485
     * because these tasks keep other tasks executing.
1486
     * @see #isBlockedByShutdown
1487
     * @since 1.336
K
kohsuke 已提交
1488 1489 1490
     */
    public interface NonBlockingTask extends Task {}

K
kohsuke 已提交
1491 1492
    /**
     * Task whose execution is controlled by the queue.
1493
     *
1494
     * <p>
K
kohsuke 已提交
1495 1496 1497
     * {@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.
1498 1499 1500
     *
     * <p>
     * Pending {@link Task}s are persisted when Hudson shuts down, so
K
kohsuke 已提交
1501 1502
     * it needs to be persistable via XStream. To create a non-persisted
     * transient Task, extend {@link TransientTask} marker interface.
1503 1504 1505 1506 1507
     *
     * <p>
     * Plugins are encouraged to extend from {@link AbstractQueueTask}
     * instead of implementing this interface directly, to maintain
     * compatibility with future changes to this interface.
1508 1509 1510 1511 1512 1513
     *
     * <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 已提交
1514
     */
1515
    public interface Task extends ModelObject, SubTask {
1516 1517 1518
        /**
         * Returns true if the execution should be blocked
         * for temporary reasons.
1519 1520
         *
         * <p>
1521
         * Short-hand for {@code getCauseOfBlockage()!=null}.
1522 1523 1524 1525
         */
        boolean isBuildBlocked();

        /**
1526 1527
         * @deprecated as of 1.330
         *      Use {@link CauseOfBlockage#getShortDescription()} instead.
1528 1529 1530
         */
        String getWhyBlocked();

1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
        /**
         * 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();

1544
        /**
K
kohsuke 已提交
1545
         * Unique name of this task.
K
kohsuke 已提交
1546
         *
K
kohsuke 已提交
1547 1548
         * <p>
         * This method is no longer used, left here for compatibility. Just return {@link #getDisplayName()}.
1549 1550 1551
         */
        String getName();

1552 1553 1554 1555 1556
        /**
         * @see hudson.model.Item#getFullDisplayName()
         */
        String getFullDisplayName();

1557 1558 1559 1560 1561 1562 1563
        /**
         * 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 已提交
1564 1565 1566 1567

        /**
         * Works just like {@link #checkAbortPermission()} except it indicates the status by a return value,
         * instead of exception.
1568
         * Also used by default for {@link hudson.model.Queue.Item#hasCancelPermission}.
K
kohsuke 已提交
1569 1570
         */
        boolean hasAbortPermission();
1571

1572
        /**
K
kohsuke 已提交
1573 1574 1575 1576 1577 1578 1579 1580
         * 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 '/'.
1581 1582
         */
        String getUrl();
1583

1584
        /**
K
Kohsuke Kawaguchi 已提交
1585 1586
         * True if the task allows concurrent builds, where the same {@link Task} is executed
         * by multiple executors concurrently on the same or different nodes.
1587 1588
         *
         * @since 1.338
1589 1590
         */
        boolean isConcurrentBuild();
1591

1592
        /**
1593
         * Obtains the {@link SubTask}s that constitute this task.
1594
         *
1595
         * <p>
1596 1597 1598
         * 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.
1599
         *
1600
         * <p>
1601
         * At least size 1.
1602
         *
1603 1604
         * <p>
         * Since this is a newly added method, the invocation may results in {@link AbstractMethodError}.
1605
         * Use {@link Tasks#getSubTasksOf(Queue.Task)} that avoids this.
1606
         *
M
mindless 已提交
1607
         * @since 1.377
1608
         */
1609
        Collection<? extends SubTask> getSubTasks();
1610 1611 1612 1613 1614 1615 1616

        /**
         * This method allows the task to provide the default fallback authentication object to be used
         * when {@link QueueItemAuthenticator} fails to authenticate the build.
         *
         * <p>
         * When the task execution touches other objects inside Jenkins, the access control is performed
1617
         * based on whether this {@link Authentication} is allowed to use them.
1618 1619 1620
         *
         * <p>
         * This method was added to an interface after it was created, so plugins built against
1621
         * older versions of Jenkins may not have this method implemented. Called private method _getDefaultAuthenticationOf(Task) on {@link Tasks}
1622 1623 1624 1625
         * to avoid {@link AbstractMethodError}.
         *
         * @since 1.520
         * @see QueueItemAuthenticator
1626
         * @see Tasks#getDefaultAuthenticationOf(Queue.Task)
1627 1628
         */
        @Nonnull Authentication getDefaultAuthentication();
1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647

        /**
         * This method allows the task to provide the default fallback authentication object to be used
         * when {@link QueueItemAuthenticator} fails to authenticate the build.
         *
         * <p>
         * When the task execution touches other objects inside Jenkins, the access control is performed
         * based on whether this {@link Authentication} is allowed to use them.
         *
         * <p>
         * This method was added to an interface after it was created, so plugins built against
         * older versions of Jenkins may not have this method implemented. Called private method _getDefaultAuthenticationOf(Task) on {@link Tasks}
         * to avoid {@link AbstractMethodError}.
         *
         * @since 1.592
         * @see QueueItemAuthenticator
         * @see Tasks#getDefaultAuthenticationOf(Queue.Task, Queue.Item)
         */
        @Nonnull Authentication getDefaultAuthentication(Queue.Item item);
1648 1649
    }

1650
    /**
M
mindless 已提交
1651
     * Represents the real meat of the computation run by {@link Executor}.
1652 1653 1654 1655 1656
     *
     * <h2>Views</h2>
     * <p>
     * Implementation must have <tt>executorCell.jelly</tt>, which is
     * used to render the HTML that indicates this executable is executing.
1657
     */
1658 1659 1660
    public interface Executable extends Runnable {
        /**
         * Task from which this executable was created.
1661 1662
         *
         * <p>
M
mindless 已提交
1663
         * Since this method went through a signature change in 1.377, the invocation may results in
1664
         * {@link AbstractMethodError}.
1665
         * Use {@link Executables#getParentOf(Queue.Executable)} that avoids this.
1666
         */
1667
        @Nonnull SubTask getParent();
1668 1669 1670 1671 1672

        /**
         * Called by {@link Executor} to perform the task
         */
        void run();
1673

1674 1675 1676
        /**
         * Estimate of how long will it take to execute this executable.
         * Measured in milliseconds.
1677
         *
1678
         * Please, consider using {@link Executables#getEstimatedDurationFor(Queue.Executable)}
1679
         * to protected against AbstractMethodErrors!
1680 1681 1682 1683 1684
         *
         * @return -1 if it's impossible to estimate.
         * @since 1.383
         */
        long getEstimatedDuration();
1685 1686 1687 1688

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

K
kohsuke 已提交
1692 1693 1694
    /**
     * Item in a queue.
     */
1695
    @ExportedBean(defaultVisibility = 999)
1696
    public static abstract class Item extends Actionable {
1697 1698 1699

        private final long id;

1700
        /**
1701 1702 1703 1704
         * Unique ID (per master) that tracks the {@link Task} as it moves through different stages
         * in the queue (each represented by different subtypes of {@link Item} and into any subsequent
         * {@link Run} instance (see {@link Run#getQueueId()}).
         * @return
1705
         * @since 1.601
1706
         */
1707
        @Exported
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
        public long getId() {
            return id;
        }

        @AdaptField(was=int.class, name="id")
        @Deprecated
        public int getIdLegacy() {
            if (id > Integer.MAX_VALUE) {
                throw new IllegalStateException("Sorry, you need to update any Plugins attempting to " +
                        "assign 'Queue.Item.id' to an int value. 'Queue.Item.id' is now a long value and " +
                        "has incremented to a value greater than Integer.MAX_VALUE (2^31 - 1).");
            }
            return (int) id;
        }

1723

1724
		/**
K
kohsuke 已提交
1725 1726
         * Project to be built.
         */
1727
        @Exported
1728
        public final Task task;
1729

1730
        private /*almost final*/ transient FutureImpl future;
1731

1732
        private final long inQueueSince;
1733

1734
        /**
1735 1736 1737
         * Build is blocked because another build is in progress,
         * required {@link Resource}s are not available, or otherwise blocked
         * by {@link Task#isBuildBlocked()}.
1738
         */
K
kohsuke 已提交
1739
        @Exported
1740
        public boolean isBlocked() { return this instanceof BlockedItem; }
1741 1742 1743 1744 1745 1746

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

1750 1751 1752 1753 1754
        /**
         * True if the item is starving for an executor for too long.
         */
        @Exported
        public boolean isStuck() { return false; }
1755

1756 1757 1758 1759 1760 1761 1762 1763
        /**
         * Since when is this item in the queue.
         * @return Unix timestamp
         */
        @Exported
        public long getInQueueSince() {
            return this.inQueueSince;
        }
1764

C
Christoph Kutzinski 已提交
1765 1766 1767 1768 1769
        /**
         * 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() {
1770 1771 1772
            long duration = System.currentTimeMillis() - this.inQueueSince;
            return Util.getTimeSpanString(duration);
        }
1773

1774 1775 1776
        /**
         * Can be used to wait for the completion (either normal, abnormal, or cancellation) of the {@link Task}.
         * <p>
1777
         * Just like {@link #getId()}, the same object tracks various stages of the queue.
1778
         */
K
Kohsuke Kawaguchi 已提交
1779 1780
        @WithBridgeMethods(Future.class)
        public QueueTaskFuture<Executable> getFuture() { return future; }
1781

1782 1783 1784 1785
        /**
         * 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.
1786
         *
1787 1788 1789
         * <p>
         * This code takes {@link LabelAssignmentAction} into account, then fall back to {@link SubTask#getAssignedLabel()}
         */
1790 1791 1792 1793 1794 1795 1796
        public Label getAssignedLabel() {
            for (LabelAssignmentAction laa : getActions(LabelAssignmentAction.class)) {
                Label l = laa.getAssignedLabel(task);
                if (l!=null)    return l;
            }
            return task.getAssignedLabel();
        }
1797

1798 1799 1800
        /**
         * Test if the specified {@link SubTask} needs to be run on a node with a particular label, and
         * return that {@link Label}. Otherwise null, indicating it can run on anywhere.
1801
         *
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
         * <p>
         * This code takes {@link LabelAssignmentAction} into account, then falls back to {@link SubTask#getAssignedLabel()}
         */
        public Label getAssignedLabelFor(SubTask st) {
            for (LabelAssignmentAction laa : getActions(LabelAssignmentAction.class)) {
                Label l = laa.getAssignedLabel(st);
                if (l!=null)    return l;
            }
            return st.getAssignedLabel();
        }
1812

1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825
        /**
         * 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();
        }

1826 1827 1828 1829 1830 1831 1832 1833 1834 1835
        @Restricted(DoNotUse.class) // used from Jelly
        public String getCausesDescription() {
            List<Cause> causes = getCauses();
            StringBuilder s = new StringBuilder();
            for (Cause c : causes) {
                s.append(c.getShortDescription()).append('\n');
            }
            return s.toString();
        }

1836
        protected Item(Task task, List<Action> actions, long id, FutureImpl future) {
1837 1838
            this.task = task;
            this.id = id;
1839
            this.future = future;
1840 1841 1842
            this.inQueueSince = System.currentTimeMillis();
            for (Action action: actions) addAction(action);
        }
1843

1844
        protected Item(Task task, List<Action> actions, long id, FutureImpl future, long inQueueSince) {
1845 1846 1847 1848
            this.task = task;
            this.id = id;
            this.future = future;
            this.inQueueSince = inQueueSince;
1849 1850
            for (Action action: actions) addAction(action);
        }
1851

1852
        protected Item(Item item) {
1853
        	this(item.task, new ArrayList<Action>(item.getAllActions()), item.id, item.future, item.inQueueSince);
K
kohsuke 已提交
1854 1855
        }

1856 1857 1858 1859 1860
        /**
         * Returns the URL of this {@link Item} relative to the context path of Jenkins
         *
         * @return
         *      URL that ends with '/'.
1861
         * @since 1.519
1862 1863 1864 1865 1866 1867
         */
        @Exported
        public String getUrl() {
            return "queue/item/"+id+'/';
        }

1868
        /**
1869
         * Gets a human-readable status message describing why it's in the queue.
1870
         */
K
kohsuke 已提交
1871
        @Exported
1872 1873 1874 1875 1876
        public final String getWhy() {
            CauseOfBlockage cob = getCauseOfBlockage();
            return cob!=null ? cob.getShortDescription() : null;
        }

K
kohsuke 已提交
1877 1878 1879
        /**
         * Gets an object that describes why this item is in the queue.
         */
1880 1881
        public abstract CauseOfBlockage getCauseOfBlockage();

1882 1883 1884 1885 1886 1887
        /**
         * Gets a human-readable message about the parameters of this item
         * @return String
         */
        @Exported
        public String getParams() {
K
kohsuke 已提交
1888
        	StringBuilder s = new StringBuilder();
1889 1890 1891 1892
        	for (ParametersAction pa : getActions(ParametersAction.class)) {
                for (ParameterValue p : pa.getParameters()) {
                    s.append('\n').append(p.getShortDescription());
                }
1893
        	}
K
kohsuke 已提交
1894
        	return s.toString();
1895
        }
1896 1897 1898 1899 1900

        /**
         * Checks whether a scheduled item may be canceled.
         * @return by default, the same as {@link hudson.model.Queue.Task#hasAbortPermission}
         */
1901 1902 1903
        public boolean hasCancelPermission() {
            return task.hasAbortPermission();
        }
1904

1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
        public String getDisplayName() {
			// TODO Auto-generated method stub
			return null;
		}

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

1915 1916
        /** @deprecated Use {@link #doCancelItem} instead. */
        @Deprecated
J
Jesse Glick 已提交
1917
        @RequirePOST
1918
        public HttpResponse doCancelQueue() throws IOException, ServletException {
1919
        	Jenkins.getInstance().getQueue().cancel(this);
1920
            return HttpResponses.forwardToPreviousPage();
1921
        }
1922

1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934
        /**
         * Returns the identity that this task carries when it runs, for the purpose of access control.
         *
         * When the task execution touches other objects inside Jenkins, the access control is performed
         * based on whether this {@link Authentication} is allowed to use them. Implementers, if you are unsure,
         * return the identity of the user who queued the task, or {@link ACL#SYSTEM} to bypass the access control
         * and run as the super user.
         *
         * @since 1.520
         */
        @Nonnull
        public Authentication authenticate() {
1935
            for (QueueItemAuthenticator auth : QueueItemAuthenticatorProvider.authenticators()) {
1936 1937 1938 1939
                Authentication a = auth.authenticate(this);
                if (a!=null)
                    return a;
            }
1940
            return Tasks.getDefaultAuthenticationOf(task, this);
1941 1942 1943
        }


1944 1945 1946 1947
        public Api getApi() {
            return new Api(this);
        }

1948
        private Object readResolve() {
1949
            this.future = new FutureImpl(task);
1950 1951
            return this;
        }
K
kohsuke 已提交
1952 1953 1954

        @Override
        public String toString() {
1955
            return getClass().getName() + ':' + task + ':' + id;
K
kohsuke 已提交
1956
        }
1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970

        /**
         * Enters the appropriate queue for this type of item.
         */
        /*package*/ abstract void enter(Queue q);

        /**
         * Leaves the appropriate queue for this type of item.
         */
        /*package*/ abstract boolean leave(Queue q);

        /**
         * Cancels this item, which updates {@link #future} to notify the listener, and
         * also leaves the queue.
K
Kohsuke Kawaguchi 已提交
1971 1972 1973
         *
         * @return true
         *      if the item was successfully cancelled.
1974 1975 1976
         */
        /*package*/ boolean cancel(Queue q) {
            boolean r = leave(q);
K
Kohsuke Kawaguchi 已提交
1977 1978 1979 1980 1981
            if (r) {
                future.setAsCancelled();
                LeftItem li = new LeftItem(this);
                li.enter(q);
            }
1982 1983 1984
            return r;
        }

1985
    }
1986

1987 1988 1989
    /**
     * An optional interface for actions on Queue.Item.
     * Lets the action cooperate in queue management.
1990
     *
1991
     * @since 1.300-ish.
1992 1993 1994
     */
    public interface QueueAction extends Action {
    	/**
1995
    	 * Returns whether the new item should be scheduled.
1996 1997
    	 * An action should return true if the associated task is 'different enough' to warrant a separate execution.
    	 */
1998
	    boolean shouldSchedule(List<Action> actions);
1999
    }
2000

2001
    /**
K
kohsuke 已提交
2002 2003 2004 2005 2006
     * 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
2007
     * to the queue, and the task will never get executed.
2008 2009
     *
     * <p>
2010 2011
     * 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.
2012 2013 2014 2015 2016
     *
     * @since 1.316
     */
    public static abstract class QueueDecisionHandler implements ExtensionPoint {
    	/**
K
kohsuke 已提交
2017
    	 * Returns whether the new item should be scheduled.
2018 2019 2020 2021
         *
         * @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.
2022 2023
    	 */
    	public abstract boolean shouldSchedule(Task p, List<Action> actions);
2024

2025 2026 2027 2028
    	/**
    	 * All registered {@link QueueDecisionHandler}s
    	 */
    	public static ExtensionList<QueueDecisionHandler> all() {
2029
    		return ExtensionList.lookup(QueueDecisionHandler.class);
2030 2031
    	}
    }
2032

2033 2034 2035
    /**
     * {@link Item} in the {@link Queue#waitingList} stage.
     */
2036
    public static final class WaitingItem extends Item implements Comparable<WaitingItem> {
2037
	private static final AtomicLong COUNTER = new AtomicLong(0);
2038

2039 2040 2041 2042 2043
        /**
         * This item can be run after this time.
         */
        @Exported
        public Calendar timestamp;
2044

2045
        public WaitingItem(Calendar timestamp, Task project, List<Action> actions) {
2046
            super(project, actions, COUNTER.incrementAndGet(), new FutureImpl(project));
2047 2048
            this.timestamp = timestamp;
        }
2049

2050 2051 2052 2053
        static int getCurrentCounterValue() {
            return COUNTER.intValue();
        }

2054 2055 2056 2057
        public int compareTo(WaitingItem that) {
            int r = this.timestamp.getTime().compareTo(that.timestamp.getTime());
            if (r != 0) return r;

2058 2059 2060 2061 2062 2063 2064
            if (this.getId() < that.getId()) {
                return -1;
            } else if (this.getId() == that.getId()) {
                return 0;
            } else {
                return 1;
            }
2065 2066
        }

2067
        public CauseOfBlockage getCauseOfBlockage() {
2068
            long diff = timestamp.getTimeInMillis() - System.currentTimeMillis();
2069
            if (diff > 0)
2070
                return CauseOfBlockage.fromMessage(Messages._Queue_InQuietPeriod(Util.getTimeSpanString(diff)));
2071
            else
2072
                return CauseOfBlockage.fromMessage(Messages._Queue_Unknown());
2073
        }
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105

        @Override
        /*package*/ void enter(Queue q) {
            if (q.waitingList.add(this)) {
                for (QueueListener ql : QueueListener.all()) {
                    try {
                        ql.onEnterWaiting(this);
                    } catch (Throwable e) {
                        // don't let this kill the queue
                        LOGGER.log(Level.WARNING, "QueueListener failed while processing "+this,e);
                    }
                }
            }
        }

        @Override
        /*package*/ boolean leave(Queue q) {
            boolean r = q.waitingList.remove(this);
            if (r) {
                for (QueueListener ql : QueueListener.all()) {
                    try {
                        ql.onLeaveWaiting(this);
                    } catch (Throwable e) {
                        // don't let this kill the queue
                        LOGGER.log(Level.WARNING, "QueueListener failed while processing "+this,e);
                    }
                }
            }
            return r;
        }


2106
    }
K
kohsuke 已提交
2107

2108 2109 2110
    /**
     * Common part between {@link BlockedItem} and {@link BuildableItem}.
     */
2111
    public static abstract class NotWaitingItem extends Item {
2112 2113 2114 2115 2116 2117 2118
        /**
         * When did this job exit the {@link Queue#waitingList} phase?
         */
        @Exported
        public final long buildableStartMilliseconds;

        protected NotWaitingItem(WaitingItem wi) {
2119
            super(wi);
2120
            buildableStartMilliseconds = System.currentTimeMillis();
K
kohsuke 已提交
2121
        }
2122

2123
        protected NotWaitingItem(NotWaitingItem ni) {
2124
            super(ni);
2125
            buildableStartMilliseconds = ni.buildableStartMilliseconds;
2126
        }
2127
    }
2128

2129 2130 2131 2132 2133 2134 2135
    /**
     * {@link Item} in the {@link Queue#blockedProjects} stage.
     */
    public final class BlockedItem extends NotWaitingItem {
        public BlockedItem(WaitingItem wi) {
            super(wi);
        }
2136

2137 2138 2139 2140
        public BlockedItem(NotWaitingItem ni) {
            super(ni);
        }

2141
        public CauseOfBlockage getCauseOfBlockage() {
2142 2143 2144
            ResourceActivity r = getBlockingActivity(task);
            if (r != null) {
                if (r == task) // blocked by itself, meaning another build is in progress
2145 2146
                    return CauseOfBlockage.fromMessage(Messages._Queue_InProgress());
                return CauseOfBlockage.fromMessage(Messages._Queue_BlockedBy(r.getDisplayName()));
2147
            }
2148

2149 2150 2151 2152 2153
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all()) {
                CauseOfBlockage cause = d.canRun(this);
                if (cause != null)
                    return cause;
            }
2154

2155
            return task.getCauseOfBlockage();
2156
        }
2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185

        /*package*/ void enter(Queue q) {
            LOGGER.log(Level.FINE, "{0} is blocked", this);
            blockedProjects.add(this);
            for (QueueListener ql : QueueListener.all()) {
                try {
                    ql.onEnterBlocked(this);
                } catch (Throwable e) {
                    // don't let this kill the queue
                    LOGGER.log(Level.WARNING, "QueueListener failed while processing "+this,e);
                }
            }
        }

        /*package*/ boolean leave(Queue q) {
            boolean r = blockedProjects.remove(this);
            if (r) {
                LOGGER.log(Level.FINE, "{0} no longer blocked", this);
                for (QueueListener ql : QueueListener.all()) {
                    try {
                        ql.onLeaveBlocked(this);
                    } catch (Throwable e) {
                        // don't let this kill the queue
                        LOGGER.log(Level.WARNING, "QueueListener failed while processing "+this,e);
                    }
                }
            }
            return r;
        }
2186
    }
2187

2188 2189 2190
    /**
     * {@link Item} in the {@link Queue#buildables} stage.
     */
2191
    public final static class BuildableItem extends NotWaitingItem {
2192 2193 2194 2195 2196
        /**
         * Set to true when this is added to the {@link Queue#pendings} list.
         */
        private boolean isPending;

2197 2198 2199 2200 2201 2202 2203 2204
        public BuildableItem(WaitingItem wi) {
            super(wi);
        }

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

2205
        public CauseOfBlockage getCauseOfBlockage() {
2206
            Jenkins jenkins = Jenkins.getInstance();
2207
            if(isBlockedByShutdown(task))
2208
                return CauseOfBlockage.fromMessage(Messages._Queue_HudsonIsAboutToShutDown());
K
kohsuke 已提交
2209

2210
            Label label = getAssignedLabel();
2211 2212
            List<Node> allNodes = jenkins.getNodes();
            if (allNodes.isEmpty())
2213
                label = null;    // no master/slave. pointless to talk about nodes
2214

2215
            if (label != null) {
K
Kohsuke Kawaguchi 已提交
2216
                Set<Node> nodes = label.getNodes();
2217
                if (label.isOffline()) {
2218
                    if (nodes.size() != 1)      return new BecauseLabelIsOffline(label);
2219
                    else                        return new BecauseNodeIsOffline(nodes.iterator().next());
K
Kohsuke Kawaguchi 已提交
2220 2221 2222
                } else {
                    if (nodes.size() != 1)      return new BecauseLabelIsBusy(label);
                    else                        return new BecauseNodeIsBusy(nodes.iterator().next());
2223
                }
K
Kohsuke Kawaguchi 已提交
2224 2225
            } else {
                return CauseOfBlockage.createNeedsMoreExecutor(Messages._Queue_WaitingForNextAvailableExecutor());
2226 2227
            }
        }
2228 2229 2230

        @Override
        public boolean isStuck() {
2231
            Label label = getAssignedLabel();
2232 2233 2234 2235 2236 2237 2238
            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) {
2239
                // if we were running elsewhere, we would have done this build ten times.
2240
                return elapsed > Math.max(d,60000L)*10;
2241 2242
            } else {
                // more than a day in the queue
2243
                return TimeUnit2.MILLISECONDS.toHours(elapsed)>24;
2244 2245
            }
        }
2246 2247 2248 2249 2250

        @Exported
        public boolean isPending() {
            return isPending;
        }
2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280

        @Override
        /*package*/ void enter(Queue q) {
            q.buildables.add(this);
            for (QueueListener ql : QueueListener.all()) {
                try {
                    ql.onEnterBuildable(this);
                } catch (Throwable e) {
                    // don't let this kill the queue
                    LOGGER.log(Level.WARNING, "QueueListener failed while processing "+this,e);
                }
            }
        }

        @Override
        /*package*/ boolean leave(Queue q) {
            boolean r = q.buildables.remove(this);
            if (r) {
                LOGGER.log(Level.FINE, "{0} no longer blocked", this);
                for (QueueListener ql : QueueListener.all()) {
                    try {
                        ql.onLeaveBuildable(this);
                    } catch (Throwable e) {
                        // don't let this kill the queue
                        LOGGER.log(Level.WARNING, "QueueListener failed while processing "+this,e);
                    }
                }
            }
            return r;
        }
K
kohsuke 已提交
2281 2282
    }

2283 2284 2285
    /**
     * {@link Item} in the {@link Queue#leftItems} stage. These are items that had left the queue
     * by either began executing or by getting cancelled.
2286 2287
     *
     * @since 1.519
2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
     */
    public final static class LeftItem extends Item {
        public final WorkUnitContext outcome;

        /**
         * When item has left the queue and begin executing.
         */
        public LeftItem(WorkUnitContext wuc) {
            super(wuc.item);
            this.outcome = wuc;
        }

        /**
         * When item is cancelled.
         */
        public LeftItem(Item cancelled) {
            super(cancelled);
            this.outcome = null;
        }

        @Override
        public CauseOfBlockage getCauseOfBlockage() {
            return null;
        }

        /**
         * If this is representing an item that started executing, this property returns
         * the primary executable (such as {@link AbstractBuild}) that created out of it.
         */
        @Exported
2318
        public @CheckForNull Executable getExecutable() {
2319 2320 2321 2322 2323 2324 2325 2326 2327 2328
            return outcome!=null ? outcome.getPrimaryWorkUnit().getExecutable() : null;
        }

        /**
         * Is this representing a cancelled item?
         */
        @Exported
        public boolean isCancelled() {
            return outcome==null;
        }
2329 2330 2331

        @Override
        void enter(Queue q) {
2332
            q.leftItems.put(getId(),this);
2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347
            for (QueueListener ql : QueueListener.all()) {
                try {
                    ql.onLeft(this);
                } catch (Throwable e) {
                    // don't let this kill the queue
                    LOGGER.log(Level.WARNING, "QueueListener failed while processing "+this,e);
                }
            }
        }

        @Override
        boolean leave(Queue q) {
            // there's no leave operation
            return false;
        }
2348 2349
    }

K
kohsuke 已提交
2350
    private static final Logger LOGGER = Logger.getLogger(Queue.class.getName());
2351

2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367
    /**
     * 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) {
2368
                Object item = Jenkins.getInstance().getItemByFullName(string);
2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
                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]);
2391
				Job<?,?> job = (Job<?,?>) Jenkins.getInstance().getItemByFullName(projectName);
2392 2393
                if(job==null)  throw new NoSuchElementException("No such job exists: "+projectName);
				Run<?,?> run = job.getBuildByNumber(buildNumber);
K
kohsuke 已提交
2394
                if(run==null)  throw new NoSuchElementException("No such build: "+string);
2395 2396 2397 2398 2399 2400 2401 2402 2403
				return run;
			}

			@Override
			public String toString(Object object) {
				Run<?,?> run = (Run<?,?>) object;
				return run.getParent().getFullName() + "#" + run.getNumber();
			}
        });
2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423

        /**
         * 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";
			}
        });
2424 2425
    }

2426 2427 2428 2429 2430 2431 2432 2433 2434
    /**
     * 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);
K
Kohsuke Kawaguchi 已提交
2435
        }
2436

K
Kohsuke Kawaguchi 已提交
2437
        private void periodic() {
J
Jesse Glick 已提交
2438
            long interval = 5000;
2439
            Timer.get().scheduleWithFixedDelay(this, interval, interval, TimeUnit.MILLISECONDS);
2440 2441 2442 2443
        }

        protected void doRun() {
            Queue q = queue.get();
2444
            if (q != null)
2445 2446 2447 2448 2449
                q.maintain();
            else
                cancel();
        }
    }
2450

2451
    /**
2452
     * {@link ArrayList} of {@link Item} with more convenience methods.
2453
     */
2454
    private class ItemList<T extends Item> extends ArrayList<T> {
2455 2456
    	public T get(Task task) {
    		for (T item: this) {
2457
    			if (item.task.equals(task)) {
2458 2459 2460 2461 2462
    				return item;
    			}
    		}
    		return null;
    	}
2463

2464 2465 2466
    	public List<T> getAll(Task task) {
    		List<T> result = new ArrayList<T>();
    		for (T item: this) {
2467
    			if (item.task.equals(task)) {
2468 2469 2470 2471 2472
    				result.add(item);
    			}
    		}
    		return result;
    	}
2473

2474 2475 2476
    	public boolean containsKey(Task task) {
    		return get(task) != null;
    	}
2477

2478 2479 2480 2481
    	public T remove(Task task) {
    		Iterator<T> it = iterator();
    		while (it.hasNext()) {
    			T t = it.next();
2482
    			if (t.task.equals(task)) {
2483 2484 2485 2486 2487 2488
    				it.remove();
    				return t;
    			}
    		}
    		return null;
    	}
2489

2490
    	public void put(Task task, T item) {
2491
    		assert item.task.equals(task);
2492 2493
    		add(item);
    	}
2494

2495 2496 2497
    	public ItemList<T> values() {
    		return this;
    	}
2498 2499 2500 2501 2502

        /**
         * Works like {@link #remove(Task)} but also marks the {@link Item} as cancelled.
         */
        public T cancel(Task p) {
2503 2504
            T x = get(p);
            if(x!=null) x.cancel(Queue.this);
2505 2506 2507 2508
            return x;
        }

        public void cancelAll() {
2509 2510 2511 2512
            for (T t : new ArrayList<T>(this))
                t.cancel(Queue.this);

            clear();    // just to be sure
2513
        }
2514
    }
2515

2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530
    private static class Snapshot {
        private final Set<WaitingItem> waitingList;
        private final List<BlockedItem> blockedProjects;
        private final List<BuildableItem> buildables;
        private final List<BuildableItem> pendings;

        public Snapshot(Set<WaitingItem> waitingList, List<BlockedItem> blockedProjects, List<BuildableItem> buildables,
                        List<BuildableItem> pendings) {
            this.waitingList = new LinkedHashSet<WaitingItem>(waitingList);
            this.blockedProjects = new ArrayList<BlockedItem>(blockedProjects);
            this.buildables = new ArrayList<BuildableItem>(buildables);
            this.pendings = new ArrayList<BuildableItem>(pendings);
        }
    }

2531 2532
    @CLIResolver
    public static Queue getInstance() {
2533
        return Jenkins.getInstance().getQueue();
2534
    }
K
kohsuke 已提交
2535 2536 2537 2538 2539

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