Queue.java 57.9 KB
Newer Older
K
kohsuke 已提交
1 2 3
/*
 * The MIT License
 * 
M
mindless 已提交
4 5
 * Copyright (c) 2004-2010, Sun Microsystems, Inc., Kohsuke Kawaguchi,
 * Stephen Connolly, Tom Huybrechts, InfraDNA, Inc.
K
kohsuke 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
K
kohsuke 已提交
25 26
package hudson.model;

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

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

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

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

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

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.converters.basic.AbstractSingleValueConverter;

K
kohsuke 已提交
106 107
/**
 * Build queue.
108 109
 *
 * <p>
110 111
 * This class implements the core scheduling logic. {@link Task} represents the executable
 * task that are placed in the queue. While in the queue, it's wrapped into {@link Item}
112
 * so that we can keep track of additional data used for deciding what to exeucte when.
113 114
 *
 * <p>
115 116 117 118 119 120
 * Items in queue goes through several stages, as depicted below:
 * <pre>
 * (enter) --> waitingList --+--> blockedProjects
 *                           |        ^
 *                           |        |
 *                           |        v
121
 *                           +--> buildables ---> pending ---> (executed)
122
 * </pre>
123 124
 *
 * <p>
125 126 127
 * In addition, at any stage, an item can be removed from the queue (for example, when the user
 * cancels a job in the queue.) See the corresponding field for their exact meanings.
 *
K
kohsuke 已提交
128 129
 * @author Kohsuke Kawaguchi
 */
130
@ExportedBean
131
public class Queue extends ResourceController implements Saveable {
K
kohsuke 已提交
132
    /**
133
     * Items that are waiting for its quiet period to pass.
134 135
     *
     * <p>
K
kohsuke 已提交
136 137 138
     * This consists of {@link Item}s that cannot be run yet
     * because its time has not yet come.
     */
139
    private final Set<WaitingItem> waitingList = new TreeSet<WaitingItem>();
K
kohsuke 已提交
140 141

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

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

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

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

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

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

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

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

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

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

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

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

            return isAvailable();
        }

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

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

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

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

241
    private volatile transient LoadBalancer loadBalancer;
242

243
    private volatile transient QueueSorter sorter;
244

245 246
    public Queue(LoadBalancer loadBalancer) {
        this.loadBalancer =  loadBalancer.sanitize();
247 248 249 250 251
        // if all the executors are busy doing something, then the queue won't be maintained in
        // timely fashion, so use another thread to make sure it happens.
        new MaintainTask(this);
    }

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

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

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

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

K
kohsuke 已提交
269 270 271 272 273
    /**
     * Loads the queue contents that was {@link #save() saved}.
     */
    public synchronized void load() {
        try {
K
TAB->WS  
kohsuke 已提交
274
            // first try the old format
K
kohsuke 已提交
275
            File queueFile = getQueueFile();
K
kohsuke 已提交
276 277
            if (queueFile.exists()) {
                BufferedReader in = new BufferedReader(new InputStreamReader(new FileInputStream(queueFile)));
278 279 280 281 282 283 284 285 286
                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 已提交
287 288 289 290 291 292
                }
                // discard the queue file now that we are done
                queueFile.delete();
            } else {
                queueFile = getXMLQueueFile();
                if (queueFile.exists()) {
293
                    List list = (List) new XmlFile(XSTREAM, queueFile).read();
K
kohsuke 已提交
294 295 296
                    int maxId = 0;
                    for (Object o : list) {
                        if (o instanceof Task) {
297
                            // backward compatibility
298
                            schedule((Task)o, 0);
K
kohsuke 已提交
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
                        } else if (o instanceof Item) {
                            Item item = (Item)o;
                            if(item.task==null)
                                continue;   // botched persistence. throw this one away

                            maxId = Math.max(maxId, item.id);
                            if (item instanceof WaitingItem) {
                                waitingList.add((WaitingItem) item);
                            } else if (item instanceof BlockedItem) {
                                blockedProjects.put(item.task, (BlockedItem) item);
                            } else if (item instanceof BuildableItem) {
                                buildables.add((BuildableItem) item);
                            } else {
                                throw new IllegalStateException("Unknown item type! " + item);
                            }
                        } // this conveniently ignores null
K
TAB->WS  
kohsuke 已提交
315
                    }
K
kohsuke 已提交
316
                    WaitingItem.COUNTER.set(maxId);
317 318 319 320 321 322 323 324 325

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

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

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

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

K
kohsuke 已提交
370
    private File getQueueFile() {
371
        return new File(Jenkins.getInstance().getRootDir(), "queue.txt");
K
TAB->WS  
kohsuke 已提交
372
    }
K
kohsuke 已提交
373

374
    /*package*/ File getXMLQueueFile() {
375
        return new File(Jenkins.getInstance().getRootDir(), "queue.xml");
K
TAB->WS  
kohsuke 已提交
376
    }
K
kohsuke 已提交
377

378 379 380 381 382 383 384 385
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(AbstractProject)}
     */
    public boolean add(AbstractProject p) {
        return schedule(p)!=null;
    }

K
kohsuke 已提交
386 387
    /**
     * Schedule a new build for this project.
388
     *
389 390 391
     * @return true if the project is actually added to the queue.
     *         false if the queue contained it and therefore the add()
     *         was noop
K
kohsuke 已提交
392
     */
393 394
    public WaitingItem schedule(AbstractProject p) {
        return schedule(p, p.getQuietPeriod());
395 396 397 398
    }

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

    /**
     * Schedules an execution of a task.
     *
414
     * @param actions
K
kohsuke 已提交
415 416 417
     *      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.
418
     *      For the convenience of the caller, this list can contain null, and those will be silently ignored.
419 420 421 422 423 424 425 426 427 428
     * @since 1.311
     * @return
     *      null if this task is already in the queue and therefore the add operation was no-op.
     *      Otherwise indicates the {@link WaitingItem} object added, although the nature of the queue
     *      is that such {@link Item} only captures the state of the item at a particular moment,
     *      and by the time you inspect the object, some of its information can be already stale.
     *
     *      That said, one can still look at {@link WaitingItem#future}, {@link WaitingItem#id}, etc.
     */
    public synchronized WaitingItem schedule(Task p, int quietPeriod, List<Action> actions) {
429 430 431 432 433 434 435
        // remove nulls
        actions = new ArrayList<Action>(actions);
        for (Iterator<Action> itr = actions.iterator(); itr.hasNext();) {
            Action a =  itr.next();
            if (a==null)    itr.remove();
        }

K
kohsuke 已提交
436 437 438 439 440
    	for(QueueDecisionHandler h : QueueDecisionHandler.all())
    		if (!h.shouldSchedule(p, actions))
                return null;    // veto

        return scheduleInternal(p, quietPeriod, actions);
441
    }
442

443 444 445 446 447 448 449 450 451 452 453 454 455
    /**
     * Schedules an execution of a task.
     *
     * @since 1.311
     * @return
     *      null if this task is already in the queue and therefore the add operation was no-op.
     *      Otherwise indicates the {@link WaitingItem} object added, although the nature of the queue
     *      is that such {@link Item} only captures the state of the item at a particular moment,
     *      and by the time you inspect the object, some of its information can be already stale.
     *
     *      That said, one can still look at {@link WaitingItem#future}, {@link WaitingItem#id}, etc.
     */
    private synchronized WaitingItem scheduleInternal(Task p, int quietPeriod, List<Action> actions) {
K
kohsuke 已提交
456
        Calendar due = new GregorianCalendar();
457
    	due.add(Calendar.SECOND, quietPeriod);
458

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

476
    		// put the item in the queue
K
kohsuke 已提交
477 478 479 480 481
            WaitingItem added = new WaitingItem(due,p,actions);
    		waitingList.add(added);
            scheduleMaintenance();   // let an executor know that a new item is in the queue.
            return added;
    	}
K
kohsuke 已提交
482

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

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

        boolean queueUpdated = false;
        for(WaitingItem wi : Util.filter(duplicatesInQueue,WaitingItem.class)) {
            if(quietPeriod<=0) {
                // the user really wants to build now, and they mean NOW.
                // so let's pull in the timestamp if we can.
                if (wi.timestamp.before(due))
                    continue;
            } else {
                // otherwise we do the normal quiet period implementation
                if (wi.timestamp.after(due))
                    continue;
                // quiet period timer reset. start the period over again
            }

            // waitingList is sorted, so when we change a timestamp we need to maintain order
            waitingList.remove(wi);
            wi.timestamp = due;
            waitingList.add(wi);
            queueUpdated=true;
        }

        if (queueUpdated)   scheduleMaintenance();
        return null;
K
kohsuke 已提交
515
    }
516
    
517 518 519 520
    /**
     * @deprecated as of 1.311
     *      Use {@link #schedule(Task, int)} 
     */
521
    public synchronized boolean add(Task p, int quietPeriod) {
522
    	return schedule(p, quietPeriod)!=null;
523 524
    }

525 526 527 528 529 530
    public synchronized WaitingItem schedule(Task p, int quietPeriod) {
    	return schedule(p, quietPeriod, new Action[0]);
    }

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

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

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

    public synchronized boolean isEmpty() {
574
        return waitingList.isEmpty() && blockedProjects.isEmpty() && buildables.isEmpty() && pendings.isEmpty();
K
kohsuke 已提交
575 576
    }

577
    private synchronized WaitingItem peek() {
578
        return waitingList.iterator().next();
K
kohsuke 已提交
579 580 581 582
    }

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

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

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

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

636 637 638 639 640 641 642
    /**
     * Gets the snapshot of all {@link BuildableItem}s.
     */
    public synchronized List<BuildableItem> getPendingItems() {
        return new ArrayList<BuildableItem>(pendings.values());
    }

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

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

670 671 672 673 674 675 676 677 678 679
    /**
     * Is the given task currently pending execution?
     */
    public synchronized boolean isPending(Task t) {
        for (BuildableItem i : pendings)
            if (i.task.equals(t))
                return true;
        return false;
    }

K
kohsuke 已提交
680 681 682 683 684 685
    /**
     * How many {@link BuildableItem}s are assigned for the given label?
     */
    public synchronized int countBuildableItemsFor(Label l) {
        int r = 0;
        for (BuildableItem bi : buildables.values())
686
            if(bi.getAssignedLabel()==l)
K
kohsuke 已提交
687
                r++;
688
        for (BuildableItem bi : pendings.values())
689
            if(bi.getAssignedLabel()==l)
690
                r++;
K
kohsuke 已提交
691 692 693
        return r;
    }

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

710
        for (Item item : waitingList) {
711
            if (item.task == t)
K
kohsuke 已提交
712 713 714 715 716
                return item;
        }
        return null;
    }

717 718 719 720 721 722 723 724 725
    /**
     * Gets the information about the queue item for the given project.
     *
     * @return null if the project is not in the queue.
     */
    public synchronized List<Item> getItems(Task t) {
    	List<Item> result =new ArrayList<Item>();
    	result.addAll(blockedProjects.getAll(t));
    	result.addAll(buildables.getAll(t));
726
        result.addAll(pendings.getAll(t));
727 728 729 730 731 732 733
        for (Item item : waitingList) {
            if (item.task == t)
                result.add(item);
        }
        return result;
    }

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

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

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

764 765 766 767 768 769 770
        if (exec instanceof OneOffExecutor) {
            OneOffExecutor ooe = (OneOffExecutor) exec;
            final WorkUnit wu = ooe.getAssignedWorkUnit();
            pendings.remove(wu.context.item);
            return wu;
        }

K
kohsuke 已提交
771
        try {
772
            while (true) {
K
kohsuke 已提交
773 774 775
                final JobOffer offer = new JobOffer(exec);
                long sleep = -1;

776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
                // consider myself parked
                assert !parked.containsKey(exec);
                parked.put(exec, offer);

                // reuse executor thread to do a queue maintenance.
                // at the end of this we get all the buildable jobs
                // in the buildables field.
                maintain();

                // allocate buildable jobs to executors
                Iterator<BuildableItem> itr = buildables.iterator();
                while (itr.hasNext()) {
                    BuildableItem p = itr.next();

                    // one last check to make sure this build is not blocked.
791
                    if (isBuildBlocked(p)) {
K
kohsuke 已提交
792
                        itr.remove();
793 794
                        blockedProjects.put(p.task,new BlockedItem(p));
                        continue;
K
kohsuke 已提交
795 796
                    }

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

K
kohsuke 已提交
802 803
                    MappingWorksheet ws = new MappingWorksheet(p, candidates);
                    Mapping m = loadBalancer.map(p.task, ws);
804
                    if (m == null)
805 806 807 808
                        // if we couldn't find the executor that fits,
                        // just leave it in the buildables list and
                        // check if we can execute other projects
                        continue;
K
kohsuke 已提交
809

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

814
                    itr.remove();
815 816
                    if (!wuc.getWorkUnits().isEmpty())
                        pendings.add(p);
817 818 819 820 821 822 823 824 825 826 827
                }

                // we went over all the buildable projects and awaken
                // all the executors that got work to do. now, go to sleep
                // until this thread is awakened. If this executor assigned a job to
                // itself above, the block method will return immediately.

                if (!waitingList.isEmpty()) {
                    // wait until the first item in the queue is due
                    sleep = peek().timestamp.getTimeInMillis() - new GregorianCalendar().getTimeInMillis();
                    if (sleep < 100) sleep = 100;    // avoid wait(0)
K
kohsuke 已提交
828 829
                }

830
                if (sleep == -1)
K
kohsuke 已提交
831 832 833 834
                    offer.event.block();
                else
                    offer.event.block(sleep);

835 836 837 838 839
                // retract the offer object
                assert parked.get(exec) == offer;
                parked.remove(exec);

                // am I woken up because I have a project to build?
840
                if (offer.workUnit != null) {
841
                    // if so, just build it
842 843 844 845 846
                    LOGGER.fine("Pop returning " + offer.workUnit + " for " + exec.getName());

                    // TODO: I think this has to be done by the last executor that leaves the pop(), not by main executor
                    if (offer.workUnit.isMainWork())
                        pendings.remove(offer.workUnit.context.item);
847

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

            // since this executor might have been chosen for
            // maintenance, schedule another one. Worst case
            // we'll just run a pointless maintenance, and that's
            // fine.
            scheduleMaintenance();
K
kohsuke 已提交
865 866 867 868 869
        }
    }

    /**
     * Checks the queue and runs anything that can be run.
870 871
     *
     * <p>
K
kohsuke 已提交
872
     * When conditions are changed, this method should be invoked.
873
     * <p>
K
kohsuke 已提交
874 875 876 877 878 879 880
     * This wakes up one {@link Executor} so that it will maintain a queue.
     */
    public synchronized void scheduleMaintenance() {
        // this code assumes that after this method is called
        // no more executors will be offered job except by
        // the pop() code.
        for (Entry<Executor, JobOffer> av : parked.entrySet()) {
881
            if (av.getValue().workUnit == null) {
K
kohsuke 已提交
882 883 884 885 886 887
                av.getValue().event.signal();
                return;
            }
        }
    }

888
    /**
889 890
     * Checks if the given item should be prevented from entering into the {@link #buildables} state
     * and instead stay in the {@link #blockedProjects} state.
891
     */
892 893 894 895 896 897 898 899 900 901
    private boolean isBuildBlocked(Item i) {
        if (i.task.isBuildBlocked() || !canRun(i.task.getResourceList()) || !allowNewBuildableTask(i.task))
            return true;

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

        return false;
902 903
    }

904
    /**
905 906
     * Make sure we don't queue two tasks of the same project to be built
     * unless that project allows concurrent builds.
907
     */
908 909 910 911 912 913 914
    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
        }
915
        return !buildables.containsKey(t) && !pendings.containsKey(t);
916
    }
917

K
kohsuke 已提交
918
    /**
K
kohsuke 已提交
919
     * Queue maintenance.
920
     *
921
     * <p>
922
     * Move projects between {@link #waitingList}, {@link #blockedProjects}, and {@link #buildables}
K
kohsuke 已提交
923
     * appropriately.
924 925 926 927 928
     *
     * <p>
     * Jenkins internally invokes this method by itself whenever there's a change that can affect
     * the scheduling (such as new node becoming online, # of executors change, a task completes execution, etc.),
     * and it also gets invoked periodically (see {@link MaintainTask}.)
K
kohsuke 已提交
929
     */
930
    public synchronized void maintain() {
931 932
        if (LOGGER.isLoggable(Level.FINE))
            LOGGER.fine("Queue maintenance started " + this);
933

934
        // blocked -> buildable
935
        Iterator<BlockedItem> itr = blockedProjects.values().iterator();
936
        while (itr.hasNext()) {
937
            BlockedItem p = itr.next();
938
            if (!isBuildBlocked(p)) {
K
kohsuke 已提交
939
                // ready to be executed
K
kohsuke 已提交
940
                LOGGER.fine(p.task.getFullDisplayName() + " no longer blocked");
K
kohsuke 已提交
941
                itr.remove();
942
                makeBuildable(new BuildableItem(p));
K
kohsuke 已提交
943 944 945
            }
        }

946
        while (!waitingList.isEmpty()) {
947
            WaitingItem top = peek();
K
kohsuke 已提交
948

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

952
            waitingList.remove(top);
953
            Task p = top.task;
954
            if (!isBuildBlocked(top)) {
955
                // ready to be executed immediately
K
kohsuke 已提交
956
                LOGGER.fine(p.getFullDisplayName() + " ready to build");
957
                makeBuildable(new BuildableItem(top));
K
kohsuke 已提交
958
            } else {
959
                // this can't be built now because another build is in progress
K
kohsuke 已提交
960
                // set this project aside.
K
kohsuke 已提交
961
                LOGGER.fine(p.getFullDisplayName() + " is blocked");
962
                blockedProjects.put(p,new BlockedItem(top));
K
kohsuke 已提交
963 964
            }
        }
965 966 967 968

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

971
    private void makeBuildable(BuildableItem p) {
972
        if(Jenkins.FLYWEIGHT_SUPPORT && p.task instanceof FlyweightTask && !ifBlockedByHudsonShutdown(p.task)) {
973 974 975 976 977
            ConsistentHash<Node> hash = new ConsistentHash<Node>(new Hash<Node>() {
                public String hash(Node node) {
                    return node.getNodeName();
                }
            });
978
            Jenkins h = Jenkins.getInstance();
979 980 981
            hash.add(h, h.getNumExecutors()*100);
            for (Node n : h.getNodes())
                hash.add(n,n.getNumExecutors()*100);
982

983
            Label lbl = p.getAssignedLabel();
984 985
            for (Node n : hash.list(p.task.getFullDisplayName())) {
                Computer c = n.toComputer();
K
kohsuke 已提交
986
                if (c==null || c.isOffline())    continue;
987
                if (lbl!=null && !lbl.contains(n))  continue;
988
                if (n.canTake(p) != null) continue;
989
                c.startFlyWeightTask(new WorkUnitContext(p).createWorkUnit(p.task));
990
                pendings.add(p);
991
                return;
992 993 994 995 996 997 998 999
            }
            // if the execution get here, it means we couldn't schedule it anywhere.
            // so do the scheduling like other normal jobs.
        }
        
        buildables.put(p.task,p);
    }

1000
    public static boolean ifBlockedByHudsonShutdown(Task task) {
1001
        return Jenkins.getInstance().isQuietingDown() && !(task instanceof NonBlockingTask);
1002 1003
    }

1004 1005 1006 1007
    public Api getApi() {
        return new Api(this);
    }

K
kohsuke 已提交
1008 1009 1010 1011 1012 1013
    /**
     * Marks {@link Task}s that are not persisted.
     * @since 1.311
     */
    public interface TransientTask extends Task {}

1014 1015 1016 1017 1018 1019 1020
    /**
     * Marks {@link Task}s that do not consume {@link Executor}.
     * @see OneOffExecutor
     * @since 1.318
     */
    public interface FlyweightTask extends Task {}

K
kohsuke 已提交
1021
    /**
1022
     * Marks {@link Task}s that are not affected by the {@linkplain Jenkins#isQuietingDown()}  quieting down},
K
kohsuke 已提交
1023 1024 1025 1026 1027 1028
     * because these tasks keep other tasks executing.
     *
     * @since 1.336 
     */
    public interface NonBlockingTask extends Task {}

K
kohsuke 已提交
1029 1030
    /**
     * Task whose execution is controlled by the queue.
1031
     *
1032
     * <p>
K
kohsuke 已提交
1033 1034 1035
     * {@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.
1036 1037 1038
     *
     * <p>
     * Pending {@link Task}s are persisted when Hudson shuts down, so
K
kohsuke 已提交
1039 1040
     * it needs to be persistable via XStream. To create a non-persisted
     * transient Task, extend {@link TransientTask} marker interface.
1041 1042 1043 1044 1045
     *
     * <p>
     * Plugins are encouraged to extend from {@link AbstractQueueTask}
     * instead of implementing this interface directly, to maintain
     * compatibility with future changes to this interface.
1046 1047 1048 1049 1050 1051
     *
     * <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 已提交
1052
     */
1053
    public interface Task extends ModelObject, SubTask {
1054 1055 1056
        /**
         * Returns true if the execution should be blocked
         * for temporary reasons.
1057 1058
         *
         * <p>
1059
         * Short-hand for {@code getCauseOfBlockage()!=null}.
1060 1061 1062 1063
         */
        boolean isBuildBlocked();

        /**
1064 1065
         * @deprecated as of 1.330
         *      Use {@link CauseOfBlockage#getShortDescription()} instead.
1066 1067 1068
         */
        String getWhyBlocked();

1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
        /**
         * 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();

1082
        /**
K
kohsuke 已提交
1083
         * Unique name of this task.
K
kohsuke 已提交
1084
         *
K
kohsuke 已提交
1085 1086
         * <p>
         * This method is no longer used, left here for compatibility. Just return {@link #getDisplayName()}.
1087 1088 1089
         */
        String getName();

1090 1091 1092 1093 1094
        /**
         * @see hudson.model.Item#getFullDisplayName()
         */
        String getFullDisplayName();

1095 1096 1097 1098 1099 1100 1101
        /**
         * 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 已提交
1102 1103 1104 1105 1106 1107

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

1128
        /**
1129
         * Obtains the {@link SubTask}s that constitute this task.
1130
         *
1131
         * <p>
1132 1133 1134
         * 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.
1135
         *
1136
         * <p>
1137
         * At least size 1.
1138
         *
1139 1140 1141 1142
         * <p>
         * Since this is a newly added method, the invocation may results in {@link AbstractMethodError}.
         * Use {@link Tasks#getSubTasksOf(Task)} that avoids this.
         *
M
mindless 已提交
1143
         * @since 1.377
1144
         */
1145
        Collection<? extends SubTask> getSubTasks();
1146 1147
    }

1148
    /**
M
mindless 已提交
1149
     * Represents the real meat of the computation run by {@link Executor}.
1150 1151 1152 1153 1154
     *
     * <h2>Views</h2>
     * <p>
     * Implementation must have <tt>executorCell.jelly</tt>, which is
     * used to render the HTML that indicates this executable is executing.
1155
     */
1156 1157 1158
    public interface Executable extends Runnable {
        /**
         * Task from which this executable was created.
K
kohsuke 已提交
1159
         * Never null.
1160 1161
         *
         * <p>
M
mindless 已提交
1162
         * Since this method went through a signature change in 1.377, the invocation may results in
1163 1164
         * {@link AbstractMethodError}.
         * Use {@link Executables#getParentOf(Executable)} that avoids this.
1165
         */
1166
        SubTask getParent();
1167 1168 1169 1170 1171

        /**
         * Called by {@link Executor} to perform the task
         */
        void run();
1172 1173 1174 1175
        
        /**
         * Estimate of how long will it take to execute this executable.
         * Measured in milliseconds.
1176
         * 
1177
         * Please, consider using {@link Executables#getEstimatedDurationFor(Executable)}
1178
         * to protected against AbstractMethodErrors!
1179 1180 1181 1182 1183
         *
         * @return -1 if it's impossible to estimate.
         * @since 1.383
         */
        long getEstimatedDuration();
1184 1185 1186 1187

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

K
kohsuke 已提交
1191 1192 1193
    /**
     * Item in a queue.
     */
1194
    @ExportedBean(defaultVisibility = 999)
1195
    public static abstract class Item extends Actionable {
1196 1197 1198 1199
        /**
         * VM-wide unique ID that tracks the {@link Task} as it moves through different stages
         * in the queue (each represented by different subtypes of {@link Item}.
         */
1200
        @Exported
1201 1202 1203
    	public final int id;
    	
		/**
K
kohsuke 已提交
1204 1205
         * Project to be built.
         */
1206
        @Exported
1207
        public final Task task;
1208

1209
        private /*almost final*/ transient FutureImpl future;
1210

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

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

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

1233 1234 1235 1236 1237 1238 1239
        /**
         * Can be used to wait for the completion (either normal, abnormal, or cancellation) of the {@link Task}.
         * <p>
         * Just like {@link #id}, the same object tracks various stages of the queue.
         */
        public Future<Executable> getFuture() { return future; }

1240 1241 1242 1243 1244 1245 1246 1247
        public Label getAssignedLabel() {
            for (LabelAssignmentAction laa : getActions(LabelAssignmentAction.class)) {
                Label l = laa.getAssignedLabel(task);
                if (l!=null)    return l;
            }
            return task.getAssignedLabel();
        }

1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
        /**
         * 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();
        }

1261
        protected Item(Task task, List<Action> actions, int id, FutureImpl future) {
1262 1263
            this.task = task;
            this.id = id;
1264
            this.future = future;
1265 1266 1267 1268
            for (Action action: actions) addAction(action);
        }
        
        protected Item(Item item) {
1269
        	this(item.task, item.getActions(), item.id, item.future);
K
kohsuke 已提交
1270 1271
        }

1272
        /**
1273
         * Gets a human-readable status message describing why it's in the queue.
1274
         */
K
kohsuke 已提交
1275
        @Exported
1276 1277 1278 1279 1280
        public final String getWhy() {
            CauseOfBlockage cob = getCauseOfBlockage();
            return cob!=null ? cob.getShortDescription() : null;
        }

K
kohsuke 已提交
1281 1282 1283
        /**
         * Gets an object that describes why this item is in the queue.
         */
1284 1285
        public abstract CauseOfBlockage getCauseOfBlockage();

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

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

        /**
         * Called from queue.jelly.
         */
1321
        public HttpResponse doCancelQueue() throws IOException, ServletException {
1322
        	Jenkins.getInstance().getQueue().cancel(this);
1323
            return HttpResponses.forwardToPreviousPage();
1324
        }
1325 1326 1327 1328 1329 1330 1331 1332 1333

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

        private Object readResolve() {
1334
            this.future = new FutureImpl(task);
1335 1336
            return this;
        }
K
kohsuke 已提交
1337 1338 1339 1340 1341

        @Override
        public String toString() {
            return getClass().getName()+':'+task.toString();
        }
1342 1343 1344 1345 1346
    }
    
    /**
     * An optional interface for actions on Queue.Item.
     * Lets the action cooperate in queue management.
1347 1348
     * 
     * @since 1.300-ish.
1349 1350 1351 1352 1353 1354 1355
     */
    public interface QueueAction extends Action {
    	/**
    	 * Returns whether the new item should be scheduled. 
    	 * An action should return true if the associated task is 'different enough' to warrant a separate execution.
    	 */
    	public boolean shouldSchedule(List<Action> actions);
1356
    }
1357

1358
    /**
K
kohsuke 已提交
1359 1360 1361 1362 1363 1364
     * Extension point for deciding if particular job should be scheduled or not.
     *
     * <p>
     * This handler is consulted every time someone tries to submit a task to the queue.
     * If any of the registered handlers returns false, the task will not be added
     * to the queue, and the task will never get executed. 
1365 1366 1367 1368 1369 1370 1371 1372 1373
     *
     * <p>
     * This extension point is still a subject to change, as we are seeking more
     * comprehensive Queue pluggability. See HUDSON-2072.
     *
     * @since 1.316
     */
    public static abstract class QueueDecisionHandler implements ExtensionPoint {
    	/**
K
kohsuke 已提交
1374
    	 * Returns whether the new item should be scheduled.
1375 1376 1377 1378 1379 1380 1381 1382
    	 */
    	public abstract boolean shouldSchedule(Task p, List<Action> actions);
    	    	
    	/**
    	 * All registered {@link QueueDecisionHandler}s
    	 * @return
    	 */
    	public static ExtensionList<QueueDecisionHandler> all() {
1383
    		return Jenkins.getInstance().getExtensionList(QueueDecisionHandler.class);
1384 1385 1386
    	}
    }
    
1387 1388 1389
    /**
     * {@link Item} in the {@link Queue#waitingList} stage.
     */
1390 1391 1392
    public static final class WaitingItem extends Item implements Comparable<WaitingItem> {
    	private static final AtomicInteger COUNTER = new AtomicInteger(0);
    	
1393 1394 1395 1396 1397
        /**
         * This item can be run after this time.
         */
        @Exported
        public Calendar timestamp;
1398

1399
        public WaitingItem(Calendar timestamp, Task project, List<Action> actions) {
1400
            super(project, actions, COUNTER.incrementAndGet(), new FutureImpl(project));
1401 1402
            this.timestamp = timestamp;
        }
1403
        
1404 1405 1406 1407 1408 1409 1410
        public int compareTo(WaitingItem that) {
            int r = this.timestamp.getTime().compareTo(that.timestamp.getTime());
            if (r != 0) return r;

            return this.id - that.id;
        }

1411
        public CauseOfBlockage getCauseOfBlockage() {
1412
            long diff = timestamp.getTimeInMillis() - System.currentTimeMillis();
1413
            if (diff > 0)
1414
                return CauseOfBlockage.fromMessage(Messages._Queue_InQuietPeriod(Util.getTimeSpanString(diff)));
1415
            else
1416
                return CauseOfBlockage.fromMessage(Messages._Queue_Unknown());
1417 1418
        }
    }
K
kohsuke 已提交
1419

1420 1421 1422
    /**
     * Common part between {@link BlockedItem} and {@link BuildableItem}.
     */
1423
    public static abstract class NotWaitingItem extends Item {
1424 1425 1426 1427 1428 1429 1430
        /**
         * When did this job exit the {@link Queue#waitingList} phase?
         */
        @Exported
        public final long buildableStartMilliseconds;

        protected NotWaitingItem(WaitingItem wi) {
1431
            super(wi);
1432
            buildableStartMilliseconds = System.currentTimeMillis();
K
kohsuke 已提交
1433
        }
1434

1435
        protected NotWaitingItem(NotWaitingItem ni) {
1436
            super(ni);
1437
            buildableStartMilliseconds = ni.buildableStartMilliseconds;
1438
        }
1439
    }
1440

1441 1442 1443 1444 1445 1446 1447
    /**
     * {@link Item} in the {@link Queue#blockedProjects} stage.
     */
    public final class BlockedItem extends NotWaitingItem {
        public BlockedItem(WaitingItem wi) {
            super(wi);
        }
1448

1449 1450 1451 1452
        public BlockedItem(NotWaitingItem ni) {
            super(ni);
        }

1453
        public CauseOfBlockage getCauseOfBlockage() {
1454 1455 1456
            ResourceActivity r = getBlockingActivity(task);
            if (r != null) {
                if (r == task) // blocked by itself, meaning another build is in progress
1457 1458
                    return CauseOfBlockage.fromMessage(Messages._Queue_InProgress());
                return CauseOfBlockage.fromMessage(Messages._Queue_BlockedBy(r.getDisplayName()));
1459
            }
1460
            return task.getCauseOfBlockage();
1461
        }
1462
    }
1463

1464 1465 1466
    /**
     * {@link Item} in the {@link Queue#buildables} stage.
     */
1467
    public final static class BuildableItem extends NotWaitingItem {
1468 1469 1470 1471 1472 1473 1474 1475
        public BuildableItem(WaitingItem wi) {
            super(wi);
        }

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

1476
        public CauseOfBlockage getCauseOfBlockage() {
1477
            Jenkins jenkins = Jenkins.getInstance();
1478
            if(ifBlockedByHudsonShutdown(task))
1479
                return CauseOfBlockage.fromMessage(Messages._Queue_HudsonIsAboutToShutDown());
K
kohsuke 已提交
1480

1481
            Label label = getAssignedLabel();
1482 1483
            List<Node> allNodes = jenkins.getNodes();
            if (allNodes.isEmpty())
1484
                label = null;    // no master/slave. pointless to talk about nodes
1485

1486
            if (label != null) {
K
Kohsuke Kawaguchi 已提交
1487
                Set<Node> nodes = label.getNodes();
1488
                if (label.isOffline()) {
1489
                    if (nodes.size() != 1)      return new BecauseLabelIsOffline(label);
1490
                    else                        return new BecauseNodeIsOffline(nodes.iterator().next());
K
Kohsuke Kawaguchi 已提交
1491 1492 1493
                } else {
                    if (nodes.size() != 1)      return new BecauseLabelIsBusy(label);
                    else                        return new BecauseNodeIsBusy(nodes.iterator().next());
1494
                }
K
Kohsuke Kawaguchi 已提交
1495
            } else {
1496 1497 1498 1499 1500 1501 1502 1503
                CauseOfBlockage c = null;
                for (Node node : allNodes) {
                    if (node.toComputer().isPartiallyIdle()) {
                        c = canTake(node);
                        if (c==null)    break;
                    }
                }

K
Kohsuke Kawaguchi 已提交
1504
                return CauseOfBlockage.createNeedsMoreExecutor(Messages._Queue_WaitingForNextAvailableExecutor());
1505 1506
            }
        }
1507

1508 1509 1510 1511 1512 1513 1514 1515
        private CauseOfBlockage canTake(Node node) {
            for (QueueTaskDispatcher d : QueueTaskDispatcher.all()) {
                CauseOfBlockage cause = d.canTake(node, this);
                if (cause!=null)    return cause;
            }
            return null;
        }

1516 1517
        @Override
        public boolean isStuck() {
1518
            Label label = getAssignedLabel();
1519 1520 1521 1522 1523 1524 1525
            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) {
1526
                // if we were running elsewhere, we would have done this build ten times.
1527
                return elapsed > Math.max(d,60000L)*10;
1528 1529
            } else {
                // more than a day in the queue
1530
                return TimeUnit2.MILLISECONDS.toHours(elapsed)>24;
1531 1532
            }
        }
K
kohsuke 已提交
1533 1534 1535
    }

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

1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
    /**
     * This {@link XStream} instance is used to persist {@link Task}s.
     */
    public static final XStream XSTREAM = new XStream2();

    static {
        XSTREAM.registerConverter(new AbstractSingleValueConverter() {

			@Override
			@SuppressWarnings("unchecked")
			public boolean canConvert(Class klazz) {
				return hudson.model.Item.class.isAssignableFrom(klazz);
			}

			@Override
			public Object fromString(String string) {
1553
                Object item = Jenkins.getInstance().getItemByFullName(string);
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
                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]);
1576
				Job<?,?> job = (Job<?,?>) Jenkins.getInstance().getItemByFullName(projectName);
1577 1578
                if(job==null)  throw new NoSuchElementException("No such job exists: "+projectName);
				Run<?,?> run = job.getBuildByNumber(buildNumber);
K
kohsuke 已提交
1579
                if(run==null)  throw new NoSuchElementException("No such build: "+string);
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
				return run;
			}

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

1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
    /**
     * Regularly invokes {@link Queue#maintain()} and clean itself up when
     * {@link Queue} gets GC-ed.
     */
    private static class MaintainTask extends SafeTimerTask {
        private final WeakReference<Queue> queue;

        MaintainTask(Queue queue) {
            this.queue = new WeakReference<Queue>(queue);

            long interval = 5 * Timer.ONE_SECOND;
            Trigger.timer.schedule(this, interval, interval);
        }

        protected void doRun() {
            Queue q = queue.get();
1607
            if (q != null)
1608 1609 1610 1611 1612
                q.maintain();
            else
                cancel();
        }
    }
1613 1614
    
    /**
1615
     * {@link ArrayList} of {@link Item} with more convenience methods.
1616
     */
1617
    private static class ItemList<T extends Item> extends ArrayList<T> {
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
    	public T get(Task task) {
    		for (T item: this) {
    			if (item.task == task) {
    				return item;
    			}
    		}
    		return null;
    	}
    	
    	public List<T> getAll(Task task) {
    		List<T> result = new ArrayList<T>();
    		for (T item: this) {
    			if (item.task == task) {
    				result.add(item);
    			}
    		}
    		return result;
    	}
    	
    	public boolean containsKey(Task task) {
    		return get(task) != null;
    	}
    	
    	public T remove(Task task) {
    		Iterator<T> it = iterator();
    		while (it.hasNext()) {
    			T t = it.next();
    			if (t.task == task) {
    				it.remove();
    				return t;
    			}
    		}
    		return null;
    	}
    	
    	public void put(Task task, T item) {
    		assert item.task == task;
    		add(item);
    	}
    	
    	public ItemList<T> values() {
    		return this;
    	}
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684

        /**
         * Works like {@link #remove(Task)} but also marks the {@link Item} as cancelled.
         */
        public T cancel(Task p) {
            T x = remove(p);
            if(x!=null) x.onCancelled();
            return x;
        }

        /**
         * Works like {@link #remove(Object)} but also marks the {@link Item} as cancelled.
         */
        public boolean cancel(Item t) {
            boolean r = remove(t);
            if(r)   t.onCancelled();
            return r;
        }

        public void cancelAll() {
            for (T t : this)
                t.onCancelled();
            clear();
        }
1685
    }
1686 1687 1688

    @CLIResolver
    public static Queue getInstance() {
1689
        return Jenkins.getInstance().getQueue();
1690
    }
K
kohsuke 已提交
1691 1692 1693 1694 1695

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