Queue.java 95.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.Future;
100
import java.util.concurrent.atomic.AtomicLong;
101 102
import java.util.concurrent.locks.Condition;
import java.util.concurrent.locks.ReentrantLock;
K
kohsuke 已提交
103 104 105
import java.util.logging.Level;
import java.util.logging.Logger;

106
import javax.annotation.Nonnull;
107
import javax.servlet.ServletException;
K
kohsuke 已提交
108

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

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

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

K
kohsuke 已提交
132 133
/**
 * Build queue.
134 135
 *
 * <p>
136 137
 * 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}
138
 * so that we can keep track of additional data used for deciding what to execute when.
139 140
 *
 * <p>
141 142 143 144 145 146
 * Items in queue goes through several stages, as depicted below:
 * <pre>
 * (enter) --> waitingList --+--> blockedProjects
 *                           |        ^
 *                           |        |
 *                           |        v
147
 *                           +--> buildables ---> pending ---> left
148 149 150
 *                                    ^              |
 *                                    |              |
 *                                    +---(rarely)---+
151
 * </pre>
152 153
 *
 * <p>
154 155 156 157 158 159 160 161
 * 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>
162 163 164
 * 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 已提交
165
 * @author Kohsuke Kawaguchi
166 167
 * @see QueueListener
 * @see QueueTaskDispatcher
K
kohsuke 已提交
168
 */
169
@ExportedBean
170
public class Queue extends ResourceController implements Saveable {
171 172 173 174

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            return isAvailable();
        }

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

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

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

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

328
    private volatile transient LoadBalancer loadBalancer;
329

330
    private volatile transient QueueSorter sorter;
331

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

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

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

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

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

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

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

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

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

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

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

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

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

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

467
        XmlFile queueFile = new XmlFile(XSTREAM, getXMLQueueFile());
468
        lock.lock();
K
kohsuke 已提交
469
        try {
470 471 472 473 474 475 476
            // 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;
477
                state.items.add(item);
478 479 480 481 482 483 484 485 486
            }

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

491 492 493
    /**
     * Wipes out all the items currently in the queue, as if all of them are cancelled at once.
     */
494
    @CLIMethod(name="clear-queue")
495
    public void clear() {
496
        Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
497
        lock.lock();
498
        try { try {
499 500 501 502 503 504
            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();
505 506
        } finally { updateSnapshot(); } } finally {
            lock.unlock();
507
        }
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
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(AbstractProject)}
     */
523
    @Deprecated
524 525 526 527
    public boolean add(AbstractProject p) {
        return schedule(p)!=null;
    }

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

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

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

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

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

595
            return scheduleInternal(p, quietPeriod, actions);
596
        } finally { updateSnapshot(); } } finally {
597 598
            lock.unlock();
        }
599
    }
600

601 602 603 604 605
    /**
     * Schedules an execution of a task.
     *
     * @since 1.311
     * @return
606 607 608
     *      {@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
609 610 611
     *      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.
     *
612
     *      That said, one can still look at {@link WaitingItem#future}, {@link WaitingItem#getId()}, etc.
613
     */
614 615
    private @Nonnull ScheduleResult scheduleInternal(Task p, int quietPeriod, List<Action> actions) {
        lock.lock();
616
        try { try {
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
            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 已提交
643

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

646 647 648 649 650
            // 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 已提交
651 652
            }

653 654
            boolean queueUpdated = false;
            for (WaitingItem wi : Util.filter(duplicatesInQueue, WaitingItem.class)) {
655 656 657
                // make sure to always use the shorter of the available due times
                if (wi.timestamp.before(due))
                    continue;
K
kohsuke 已提交
658

659 660 661 662 663 664
                // 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 已提交
665

666
            if (queueUpdated) scheduleMaintenance();
K
Kohsuke Kawaguchi 已提交
667

668 669 670 671 672
            // 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));
673
        } finally { updateSnapshot(); } } finally {
674 675
            lock.unlock();
        }
K
kohsuke 已提交
676
    }
677 678


679 680
    /**
     * @deprecated as of 1.311
681
     *      Use {@link #schedule(Task, int)}
682
     */
683
    @Deprecated
684
    public boolean add(Task p, int quietPeriod) {
685
    	return schedule(p, quietPeriod)!=null;
686 687
    }

688
    public @CheckForNull WaitingItem schedule(Task p, int quietPeriod) {
689 690 691 692 693
    	return schedule(p, quietPeriod, new Action[0]);
    }

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

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

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

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

737 738 739 740 741
    private void updateSnapshot() {
        snapshot = new Snapshot(waitingList, blockedProjects, buildables, pendings);
    }

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

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

763 764 765 766
    public boolean isEmpty() {
        Snapshot snapshot = this.snapshot;
        return snapshot.waitingList.isEmpty() && snapshot.blockedProjects.isEmpty() && snapshot.buildables.isEmpty()
                && snapshot.pendings.isEmpty();
K
kohsuke 已提交
767 768
    }

769
    private WaitingItem peek() {
770
        return waitingList.iterator().next();
K
kohsuke 已提交
771 772 773 774
    }

    /**
     * Gets a snapshot of items in the queue.
775 776 777
     *
     * Generally speaking the array is sorted such that the items that are most likely built sooner are
     * at the end.
K
kohsuke 已提交
778
     */
779
    @Exported(inline=true)
780 781 782 783 784 785 786
    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) {
787
            r[idx++] = p;
788 789
        }
        for (BuildableItem p : reverse(s.buildables)) {
790
            r[idx++] = p;
791 792
        }
        for (BuildableItem p : reverse(s.pendings)) {
793
            r[idx++] = p;
794
        }
K
kohsuke 已提交
795 796
        return r;
    }
797 798 799 800 801

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

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
    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;
            }
        }
838
        return leftItems.getIfPresent(id);
839
    }
K
kohsuke 已提交
840

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

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

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

872 873 874
    /**
     * Gets the snapshot of all {@link BuildableItem}s.
     */
875 876
    public List<BuildableItem> getPendingItems() {
        return new ArrayList<BuildableItem>(snapshot.pendings);
877 878
    }

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

888 889 890 891 892 893 894 895 896
    /**
     * 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();
    }

897 898
    /**
     * Gets all items that are in the queue but not blocked
899 900
     *
     * @since 1.402
901
     */
902 903 904 905 906 907
    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);
908
        // but not 'blockedProjects'
909 910 911
        return queuedNotBlocked;
    }

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

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

K
kohsuke 已提交
936 937
    /**
     * How many {@link BuildableItem}s are assigned for the given label?
938 939 940
     * @param l Label to be checked. If null, any label will be accepted.
     *    If you want to count {@link BuildableItem}s without assigned labels,
     *    use {@link #strictCountBuildableItemsFor(hudson.model.Label)}.
941
     * @return Number of {@link BuildableItem}s for the specified label. 
K
kohsuke 已提交
942
     */
943
    public @Nonnegative int countBuildableItemsFor(@CheckForNull Label l) {
944
        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
        return r;
    }
956 957 958 959 960 961 962 963 964
    
    /**
     * How many {@link BuildableItem}s are assigned for the given label?
     * <p/>
     * The implementation is quite similar to {@link #countBuildableItemsFor(hudson.model.Label)},
     * but it has another behavior for null parameters.
     * @param l Label to be checked. If null, only jobs without assigned labels
     *      will be taken into the account.
     * @return Number of {@link BuildableItem}s for the specified label.
O
Oleg Nenashev 已提交
965
     * @since 1.615
966 967 968 969 970 971 972 973 974 975 976 977 978 979
     */
    public @Nonnegative int strictCountBuildableItemsFor(@CheckForNull Label l) {
        Snapshot _snapshot = this.snapshot;
        int r = 0;
        for (BuildableItem bi : _snapshot.buildables)
            for (SubTask st : bi.task.getSubTasks())
                if (bi.getAssignedLabelFor(st) == l)
                    r++;
        for (BuildableItem bi : _snapshot.pendings)
            for (SubTask st : bi.task.getSubTasks())
                if (bi.getAssignedLabelFor(st) == l)
                    r++;
        return r;
    }
K
kohsuke 已提交
980

981 982 983
    /**
     * Counts all the {@link BuildableItem}s currently in the queue.
     */
984
    public int countBuildableItems() {
985
        return countBuildableItemsFor(null);
986 987
    }

K
kohsuke 已提交
988 989 990 991 992
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
    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) {
1008
            if (item.task.equals(t)) {
K
kohsuke 已提交
1009
                return item;
1010
            }
K
kohsuke 已提交
1011 1012 1013 1014
        }
        return null;
    }

1015 1016 1017 1018
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
S
Stephen Connolly 已提交
1019
     * @since 1.607
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
     */
    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();
        }
    }

1039 1040 1041 1042 1043
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
    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) {
1063
            if (item.task.equals(t)) {
1064
                result.add(item);
1065
            }
1066 1067 1068 1069
        }
        return result;
    }

K
kohsuke 已提交
1070
    /**
K
kohsuke 已提交
1071
     * Returns true if this queue contains the said project.
K
kohsuke 已提交
1072
     */
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
    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) {
1088
            if (item.task.equals(t)) {
K
kohsuke 已提交
1089
                return true;
1090
            }
K
kohsuke 已提交
1091 1092 1093 1094 1095
        }
        return false;
    }

    /**
K
Kohsuke Kawaguchi 已提交
1096 1097 1098
     * 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 已提交
1099
     */
1100 1101
    /*package*/ void onStartExecuting(Executor exec) throws InterruptedException {
        lock.lock();
1102
        try { try {
1103 1104
            final WorkUnit wu = exec.getCurrentWorkUnit();
            pendings.remove(wu.context.item);
1105

1106 1107
            LeftItem li = new LeftItem(wu.context);
            li.enter(this);
1108
        } finally { updateSnapshot(); } } finally {
1109 1110
            lock.unlock();
        }
K
kohsuke 已提交
1111 1112 1113 1114
    }

    /**
     * Checks the queue and runs anything that can be run.
1115 1116
     *
     * <p>
K
kohsuke 已提交
1117
     * When conditions are changed, this method should be invoked.
1118
     * <p>
K
kohsuke 已提交
1119 1120
     * This wakes up one {@link Executor} so that it will maintain a queue.
     */
1121 1122
    @WithBridgeMethods(void.class)
    public Future<?> scheduleMaintenance() {
1123
        // LOGGER.info("Scheduling maintenance");
1124
        return maintainerThread.submit();
K
kohsuke 已提交
1125 1126
    }

1127
    /**
1128 1129
     * Checks if the given item should be prevented from entering into the {@link #buildables} state
     * and instead stay in the {@link #blockedProjects} state.
1130
     */
1131
    private boolean isBuildBlocked(Item i) {
1132
        if (i.task.isBuildBlocked() || !canRun(i.task.getResourceList()))
1133 1134 1135 1136 1137 1138 1139 1140
            return true;

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

        return false;
1141 1142
    }

1143
    /**
1144 1145
     * Make sure we don't queue two tasks of the same project to be built
     * unless that project allows concurrent builds.
1146
     */
1147 1148 1149 1150 1151 1152 1153
    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
        }
1154
        return !buildables.containsKey(t) && !pendings.containsKey(t);
1155
    }
1156

1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
    /**
     * 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);
        }
    }

    /**
S
Stephen Connolly 已提交
1174
     * Some operations require the {@link Queue} lock held. Use one of these methods rather
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
     * 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);
        }
    }

1214
    /**
S
Stephen Connolly 已提交
1215 1216
     * Invokes the supplied {@link Runnable} if the {@link Queue} lock was obtained without blocking.
     *
1217
     * @param runnable the operation to perform.
S
Stephen Connolly 已提交
1218 1219
     * @return {@code true} if the lock was available and the operation was performed.
     * @since 1.618
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
     */
    public static boolean tryWithLock(Runnable runnable) {
        final Jenkins jenkins = Jenkins.getInstance();
        final Queue queue = jenkins == null ? null : jenkins.getQueue();
        if (queue == null) {
            runnable.run();
            return true;
        } else {
            return queue._tryWithLock(runnable);
        }
    }
    /**
     * Wraps a {@link Runnable} with the  {@link Queue} lock held. 
     *
     * @param runnable the operation to wrap.
S
Stephen Connolly 已提交
1235
     * @since 1.618
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
     */
    public static Runnable wrapWithLock(Runnable runnable) {
        final Jenkins jenkins = Jenkins.getInstance();
        final Queue queue = jenkins == null ? null : jenkins.getQueue();
        return queue == null ? runnable : new LockedRunnable(runnable);
    }

    /**
     * Wraps a {@link hudson.remoting.Callable} with the  {@link Queue} lock held. 
     *
     * @param callable the operation to wrap.
S
Stephen Connolly 已提交
1247
     * @since 1.618
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
     */
    public static <V, T extends Throwable> hudson.remoting.Callable<V, T> wrapWithLock(hudson.remoting.Callable<V, T> callable) {
        final Jenkins jenkins = Jenkins.getInstance();
        final Queue queue = jenkins == null ? null : jenkins.getQueue();
        return queue == null ? callable : new LockedHRCallable<>(callable);
    }

    /**
     * Wraps a {@link java.util.concurrent.Callable} with the {@link Queue} lock held. 
     *
     * @param callable the operation to wrap.
S
Stephen Connolly 已提交
1259
     * @since 1.618
1260 1261 1262 1263 1264 1265 1266
     */
    public static <V> java.util.concurrent.Callable<V> wrapWithLock(java.util.concurrent.Callable<V> callable) {
        final Jenkins jenkins = Jenkins.getInstance();
        final Queue queue = jenkins == null ? null : jenkins.getQueue();
        return queue == null ? callable : new LockedJUCCallable<V>(callable);
    }

1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
    @Override
    protected void _await() throws InterruptedException {
        condition.await();
    }

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

1277 1278 1279 1280 1281 1282
    /**
     * 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
     */
1283 1284 1285 1286 1287 1288 1289
    protected void _withLock(Runnable runnable) {
        lock.lock();
        try {
            runnable.run();
        } finally {
            lock.unlock();
        }
1290 1291
    }

1292
    /**
S
Stephen Connolly 已提交
1293 1294
     * Invokes the supplied {@link Runnable} if the {@link Queue} lock was obtained without blocking.
     *
1295
     * @param runnable the operation to perform.
S
Stephen Connolly 已提交
1296 1297
     * @return {@code true} if the lock was available and the operation was performed.
     * @since 1.618
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
     */
    protected boolean _tryWithLock(Runnable runnable) {
        if (lock.tryLock()) {
            try {
                runnable.run();
            } finally {
                lock.unlock();
            }
            return true;
        } else {
            return false;
        }
    }

1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
    /**
     * 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
     */
1323 1324 1325 1326 1327 1328 1329
    protected <V, T extends Throwable> V _withLock(hudson.remoting.Callable<V, T> callable) throws T {
        lock.lock();
        try {
            return callable.call();
        } finally {
            lock.unlock();
        }
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
    }

    /**
     * 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
     */
1342 1343 1344 1345 1346 1347 1348
    protected <V> V _withLock(java.util.concurrent.Callable<V> callable) throws Exception {
        lock.lock();
        try {
            return callable.call();
        } finally {
            lock.unlock();
        }
1349 1350
    }

K
kohsuke 已提交
1351
    /**
K
kohsuke 已提交
1352
     * Queue maintenance.
1353
     *
1354
     * <p>
1355
     * Move projects between {@link #waitingList}, {@link #blockedProjects}, {@link #buildables}, and {@link #pendings}
K
kohsuke 已提交
1356
     * appropriately.
1357 1358 1359 1360
     *
     * <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.),
1361
     * and it also gets invoked periodically (see {@link Queue.MaintainTask}.)
K
kohsuke 已提交
1362
     */
1363 1364
    public void maintain() {
        lock.lock();
1365
        try { try {
1366 1367

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

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

S
Grammar  
Stephen Connolly 已提交
1372
            {// update parked (and identify any pending items whose executor has disappeared)
1373 1374 1375
                List<BuildableItem> lostPendings = new ArrayList<BuildableItem>(pendings);
                for (Computer c : Jenkins.getInstance().getComputers()) {
                    for (Executor e : c.getExecutors()) {
1376 1377 1378 1379 1380 1381 1382
                        if (e.isInterrupted()) {
                            // JENKINS-28840 we will deadlock if we try to touch this executor while interrupt flag set
                            // we need to clear lost pendings as we cannot know what work unit was on this executor
                            // while it is interrupted. (All this dancing is a result of Executor extending Thread)
                            lostPendings.clear(); // we'll get them next time around when the flag is cleared.
                            continue;
                        }
1383 1384 1385 1386 1387 1388 1389
                        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 已提交
1390 1391
                    }
                }
1392 1393 1394 1395 1396 1397 1398 1399 1400
                // 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 已提交
1401 1402
            }

1403
            final QueueSorter s = sorter;
K
Kohsuke Kawaguchi 已提交
1404

1405
            {// blocked -> buildable
1406
                // copy as we'll mutate the list and we want to process in a potentially different order
1407
                List<BlockedItem> blockedItems = new ArrayList<>(blockedProjects.values());
1408 1409 1410 1411 1412 1413 1414
                // if facing a cycle of blocked tasks, ensure we process in the desired sort order
                if (s != null) {
                    s.sortBlockedItems(blockedItems);
                } else {
                    Collections.sort(blockedItems, QueueSorter.DEFAULT_BLOCKED_ITEM_COMPARATOR);
                }
                for (BlockedItem p : blockedItems) {
1415 1416 1417 1418 1419 1420
                    if (!isBuildBlocked(p) && allowNewBuildableTask(p.task)) {
                        // ready to be executed
                        Runnable r = makeBuildable(new BuildableItem(p));
                        if (r != null) {
                            p.leave(this);
                            r.run();
1421 1422 1423 1424
                            // JENKINS-28926 we have removed a task from the blocked projects and added to building
                            // thus we should update the snapshot so that subsequent blocked projects can correctly
                            // determine if they are blocked by the lucky winner
                            updateSnapshot();
1425
                        }
1426
                    }
1427
                }
K
kohsuke 已提交
1428 1429
            }

1430 1431 1432
            // waitingList -> buildable/blocked
            while (!waitingList.isEmpty()) {
                WaitingItem top = peek();
K
kohsuke 已提交
1433

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

1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
                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);
                    }
1447
                } else {
1448 1449
                    // this can't be built now because another build is in progress
                    // set this project aside.
1450 1451
                    new BlockedItem(top).enter(this);
                }
K
kohsuke 已提交
1452
            }
1453

1454 1455
            if (s != null)
                s.sortBuildableItems(buildables);
1456 1457 1458 1459
            
            // Ensure that identification of blocked tasks is using the live state: JENKINS-27708 & JENKINS-27871
            updateSnapshot();
            
1460 1461 1462 1463 1464 1465 1466 1467
            // 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);
1468 1469 1470
                    // JENKINS-28926 we have moved an unblocked task into the blocked state, update snapshot
                    // so that other buildables which might have been blocked by this can see the state change
                    updateSnapshot();
1471 1472
                    continue;
                }
1473

1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
                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;
                }
1489

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

1494 1495 1496 1497 1498
                p.leave(this);
                if (!wuc.getWorkUnits().isEmpty())
                    makePending(p);
                else
                    LOGGER.log(Level.FINE, "BuildableItem {0} with empty work units!?", p);
1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
                                
                // Ensure that identification of blocked tasks is using the live state: JENKINS-27708 & JENKINS-27871
                // The creation of a snapshot itself should be relatively cheap given the expected rate of
                // job execution. You probably would need 100's of jobs starting execution every iteration
                // of maintain() before this could even start to become an issue and likely the calculation
                // of isBuildBlocked(p) will become a bottleneck before updateSnapshot() will. Additionally
                // since the snapshot itself only ever has at most one reference originating outside of the stack
                // it should remain in the eden space and thus be cheap to GC.
                // See https://issues.jenkins-ci.org/browse/JENKINS-27708?focusedCommentId=225819&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-225819
                // or https://issues.jenkins-ci.org/browse/JENKINS-27708?focusedCommentId=225906&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-225906
                // for alternative fixes of this issue.
                updateSnapshot();
1511
            }
1512
        } finally { updateSnapshot(); } } finally {
1513
            lock.unlock();
1514
        }
K
kohsuke 已提交
1515 1516
    }

1517 1518 1519 1520 1521 1522 1523 1524
    /**
     * 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)) {
1525
            Jenkins h = Jenkins.getInstance();
1526 1527
            Map<Node,Integer> hashSource = new HashMap<Node, Integer>(h.getNodes().size());

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

            for (Node n : h.getNodes()) {
1532
                hashSource.put(n, n.getNumExecutors() * 100);
1533 1534
            }

1535 1536
            ConsistentHash<Node> hash = new ConsistentHash<Node>(NODE_HASH);
            hash.addAll(hashSource);
1537

1538
            Label lbl = p.getAssignedLabel();
1539
            for (Node n : hash.list(p.task.getFullDisplayName())) {
1540
                final Computer c = n.toComputer();
K
kohsuke 已提交
1541
                if (c==null || c.isOffline())    continue;
1542
                if (lbl!=null && !lbl.contains(n))  continue;
1543
                if (n.canTake(p) != null) continue;
1544 1545 1546 1547 1548 1549 1550
                return new Runnable() {
                    @Override public void run() {
                        c.startFlyWeightTask(new WorkUnitContext(p).createWorkUnit(p.task));
                        makePending(p);
                    }
                };
            }
1551 1552
            }
            // if the execution get here, it means we couldn't schedule it anywhere.
1553 1554 1555 1556 1557 1558 1559
            return null;
        } else { // regular heavyweight task
            return new Runnable() {
                @Override public void run() {
                    p.enter(Queue.this);
                }
            };
1560 1561 1562
        }
    }

1563 1564 1565 1566 1567 1568 1569

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

1570
    private boolean makePending(BuildableItem p) {
1571
        // LOGGER.info("Making "+p.task+" pending"); // REMOVE
1572 1573 1574 1575
        p.isPending = true;
        return pendings.add(p);
    }

1576
    /** @deprecated Use {@link #isBlockedByShutdown} instead. */
1577
    @Deprecated
1578
    public static boolean ifBlockedByHudsonShutdown(Task task) {
1579 1580 1581 1582 1583 1584 1585
        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}
1586
     * @since 1.598
1587 1588
     */
    public static boolean isBlockedByShutdown(Task task) {
1589
        return Jenkins.getInstance().isQuietingDown() && !(task instanceof NonBlockingTask);
1590 1591
    }

1592 1593 1594 1595
    public Api getApi() {
        return new Api(this);
    }

K
kohsuke 已提交
1596 1597 1598 1599 1600 1601
    /**
     * Marks {@link Task}s that are not persisted.
     * @since 1.311
     */
    public interface TransientTask extends Task {}

1602 1603 1604 1605 1606 1607 1608
    /**
     * Marks {@link Task}s that do not consume {@link Executor}.
     * @see OneOffExecutor
     * @since 1.318
     */
    public interface FlyweightTask extends Task {}

K
kohsuke 已提交
1609
    /**
1610
     * Marks {@link Task}s that are not affected by the {@linkplain Jenkins#isQuietingDown()}  quieting down},
K
kohsuke 已提交
1611
     * because these tasks keep other tasks executing.
1612
     * @see #isBlockedByShutdown
1613
     * @since 1.336
K
kohsuke 已提交
1614 1615 1616
     */
    public interface NonBlockingTask extends Task {}

K
kohsuke 已提交
1617 1618
    /**
     * Task whose execution is controlled by the queue.
1619
     *
1620
     * <p>
K
kohsuke 已提交
1621 1622 1623
     * {@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.
1624 1625 1626
     *
     * <p>
     * Pending {@link Task}s are persisted when Hudson shuts down, so
K
kohsuke 已提交
1627 1628
     * it needs to be persistable via XStream. To create a non-persisted
     * transient Task, extend {@link TransientTask} marker interface.
1629 1630 1631 1632 1633
     *
     * <p>
     * Plugins are encouraged to extend from {@link AbstractQueueTask}
     * instead of implementing this interface directly, to maintain
     * compatibility with future changes to this interface.
1634 1635 1636 1637 1638 1639
     *
     * <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 已提交
1640
     */
1641
    public interface Task extends ModelObject, SubTask {
1642 1643 1644
        /**
         * Returns true if the execution should be blocked
         * for temporary reasons.
1645 1646
         *
         * <p>
1647
         * Short-hand for {@code getCauseOfBlockage()!=null}.
1648 1649 1650 1651
         */
        boolean isBuildBlocked();

        /**
1652 1653
         * @deprecated as of 1.330
         *      Use {@link CauseOfBlockage#getShortDescription()} instead.
1654
         */
1655
        @Deprecated
1656 1657
        String getWhyBlocked();

1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
        /**
         * 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();

1671
        /**
K
kohsuke 已提交
1672
         * Unique name of this task.
K
kohsuke 已提交
1673
         *
K
kohsuke 已提交
1674 1675
         * <p>
         * This method is no longer used, left here for compatibility. Just return {@link #getDisplayName()}.
1676 1677 1678
         */
        String getName();

1679 1680 1681 1682 1683
        /**
         * @see hudson.model.Item#getFullDisplayName()
         */
        String getFullDisplayName();

1684 1685 1686 1687 1688 1689 1690
        /**
         * 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 已提交
1691 1692 1693 1694

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

1699
        /**
K
kohsuke 已提交
1700 1701 1702 1703 1704 1705 1706 1707
         * 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 '/'.
1708 1709
         */
        String getUrl();
1710

1711
        /**
K
Kohsuke Kawaguchi 已提交
1712 1713
         * True if the task allows concurrent builds, where the same {@link Task} is executed
         * by multiple executors concurrently on the same or different nodes.
1714 1715
         *
         * @since 1.338
1716 1717
         */
        boolean isConcurrentBuild();
1718

1719
        /**
1720
         * Obtains the {@link SubTask}s that constitute this task.
1721
         *
1722
         * <p>
1723 1724 1725
         * 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.
1726
         *
1727
         * <p>
1728
         * At least size 1.
1729
         *
1730 1731
         * <p>
         * Since this is a newly added method, the invocation may results in {@link AbstractMethodError}.
1732
         * Use {@link Tasks#getSubTasksOf(Queue.Task)} that avoids this.
1733
         *
M
mindless 已提交
1734
         * @since 1.377
1735
         */
1736
        Collection<? extends SubTask> getSubTasks();
1737 1738 1739 1740 1741 1742 1743

        /**
         * 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
1744
         * based on whether this {@link Authentication} is allowed to use them.
1745 1746 1747
         *
         * <p>
         * This method was added to an interface after it was created, so plugins built against
1748
         * older versions of Jenkins may not have this method implemented. Called private method _getDefaultAuthenticationOf(Task) on {@link Tasks}
1749 1750 1751 1752
         * to avoid {@link AbstractMethodError}.
         *
         * @since 1.520
         * @see QueueItemAuthenticator
1753
         * @see Tasks#getDefaultAuthenticationOf(Queue.Task)
1754 1755
         */
        @Nonnull Authentication getDefaultAuthentication();
1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774

        /**
         * 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);
1775 1776
    }

1777
    /**
M
mindless 已提交
1778
     * Represents the real meat of the computation run by {@link Executor}.
1779 1780 1781 1782 1783
     *
     * <h2>Views</h2>
     * <p>
     * Implementation must have <tt>executorCell.jelly</tt>, which is
     * used to render the HTML that indicates this executable is executing.
1784
     */
1785 1786 1787
    public interface Executable extends Runnable {
        /**
         * Task from which this executable was created.
1788 1789
         *
         * <p>
M
mindless 已提交
1790
         * Since this method went through a signature change in 1.377, the invocation may results in
1791
         * {@link AbstractMethodError}.
1792
         * Use {@link Executables#getParentOf(Queue.Executable)} that avoids this.
1793
         */
1794
        @Nonnull SubTask getParent();
1795 1796

        /**
1797 1798
         * Called by {@link Executor} to perform the task.
         * @throws AsynchronousExecution if you would like to continue without consuming a thread
1799
         */
1800
        @Override void run() throws AsynchronousExecution;
1801

1802 1803 1804
        /**
         * Estimate of how long will it take to execute this executable.
         * Measured in milliseconds.
1805
         *
1806
         * Please, consider using {@link Executables#getEstimatedDurationFor(Queue.Executable)}
1807
         * to protected against AbstractMethodErrors!
1808 1809 1810 1811 1812
         *
         * @return -1 if it's impossible to estimate.
         * @since 1.383
         */
        long getEstimatedDuration();
1813 1814 1815 1816

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

K
kohsuke 已提交
1820 1821 1822
    /**
     * Item in a queue.
     */
1823
    @ExportedBean(defaultVisibility = 999)
1824
    public static abstract class Item extends Actionable {
1825 1826 1827

        private final long id;

1828
        /**
1829 1830 1831 1832
         * 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
1833
         * @since 1.601
1834
         */
1835
        @Exported
1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
        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;
        }

1851

1852
		/**
K
kohsuke 已提交
1853 1854
         * Project to be built.
         */
1855
        @Exported
1856
        public final Task task;
1857

1858
        private /*almost final*/ transient FutureImpl future;
1859

1860
        private final long inQueueSince;
1861

1862
        /**
1863 1864 1865
         * Build is blocked because another build is in progress,
         * required {@link Resource}s are not available, or otherwise blocked
         * by {@link Task#isBuildBlocked()}.
1866
         */
K
kohsuke 已提交
1867
        @Exported
1868
        public boolean isBlocked() { return this instanceof BlockedItem; }
1869 1870 1871 1872 1873 1874

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

1878 1879 1880 1881 1882
        /**
         * True if the item is starving for an executor for too long.
         */
        @Exported
        public boolean isStuck() { return false; }
1883

1884 1885 1886 1887 1888 1889 1890 1891
        /**
         * Since when is this item in the queue.
         * @return Unix timestamp
         */
        @Exported
        public long getInQueueSince() {
            return this.inQueueSince;
        }
1892

C
Christoph Kutzinski 已提交
1893 1894 1895 1896 1897
        /**
         * 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() {
1898 1899 1900
            long duration = System.currentTimeMillis() - this.inQueueSince;
            return Util.getTimeSpanString(duration);
        }
1901

1902 1903 1904
        /**
         * Can be used to wait for the completion (either normal, abnormal, or cancellation) of the {@link Task}.
         * <p>
1905
         * Just like {@link #getId()}, the same object tracks various stages of the queue.
1906
         */
K
Kohsuke Kawaguchi 已提交
1907 1908
        @WithBridgeMethods(Future.class)
        public QueueTaskFuture<Executable> getFuture() { return future; }
1909

1910 1911 1912 1913
        /**
         * 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.
1914
         *
1915 1916 1917
         * <p>
         * This code takes {@link LabelAssignmentAction} into account, then fall back to {@link SubTask#getAssignedLabel()}
         */
1918 1919 1920 1921 1922 1923 1924
        public Label getAssignedLabel() {
            for (LabelAssignmentAction laa : getActions(LabelAssignmentAction.class)) {
                Label l = laa.getAssignedLabel(task);
                if (l!=null)    return l;
            }
            return task.getAssignedLabel();
        }
1925

1926
        /**
1927
         * Test if the specified {@link SubTask} needs to be run on a node with a particular label.
1928
         * <p>
1929 1930 1931 1932 1933 1934
         * This method takes {@link LabelAssignmentAction} into account, the first
         * non-null assignment will be returned. 
         * Otherwise falls back to {@link SubTask#getAssignedLabel()}
         * @param st {@link SubTask} to be checked.
         * @return Required {@link Label}. Otherwise null, indicating it can run on anywhere.

1935
         */
1936
        public @CheckForNull Label getAssignedLabelFor(@Nonnull SubTask st) {
1937 1938 1939 1940 1941 1942
            for (LabelAssignmentAction laa : getActions(LabelAssignmentAction.class)) {
                Label l = laa.getAssignedLabel(st);
                if (l!=null)    return l;
            }
            return st.getAssignedLabel();
        }
1943

1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956
        /**
         * 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();
        }

1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
        @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();
        }

1967
        protected Item(Task task, List<Action> actions, long id, FutureImpl future) {
1968 1969
            this.task = task;
            this.id = id;
1970
            this.future = future;
1971 1972 1973
            this.inQueueSince = System.currentTimeMillis();
            for (Action action: actions) addAction(action);
        }
1974

1975
        protected Item(Task task, List<Action> actions, long id, FutureImpl future, long inQueueSince) {
1976 1977 1978 1979
            this.task = task;
            this.id = id;
            this.future = future;
            this.inQueueSince = inQueueSince;
1980 1981
            for (Action action: actions) addAction(action);
        }
1982

1983
        protected Item(Item item) {
1984
        	this(item.task, new ArrayList<Action>(item.getAllActions()), item.id, item.future, item.inQueueSince);
K
kohsuke 已提交
1985 1986
        }

1987 1988 1989 1990 1991
        /**
         * Returns the URL of this {@link Item} relative to the context path of Jenkins
         *
         * @return
         *      URL that ends with '/'.
1992
         * @since 1.519
1993 1994 1995 1996 1997 1998
         */
        @Exported
        public String getUrl() {
            return "queue/item/"+id+'/';
        }

1999
        /**
2000
         * Gets a human-readable status message describing why it's in the queue.
2001
         */
K
kohsuke 已提交
2002
        @Exported
2003 2004 2005 2006 2007
        public final String getWhy() {
            CauseOfBlockage cob = getCauseOfBlockage();
            return cob!=null ? cob.getShortDescription() : null;
        }

K
kohsuke 已提交
2008 2009 2010
        /**
         * Gets an object that describes why this item is in the queue.
         */
2011 2012
        public abstract CauseOfBlockage getCauseOfBlockage();

2013 2014 2015 2016 2017 2018
        /**
         * Gets a human-readable message about the parameters of this item
         * @return String
         */
        @Exported
        public String getParams() {
K
kohsuke 已提交
2019
        	StringBuilder s = new StringBuilder();
2020 2021 2022 2023
        	for (ParametersAction pa : getActions(ParametersAction.class)) {
                for (ParameterValue p : pa.getParameters()) {
                    s.append('\n').append(p.getShortDescription());
                }
2024
        	}
K
kohsuke 已提交
2025
        	return s.toString();
2026
        }
2027 2028 2029 2030 2031

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

2036 2037 2038 2039 2040 2041 2042 2043 2044 2045
        public String getDisplayName() {
			// TODO Auto-generated method stub
			return null;
		}

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

2046 2047
        /** @deprecated Use {@link #doCancelItem} instead. */
        @Deprecated
J
Jesse Glick 已提交
2048
        @RequirePOST
2049
        public HttpResponse doCancelQueue() throws IOException, ServletException {
2050
        	Jenkins.getInstance().getQueue().cancel(this);
2051
            return HttpResponses.forwardToPreviousPage();
2052
        }
2053

2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
        /**
         * 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() {
2066
            for (QueueItemAuthenticator auth : QueueItemAuthenticatorProvider.authenticators()) {
2067 2068 2069 2070
                Authentication a = auth.authenticate(this);
                if (a!=null)
                    return a;
            }
2071
            return Tasks.getDefaultAuthenticationOf(task, this);
2072 2073 2074
        }


2075 2076 2077 2078
        public Api getApi() {
            return new Api(this);
        }

2079
        private Object readResolve() {
2080
            this.future = new FutureImpl(task);
2081 2082
            return this;
        }
K
kohsuke 已提交
2083 2084 2085

        @Override
        public String toString() {
2086
            return getClass().getName() + ':' + task + ':' + id;
K
kohsuke 已提交
2087
        }
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101

        /**
         * 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 已提交
2102 2103 2104
         *
         * @return true
         *      if the item was successfully cancelled.
2105 2106 2107
         */
        /*package*/ boolean cancel(Queue q) {
            boolean r = leave(q);
K
Kohsuke Kawaguchi 已提交
2108 2109 2110 2111 2112
            if (r) {
                future.setAsCancelled();
                LeftItem li = new LeftItem(this);
                li.enter(q);
            }
2113 2114 2115
            return r;
        }

2116
    }
2117

2118 2119 2120
    /**
     * An optional interface for actions on Queue.Item.
     * Lets the action cooperate in queue management.
2121
     *
2122
     * @since 1.300-ish.
2123 2124 2125
     */
    public interface QueueAction extends Action {
    	/**
2126
    	 * Returns whether the new item should be scheduled.
2127 2128
    	 * An action should return true if the associated task is 'different enough' to warrant a separate execution.
    	 */
2129
	    boolean shouldSchedule(List<Action> actions);
2130
    }
2131

2132
    /**
K
kohsuke 已提交
2133 2134 2135 2136 2137
     * 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
2138
     * to the queue, and the task will never get executed.
2139 2140
     *
     * <p>
2141 2142
     * 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.
2143 2144 2145 2146 2147
     *
     * @since 1.316
     */
    public static abstract class QueueDecisionHandler implements ExtensionPoint {
    	/**
K
kohsuke 已提交
2148
    	 * Returns whether the new item should be scheduled.
2149 2150 2151 2152
         *
         * @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.
2153 2154
    	 */
    	public abstract boolean shouldSchedule(Task p, List<Action> actions);
2155

2156 2157 2158 2159
    	/**
    	 * All registered {@link QueueDecisionHandler}s
    	 */
    	public static ExtensionList<QueueDecisionHandler> all() {
2160
    		return ExtensionList.lookup(QueueDecisionHandler.class);
2161 2162
    	}
    }
2163

2164 2165 2166
    /**
     * {@link Item} in the {@link Queue#waitingList} stage.
     */
2167
    public static final class WaitingItem extends Item implements Comparable<WaitingItem> {
2168
	private static final AtomicLong COUNTER = new AtomicLong(0);
2169

2170 2171 2172 2173 2174
        /**
         * This item can be run after this time.
         */
        @Exported
        public Calendar timestamp;
2175

2176
        public WaitingItem(Calendar timestamp, Task project, List<Action> actions) {
2177
            super(project, actions, COUNTER.incrementAndGet(), new FutureImpl(project));
2178 2179
            this.timestamp = timestamp;
        }
2180

2181 2182 2183 2184
        static int getCurrentCounterValue() {
            return COUNTER.intValue();
        }

2185 2186 2187 2188
        public int compareTo(WaitingItem that) {
            int r = this.timestamp.getTime().compareTo(that.timestamp.getTime());
            if (r != 0) return r;

2189 2190 2191 2192 2193 2194 2195
            if (this.getId() < that.getId()) {
                return -1;
            } else if (this.getId() == that.getId()) {
                return 0;
            } else {
                return 1;
            }
2196 2197
        }

2198
        public CauseOfBlockage getCauseOfBlockage() {
2199
            long diff = timestamp.getTimeInMillis() - System.currentTimeMillis();
2200
            if (diff > 0)
2201
                return CauseOfBlockage.fromMessage(Messages._Queue_InQuietPeriod(Util.getTimeSpanString(diff)));
2202
            else
2203
                return CauseOfBlockage.fromMessage(Messages._Queue_Unknown());
2204
        }
2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236

        @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;
        }


2237
    }
K
kohsuke 已提交
2238

2239 2240 2241
    /**
     * Common part between {@link BlockedItem} and {@link BuildableItem}.
     */
2242
    public static abstract class NotWaitingItem extends Item {
2243 2244 2245 2246 2247 2248 2249
        /**
         * When did this job exit the {@link Queue#waitingList} phase?
         */
        @Exported
        public final long buildableStartMilliseconds;

        protected NotWaitingItem(WaitingItem wi) {
2250
            super(wi);
2251
            buildableStartMilliseconds = System.currentTimeMillis();
K
kohsuke 已提交
2252
        }
2253

2254
        protected NotWaitingItem(NotWaitingItem ni) {
2255
            super(ni);
2256
            buildableStartMilliseconds = ni.buildableStartMilliseconds;
2257
        }
2258
    }
2259

2260 2261 2262 2263 2264 2265 2266
    /**
     * {@link Item} in the {@link Queue#blockedProjects} stage.
     */
    public final class BlockedItem extends NotWaitingItem {
        public BlockedItem(WaitingItem wi) {
            super(wi);
        }
2267

2268 2269 2270 2271
        public BlockedItem(NotWaitingItem ni) {
            super(ni);
        }

2272
        public CauseOfBlockage getCauseOfBlockage() {
2273 2274 2275
            ResourceActivity r = getBlockingActivity(task);
            if (r != null) {
                if (r == task) // blocked by itself, meaning another build is in progress
2276 2277
                    return CauseOfBlockage.fromMessage(Messages._Queue_InProgress());
                return CauseOfBlockage.fromMessage(Messages._Queue_BlockedBy(r.getDisplayName()));
2278
            }
2279

2280 2281 2282 2283 2284
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all()) {
                CauseOfBlockage cause = d.canRun(this);
                if (cause != null)
                    return cause;
            }
2285

2286
            return task.getCauseOfBlockage();
2287
        }
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

        /*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;
        }
2317
    }
2318

2319 2320 2321
    /**
     * {@link Item} in the {@link Queue#buildables} stage.
     */
2322
    public final static class BuildableItem extends NotWaitingItem {
2323 2324 2325 2326 2327
        /**
         * Set to true when this is added to the {@link Queue#pendings} list.
         */
        private boolean isPending;

2328 2329 2330 2331 2332 2333 2334 2335
        public BuildableItem(WaitingItem wi) {
            super(wi);
        }

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

2336
        public CauseOfBlockage getCauseOfBlockage() {
2337
            Jenkins jenkins = Jenkins.getInstance();
2338
            if(isBlockedByShutdown(task))
2339
                return CauseOfBlockage.fromMessage(Messages._Queue_HudsonIsAboutToShutDown());
K
kohsuke 已提交
2340

2341
            Label label = getAssignedLabel();
2342 2343
            List<Node> allNodes = jenkins.getNodes();
            if (allNodes.isEmpty())
2344
                label = null;    // no master/slave. pointless to talk about nodes
2345

2346
            if (label != null) {
K
Kohsuke Kawaguchi 已提交
2347
                Set<Node> nodes = label.getNodes();
2348
                if (label.isOffline()) {
2349
                    if (nodes.size() != 1)      return new BecauseLabelIsOffline(label);
2350
                    else                        return new BecauseNodeIsOffline(nodes.iterator().next());
K
Kohsuke Kawaguchi 已提交
2351 2352 2353
                } else {
                    if (nodes.size() != 1)      return new BecauseLabelIsBusy(label);
                    else                        return new BecauseNodeIsBusy(nodes.iterator().next());
2354
                }
K
Kohsuke Kawaguchi 已提交
2355 2356
            } else {
                return CauseOfBlockage.createNeedsMoreExecutor(Messages._Queue_WaitingForNextAvailableExecutor());
2357 2358
            }
        }
2359 2360 2361

        @Override
        public boolean isStuck() {
2362
            Label label = getAssignedLabel();
2363 2364 2365 2366 2367 2368 2369
            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) {
2370
                // if we were running elsewhere, we would have done this build ten times.
2371
                return elapsed > Math.max(d,60000L)*10;
2372 2373
            } else {
                // more than a day in the queue
2374
                return TimeUnit2.MILLISECONDS.toHours(elapsed)>24;
2375 2376
            }
        }
2377 2378 2379 2380 2381

        @Exported
        public boolean isPending() {
            return isPending;
        }
2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411

        @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 已提交
2412 2413
    }

2414 2415 2416
    /**
     * {@link Item} in the {@link Queue#leftItems} stage. These are items that had left the queue
     * by either began executing or by getting cancelled.
2417 2418
     *
     * @since 1.519
2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448
     */
    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
2449
        public @CheckForNull Executable getExecutable() {
2450 2451 2452 2453 2454 2455 2456 2457 2458 2459
            return outcome!=null ? outcome.getPrimaryWorkUnit().getExecutable() : null;
        }

        /**
         * Is this representing a cancelled item?
         */
        @Exported
        public boolean isCancelled() {
            return outcome==null;
        }
2460 2461 2462

        @Override
        void enter(Queue q) {
2463
            q.leftItems.put(getId(),this);
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478
            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;
        }
2479 2480
    }

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

2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498
    /**
     * 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) {
2499
                Object item = Jenkins.getInstance().getItemByFullName(string);
2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521
                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]);
2522
				Job<?,?> job = (Job<?,?>) Jenkins.getInstance().getItemByFullName(projectName);
2523 2524
                if(job==null)  throw new NoSuchElementException("No such job exists: "+projectName);
				Run<?,?> run = job.getBuildByNumber(buildNumber);
K
kohsuke 已提交
2525
                if(run==null)  throw new NoSuchElementException("No such build: "+string);
2526 2527 2528 2529 2530 2531 2532 2533 2534
				return run;
			}

			@Override
			public String toString(Object object) {
				Run<?,?> run = (Run<?,?>) object;
				return run.getParent().getFullName() + "#" + run.getNumber();
			}
        });
2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554

        /**
         * 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";
			}
        });
2555 2556
    }

2557 2558 2559 2560 2561 2562 2563 2564 2565
    /**
     * 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 已提交
2566
        }
2567

K
Kohsuke Kawaguchi 已提交
2568
        private void periodic() {
J
Jesse Glick 已提交
2569
            long interval = 5000;
2570
            Timer.get().scheduleWithFixedDelay(this, interval, interval, TimeUnit.MILLISECONDS);
2571 2572 2573 2574
        }

        protected void doRun() {
            Queue q = queue.get();
2575
            if (q != null)
2576 2577 2578 2579 2580
                q.maintain();
            else
                cancel();
        }
    }
2581

2582
    /**
2583
     * {@link ArrayList} of {@link Item} with more convenience methods.
2584
     */
2585
    private class ItemList<T extends Item> extends ArrayList<T> {
2586 2587
    	public T get(Task task) {
    		for (T item: this) {
2588
    			if (item.task.equals(task)) {
2589 2590 2591 2592 2593
    				return item;
    			}
    		}
    		return null;
    	}
2594

2595 2596 2597
    	public List<T> getAll(Task task) {
    		List<T> result = new ArrayList<T>();
    		for (T item: this) {
2598
    			if (item.task.equals(task)) {
2599 2600 2601 2602 2603
    				result.add(item);
    			}
    		}
    		return result;
    	}
2604

2605 2606 2607
    	public boolean containsKey(Task task) {
    		return get(task) != null;
    	}
2608

2609 2610 2611 2612
    	public T remove(Task task) {
    		Iterator<T> it = iterator();
    		while (it.hasNext()) {
    			T t = it.next();
2613
    			if (t.task.equals(task)) {
2614 2615 2616 2617 2618 2619
    				it.remove();
    				return t;
    			}
    		}
    		return null;
    	}
2620

2621
    	public void put(Task task, T item) {
2622
    		assert item.task.equals(task);
2623 2624
    		add(item);
    	}
2625

2626 2627 2628
    	public ItemList<T> values() {
    		return this;
    	}
2629 2630 2631 2632 2633

        /**
         * Works like {@link #remove(Task)} but also marks the {@link Item} as cancelled.
         */
        public T cancel(Task p) {
2634 2635
            T x = get(p);
            if(x!=null) x.cancel(Queue.this);
2636 2637 2638 2639
            return x;
        }

        public void cancelAll() {
2640 2641 2642 2643
            for (T t : new ArrayList<T>(this))
                t.cancel(Queue.this);

            clear();    // just to be sure
2644
        }
2645
    }
2646

2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660
    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);
        }
    }
2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705
    
    private static class LockedRunnable implements Runnable  {
        private final Runnable delegate;

        private LockedRunnable(Runnable delegate) {
            this.delegate = delegate;
        }

        @Override
        public void run() {
            withLock(delegate);
        }
    }

    private static class LockedJUCCallable<V> implements java.util.concurrent.Callable<V> {
        private final java.util.concurrent.Callable<V> delegate;

        private LockedJUCCallable(java.util.concurrent.Callable<V> delegate) {
            this.delegate = delegate;
        }

        @Override
        public V call() throws Exception {
            return withLock(delegate);
        }
    }

    private static class LockedHRCallable<V,T extends Throwable> implements hudson.remoting.Callable<V,T> {
        private static final long serialVersionUID = 1L;
        private final hudson.remoting.Callable<V,T> delegate;

        private LockedHRCallable(hudson.remoting.Callable<V,T> delegate) {
            this.delegate = delegate;
        }

        @Override
        public V call() throws T {
            return withLock(delegate);
        }

        @Override
        public void checkRoles(RoleChecker checker) throws SecurityException {
            delegate.checkRoles(checker);
        }
    }
2706

2707 2708
    @CLIResolver
    public static Queue getInstance() {
2709
        return Jenkins.getInstance().getQueue();
2710
    }
K
kohsuke 已提交
2711 2712 2713 2714 2715

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