SlaveComputer.java 29.3 KB
Newer Older
K
kohsuke 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
 * The MIT License
 * 
 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Stephen Connolly
 * 
 * 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.
 */
24 25 26
package hudson.slaves;

import hudson.model.*;
27
import hudson.util.IOException2;
K
Kohsuke Kawaguchi 已提交
28
import hudson.util.IOUtils;
29
import hudson.util.io.ReopenableRotatingFileOutputStream;
30
import jenkins.model.Jenkins.MasterComputer;
31 32 33 34 35 36
import hudson.remoting.Channel;
import hudson.remoting.VirtualChannel;
import hudson.remoting.Callable;
import hudson.util.StreamTaskListener;
import hudson.util.NullStream;
import hudson.util.RingBufferLogHandler;
K
kohsuke 已提交
37
import hudson.util.Futures;
38
import hudson.FilePath;
K
kohsuke 已提交
39
import hudson.Util;
K
kohsuke 已提交
40
import hudson.AbortException;
41
import hudson.remoting.Launcher;
42
import hudson.security.ACL;
43
import static hudson.slaves.SlaveComputer.LogHolder.SLAVE_LOG_HANDLER;
44
import hudson.slaves.OfflineCause.ChannelTermination;
K
Kohsuke Kawaguchi 已提交
45
import hudson.util.Secret;
46 47 48 49 50

import java.io.File;
import java.io.OutputStream;
import java.io.InputStream;
import java.io.IOException;
51
import java.io.PrintStream;
52
import java.security.SecureRandom;
53 54 55
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
56
import java.util.logging.Handler;
57 58 59 60
import java.util.List;
import java.util.Collections;
import java.util.ArrayList;
import java.nio.charset.Charset;
K
kohsuke 已提交
61
import java.util.concurrent.Future;
62
import java.security.Security;
63

64
import hudson.util.io.ReopenableFileOutputStream;
K
Kohsuke Kawaguchi 已提交
65 66 67 68 69
import java.io.ByteArrayOutputStream;
import java.io.PrintWriter;
import java.security.GeneralSecurityException;
import javax.crypto.Cipher;
import javax.crypto.SecretKey;
70
import javax.crypto.spec.IvParameterSpec;
K
Kohsuke Kawaguchi 已提交
71 72
import javax.crypto.spec.SecretKeySpec;
import javax.servlet.RequestDispatcher;
73
import jenkins.model.Jenkins;
74
import jenkins.slaves.JnlpSlaveAgentProtocol;
K
Kohsuke Kawaguchi 已提交
75
import org.acegisecurity.Authentication;
76 77
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
78 79 80
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.HttpRedirect;
81 82

import javax.servlet.ServletException;
K
Kohsuke Kawaguchi 已提交
83 84
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponseWrapper;
85 86
import org.acegisecurity.context.SecurityContext;
import org.acegisecurity.context.SecurityContextHolder;
K
Kohsuke Kawaguchi 已提交
87 88 89
import org.kohsuke.stapler.ResponseImpl;
import org.kohsuke.stapler.WebMethod;
import org.kohsuke.stapler.compression.FilterServletOutputStream;
90 91 92 93 94 95

/**
 * {@link Computer} for {@link Slave}s.
 *
 * @author Kohsuke Kawaguchi
 */
K
kohsuke 已提交
96
public class SlaveComputer extends Computer {
97 98 99 100
    private volatile Channel channel;
    private volatile transient boolean acceptingTasks = true;
    private Charset defaultCharset;
    private Boolean isUnix;
K
kohsuke 已提交
101 102 103 104 105 106 107 108
    /**
     * Effective {@link ComputerLauncher} that hides the details of
     * how we launch a slave agent on this computer.
     *
     * <p>
     * This is normally the same as {@link Slave#getLauncher()} but
     * can be different. See {@link #grabLauncher(Node)}. 
     */
109 110
    private ComputerLauncher launcher;

111 112 113 114 115 116 117 118 119 120 121
    /**
     * Perpetually writable log file.
     */
    private final ReopenableFileOutputStream log;

    /**
     * {@link StreamTaskListener} that wraps {@link #log}, hence perpetually writable.
     */
    private final TaskListener taskListener;


122 123 124 125 126 127 128
    /**
     * Number of failed attempts to reconnect to this node
     * (so that if we keep failing to reconnect, we can stop
     * trying.)
     */
    private transient int numRetryAttempt;

K
kohsuke 已提交
129 130 131 132 133 134 135 136 137 138
    /**
     * Tracks the status of the last launch operation, which is always asynchronous.
     * This can be used to wait for the completion, or cancel the launch activity.
     */
    private volatile Future<?> lastConnectActivity = null;

    private Object constructed = new Object();

    public SlaveComputer(Slave slave) {
        super(slave);
139
        this.log = new ReopenableRotatingFileOutputStream(getLogFile(),10);
140
        this.taskListener = new StreamTaskListener(log);
141
        assert slave.getNumExecutors()!=0 : "Computer created with 0 executors";
K
kohsuke 已提交
142
    }
143 144 145 146 147 148 149 150 151

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isAcceptingTasks() {
        return acceptingTasks;
    }

K
Kohsuke Kawaguchi 已提交
152 153 154
    /**
     * @since 1.498
     */
155 156 157 158
    public String getJnlpMac() {
        return JnlpSlaveAgentProtocol.SLAVE_SECRET.mac(getName());
    }

159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    /**
     * Allows a {@linkplain hudson.slaves.ComputerLauncher} or a {@linkplain hudson.slaves.RetentionStrategy} to
     * suspend tasks being accepted by the slave computer.
     *
     * @param acceptingTasks {@code true} if the slave can accept tasks.
     */
    public void setAcceptingTasks(boolean acceptingTasks) {
        this.acceptingTasks = acceptingTasks;
    }

    /**
     * True if this computer is a Unix machine (as opposed to Windows machine).
     *
     * @return
     *      null if the computer is disconnected and therefore we don't know whether it is Unix or not.
     */
    public Boolean isUnix() {
        return isUnix;
    }

179
    @Override
180 181 182 183
    public Slave getNode() {
        return (Slave)super.getNode();
    }

K
kohsuke 已提交
184 185 186 187 188 189 190 191
    @Override
    public String getIcon() {
        Future<?> l = lastConnectActivity;
        if(l!=null && !l.isDone())
            return "computer-flash.gif";
        return super.getIcon();
    }

M
mindless 已提交
192 193 194 195
    /**
     * @deprecated since 2008-05-20.
     */
    @Deprecated @Override
196 197 198 199 200 201 202 203 204 205 206 207 208
    public boolean isJnlpAgent() {
        return launcher instanceof JNLPLauncher;
    }

    @Override
    public boolean isLaunchSupported() {
        return launcher.isLaunchSupported();
    }

    public ComputerLauncher getLauncher() {
        return launcher;
    }

209
    protected Future<?> _connect(boolean forceReconnect) {
K
kohsuke 已提交
210
        if(channel!=null)   return Futures.precomputed(null);
211
        if(!forceReconnect && isConnecting())
K
kohsuke 已提交
212
            return lastConnectActivity;
213
        if(forceReconnect && isConnecting())
K
kohsuke 已提交
214
            logger.fine("Forcing a reconnect on "+getName());
215 216

        closeChannel();
K
kohsuke 已提交
217 218
        return lastConnectActivity = Computer.threadPoolForRemoting.submit(new java.util.concurrent.Callable<Object>() {
            public Object call() throws Exception {
219 220
                // do this on another thread so that the lengthy launch operation
                // (which is typical) won't block UI thread.
K
Kohsuke Kawaguchi 已提交
221 222 223

                ACL.impersonate(ACL.SYSTEM);    // background activity should run like a super user

K
kohsuke 已提交
224
                try {
225
                    log.rewind();
226
                    try {
T
Tom Rini 已提交
227
                        for (ComputerListener cl : ComputerListener.all())
228
                            cl.preLaunch(SlaveComputer.this, taskListener);
K
Kohsuke Kawaguchi 已提交
229

230
                        launcher.launch(SlaveComputer.this, taskListener);
231
                    } catch (AbortException e) {
232
                        taskListener.error(e.getMessage());
233 234
                        throw e;
                    } catch (IOException e) {
235 236
                        Util.displayIOException(e,taskListener);
                        e.printStackTrace(taskListener.error(Messages.ComputerLauncher_unexpectedError()));
237 238
                        throw e;
                    } catch (InterruptedException e) {
239
                        e.printStackTrace(taskListener.error(Messages.ComputerLauncher_abortedLaunch()));
240 241
                        throw e;
                    }
242
                } finally {
243
                    if (channel==null) {
244
                        offlineCause = new OfflineCause.LaunchFailed();
245 246 247
                        for (ComputerListener cl : ComputerListener.all())
                            cl.onLaunchFailure(SlaveComputer.this, taskListener);
                    }
K
kohsuke 已提交
248
                }
249 250 251 252

                if (channel==null)
                    throw new IOException("Slave failed to connect, even though the launcher didn't report it. See the log output for details.");
                return null;
253 254 255 256 257 258 259 260 261 262 263 264 265
            }
        });
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void taskAccepted(Executor executor, Queue.Task task) {
        super.taskAccepted(executor, task);
        if (launcher instanceof ExecutorListener) {
            ((ExecutorListener)launcher).taskAccepted(executor, task);
        }
266 267 268 269 270
        
        //getNode() can return null at indeterminate times when nodes go offline
        Slave node = getNode();
        if (node != null && node.getRetentionStrategy() instanceof ExecutorListener) {
            ((ExecutorListener)node.getRetentionStrategy()).taskAccepted(executor, task);
271 272 273 274 275 276 277 278 279 280 281 282
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void taskCompleted(Executor executor, Queue.Task task, long durationMS) {
        super.taskCompleted(executor, task, durationMS);
        if (launcher instanceof ExecutorListener) {
            ((ExecutorListener)launcher).taskCompleted(executor, task, durationMS);
        }
283
        RetentionStrategy r = getRetentionStrategy();
K
kohsuke 已提交
284 285
        if (r instanceof ExecutorListener) {
            ((ExecutorListener) r).taskCompleted(executor, task, durationMS);
286 287 288 289 290 291 292 293 294 295 296 297
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void taskCompletedWithProblems(Executor executor, Queue.Task task, long durationMS, Throwable problems) {
        super.taskCompletedWithProblems(executor, task, durationMS, problems);
        if (launcher instanceof ExecutorListener) {
            ((ExecutorListener)launcher).taskCompletedWithProblems(executor, task, durationMS, problems);
        }
298 299 300
        RetentionStrategy r = getRetentionStrategy();
        if (r instanceof ExecutorListener) {
            ((ExecutorListener) r).taskCompletedWithProblems(executor, task, durationMS, problems);
301 302 303
        }
    }

K
kohsuke 已提交
304 305 306 307 308 309
    @Override
    public boolean isConnecting() {
        Future<?> l = lastConnectActivity;
        return isOffline() && l!=null && !l.isDone();
    }

310 311
    public OutputStream openLogFile() {
        try {
312 313 314
            log.rewind();
            return log;
        } catch (IOException e) {
315
            logger.log(Level.SEVERE, "Failed to create log file "+getLogFile(),e);
316
            return new NullStream();
317 318 319 320 321
        }
    }

    private final Object channelLock = new Object();

K
kohsuke 已提交
322 323 324 325
    public void setChannel(InputStream in, OutputStream out, TaskListener taskListener, Channel.Listener listener) throws IOException, InterruptedException {
        setChannel(in,out,taskListener.getLogger(),listener);
    }

326 327
    /**
     * Creates a {@link Channel} from the given stream and sets that to this slave.
K
kohsuke 已提交
328 329 330 331 332 333 334 335 336 337 338 339 340
     *
     * @param in
     *      Stream connected to the remote "slave.jar". It's the caller's responsibility to do
     *      buffering on this stream, if that's necessary.
     * @param out
     *      Stream connected to the remote peer. It's the caller's responsibility to do
     *      buffering on this stream, if that's necessary.
     * @param launchLog
     *      If non-null, receive the portion of data in <tt>is</tt> before
     *      the data goes into the "binary mode". This is useful
     *      when the established communication channel might include some data that might
     *      be useful for debugging/trouble-shooting.
     * @param listener
341
     *      Gets a notification when the channel closes, to perform clean up. Can be null.
342 343
     *      By the time this method is called, the cause of the termination is reported to the user,
     *      so the implementation of the listener doesn't need to do that again.
344 345
     */
    public void setChannel(InputStream in, OutputStream out, OutputStream launchLog, Channel.Listener listener) throws IOException, InterruptedException {
346 347 348 349
        Channel channel = new Channel(nodeName,threadPoolForRemoting, Channel.Mode.NEGOTIATE, in,out, launchLog);
        setChannel(channel,launchLog,listener);
    }

J
Jesse Glick 已提交
350 351 352 353 354 355 356 357
    /**
     * Shows {@link Channel#classLoadingCount}.
     * @since 1.495
     */
    public int getClassLoadingCount() throws IOException, InterruptedException {
        return channel.call(new LoadingCount(false));
    }

358 359 360
    /**
     * Shows {@link Channel#classLoadingPrefetchCacheCount}.
     * @return -1 in case that capability is not supported
J
Jesse Glick 已提交
361
     * @since 1.519
362 363 364 365 366 367 368 369
     */
    public int getClassLoadingPrefetchCacheCount() throws IOException, InterruptedException {
        if (!channel.remoteCapability.supportsPrefetch()) {
            return -1;
        }
        return channel.call(new LoadingPrefetchCacheCount());
    }

J
Jesse Glick 已提交
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
    /**
     * Shows {@link Channel#resourceLoadingCount}.
     * @since 1.495
     */
    public int getResourceLoadingCount() throws IOException, InterruptedException {
        return channel.call(new LoadingCount(true));
    }

    /**
     * Shows {@link Channel#classLoadingTime}.
     * @since 1.495
     */
    public long getClassLoadingTime() throws IOException, InterruptedException {
        return channel.call(new LoadingTime(false));
    }

    /**
     * Shows {@link Channel#resourceLoadingTime}.
     * @since 1.495
     */
    public long getResourceLoadingTime() throws IOException, InterruptedException {
        return channel.call(new LoadingTime(true));
    }

    static class LoadingCount implements Callable<Integer,RuntimeException> {
        private final boolean resource;
        LoadingCount(boolean resource) {
            this.resource = resource;
        }
        @Override public Integer call() {
            Channel c = Channel.current();
            return resource ? c.resourceLoadingCount.get() : c.classLoadingCount.get();
        }
    }

405 406 407 408 409 410
    static class LoadingPrefetchCacheCount implements Callable<Integer,RuntimeException> {
        @Override public Integer call() {
            return Channel.current().classLoadingPrefetchCacheCount.get();
        }
    }

J
Jesse Glick 已提交
411 412 413 414 415 416 417 418 419 420 421
    static class LoadingTime implements Callable<Long,RuntimeException> {
        private final boolean resource;
        LoadingTime(boolean resource) {
            this.resource = resource;
        }
        @Override public Long call() {
            Channel c = Channel.current();
            return resource ? c.resourceLoadingTime.get() : c.classLoadingTime.get();
        }
    }

422 423 424 425 426 427
    /**
     * Sets up the connection through an exsting channel.
     *
     * @since 1.444
     */
    public void setChannel(Channel channel, OutputStream launchLog, Channel.Listener listener) throws IOException, InterruptedException {
428 429 430
        if(this.channel!=null)
            throw new IllegalStateException("Already connected");

431 432
        final TaskListener taskListener = new StreamTaskListener(launchLog);
        PrintStream log = taskListener.getLogger();
433

434
        channel.addListener(new Channel.Listener() {
435
            @Override
436 437
            public void onClosed(Channel c, IOException cause) {
                // Orderly shutdown will have null exception
438 439
                if (cause!=null) {
                    offlineCause = new ChannelTermination(cause);
440
                    cause.printStackTrace(taskListener.error("Connection terminated"));
441 442 443
                } else {
                    taskListener.getLogger().println("Connection terminated");
                }
444
                closeChannel();
445
                launcher.afterDisconnect(SlaveComputer.this, taskListener);
446 447
            }
        });
448 449
        if(listener!=null)
            channel.addListener(listener);
450

451 452 453
        String slaveVersion = channel.call(new SlaveVersion());
        log.println("Slave.jar version: " + slaveVersion);

454 455 456 457 458 459 460 461
        boolean _isUnix = channel.call(new DetectOS());
        log.println(_isUnix? hudson.model.Messages.Slave_UnixSlave():hudson.model.Messages.Slave_WindowsSlave());

        String defaultCharsetName = channel.call(new DetectDefaultCharset());

        String remoteFs = getNode().getRemoteFS();
        if(_isUnix && !remoteFs.contains("/") && remoteFs.contains("\\"))
            log.println("WARNING: "+remoteFs+" looks suspiciously like Windows path. Maybe you meant "+remoteFs.replace('\\','/')+"?");
462
        FilePath root = new FilePath(channel,getNode().getRemoteFS());
463

K
Kohsuke Kawaguchi 已提交
464 465 466 467 468
        // reference counting problem is known to happen, such as JENKINS-9017, and so as a preventive measure
        // we pin the base classloader so that it'll never get GCed. When this classloader gets released,
        // it'll have a catastrophic impact on the communication.
        channel.pinClassLoader(getClass().getClassLoader());

469
        channel.call(new SlaveInitializer());
470 471 472 473 474 475 476 477
        SecurityContext old = ACL.impersonate(ACL.SYSTEM);
        try {
            for (ComputerListener cl : ComputerListener.all()) {
                cl.preOnline(this,channel,root,taskListener);
            }
        } finally {
            SecurityContextHolder.setContext(old);
        }
478

479 480
        offlineCause = null;

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
        // update the data structure atomically to prevent others from seeing a channel that's not properly initialized yet
        synchronized(channelLock) {
            if(this.channel!=null) {
                // check again. we used to have this entire method in a big sycnhronization block,
                // but Channel constructor blocks for an external process to do the connection
                // if CommandLauncher is used, and that cannot be interrupted because it blocks at InputStream.
                // so if the process hangs, it hangs the thread in a lock, and since Hudson will try to relaunch,
                // we'll end up queuing the lot of threads in a pseudo deadlock.
                // This implementation prevents that by avoiding a lock. HUDSON-1705 is likely a manifestation of this.
                channel.close();
                throw new IllegalStateException("Already connected");
            }
            isUnix = _isUnix;
            numRetryAttempt = 0;
            this.channel = channel;
            defaultCharset = Charset.forName(defaultCharsetName);
497 498 499 500

            synchronized (statusChangeLock) {
                statusChangeLock.notifyAll();
            }
501
        }
502 503 504 505 506 507 508 509
        old = ACL.impersonate(ACL.SYSTEM);
        try {
            for (ComputerListener cl : ComputerListener.all()) {
                cl.onOnline(this,taskListener);
            }
        } finally {
            SecurityContextHolder.setContext(old);
        }
A
abayer 已提交
510
        log.println("Slave successfully connected and online");
511
        Jenkins.getInstance().getQueue().scheduleMaintenance();
512 513 514
    }

    @Override
515
    public Channel getChannel() {
516 517 518 519 520 521 522 523 524 525 526
        return channel;
    }

    public Charset getDefaultCharset() {
        return defaultCharset;
    }

    public List<LogRecord> getLogRecords() throws IOException, InterruptedException {
        if(channel==null)
            return Collections.emptyList();
        else
527
            return channel.call(new SlaveLogFetcher());
528 529
    }

530 531 532
    public HttpResponse doDoDisconnect(@QueryParameter String offlineMessage) throws IOException, ServletException {
        if (channel!=null) {
            //does nothing in case computer is already disconnected
533
            checkPermission(DISCONNECT);
534 535
            offlineMessage = Util.fixEmptyAndTrim(offlineMessage);
            disconnect(OfflineCause.create(Messages._SlaveComputer_DisconnectedBy(
536
                    Jenkins.getAuthentication().getName(),
537 538 539 540
                    offlineMessage!=null ? " : " + offlineMessage : "")
            ));
        }
        return new HttpRedirect(".");
541 542 543
    }

    @Override
544 545
    public Future<?> disconnect(OfflineCause cause) {
        super.disconnect(cause);
K
kohsuke 已提交
546
        return Computer.threadPoolForRemoting.submit(new Runnable() {
547 548 549
            public void run() {
                // do this on another thread so that any lengthy disconnect operation
                // (which could be typical) won't block UI thread.
550 551 552
                launcher.beforeDisconnect(SlaveComputer.this, taskListener);
                closeChannel();
                launcher.afterDisconnect(SlaveComputer.this, taskListener);
553 554 555 556 557 558
            }
        });
    }

    public void doLaunchSlaveAgent(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
        if(channel!=null) {
559
            req.getView(this,"already-launched.jelly").forward(req, rsp);
560 561 562
            return;
        }

K
kohsuke 已提交
563
        connect(true);
564 565 566 567 568 569 570 571 572 573 574

        // TODO: would be nice to redirect the user to "launching..." wait page,
        // then spend a few seconds there and poll for the completion periodically.
        rsp.sendRedirect("log");
    }

    public void tryReconnect() {
        numRetryAttempt++;
        if(numRetryAttempt<6 || (numRetryAttempt%12)==0) {
            // initially retry several times quickly, and after that, do it infrequently.
            logger.info("Attempting to reconnect "+nodeName);
K
kohsuke 已提交
575
            connect(true);
576 577 578 579 580 581
        }
    }

    /**
     * Serves jar files for JNLP slave agents.
     *
M
mindless 已提交
582
     * @deprecated since 2008-08-18.
583
     *      This URL binding is no longer used and moved up directly under to {@link jenkins.model.Jenkins},
584 585 586 587 588 589
     *      but it's left here for now just in case some old JNLP slave agents request it.
     */
    public Slave.JnlpJar getJnlpJars(String fileName) {
        return new Slave.JnlpJar(fileName);
    }

K
Kohsuke Kawaguchi 已提交
590 591 592 593 594 595 596 597 598 599 600 601 602 603
    @WebMethod(name="slave-agent.jnlp")
    public void doSlaveAgentJnlp(StaplerRequest req, StaplerResponse res) throws IOException, ServletException {
        RequestDispatcher view = req.getView(this, "slave-agent.jnlp.jelly");
        if ("true".equals(req.getParameter("encrypt"))) {
            final ByteArrayOutputStream baos = new ByteArrayOutputStream();
            StaplerResponse temp = new ResponseImpl(req.getStapler(), new HttpServletResponseWrapper(res) {
                @Override public ServletOutputStream getOutputStream() throws IOException {
                    return new FilterServletOutputStream(baos);
                }
                @Override public PrintWriter getWriter() throws IOException {
                    throw new IllegalStateException();
                }
            });
            view.forward(req, temp);
604 605 606 607

            byte[] iv = new byte[128/8];
            new SecureRandom().nextBytes(iv);

K
Kohsuke Kawaguchi 已提交
608 609 610 611
            byte[] jnlpMac = JnlpSlaveAgentProtocol.SLAVE_SECRET.mac(getName().getBytes("UTF-8"));
            SecretKey key = new SecretKeySpec(jnlpMac, 0, /* export restrictions */ 128 / 8, "AES");
            byte[] encrypted;
            try {
612 613
                Cipher c = Secret.getCipher("AES/CFB8/NoPadding");
                c.init(Cipher.ENCRYPT_MODE, key, new IvParameterSpec(iv));
K
Kohsuke Kawaguchi 已提交
614 615
                encrypted = c.doFinal(baos.toByteArray());
            } catch (GeneralSecurityException x) {
616
                throw new IOException2(x);
K
Kohsuke Kawaguchi 已提交
617 618
            }
            res.setContentType("application/octet-stream");
619
            res.getOutputStream().write(iv);
K
Kohsuke Kawaguchi 已提交
620 621 622 623 624 625 626
            res.getOutputStream().write(encrypted);
        } else {
            checkPermission(CONNECT);
            view.forward(req, res);
        }
    }

627 628 629 630
    @Override
    protected void kill() {
        super.kill();
        closeChannel();
K
Kohsuke Kawaguchi 已提交
631
        IOUtils.closeQuietly(log);
632 633 634
    }

    public RetentionStrategy getRetentionStrategy() {
635
        Slave n = getNode();
636
        return n==null ? RetentionStrategy.INSTANCE : n.getRetentionStrategy();
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
    }

    /**
     * If still connected, disconnect.
     */
    private void closeChannel() {
        // TODO: race condition between this and the setChannel method.
        Channel c = channel;
        channel = null;
        isUnix = null;
        if (c != null) {
            try {
                c.close();
            } catch (IOException e) {
                logger.log(Level.SEVERE, "Failed to terminate channel to " + getDisplayName(), e);
            }
653 654
            for (ComputerListener cl : ComputerListener.all())
                cl.onOffline(this);
655 656 657 658 659 660
        }
    }

    @Override
    protected void setNode(Node node) {
        super.setNode(node);
K
kohsuke 已提交
661
        launcher = grabLauncher(node);
662 663

        // maybe the configuration was changed to relaunch the slave, so try to re-launch now.
K
kohsuke 已提交
664 665
        // "constructed==null" test is an ugly hack to avoid launching before the object is fully
        // constructed.
666 667 668 669 670 671
        if(constructed!=null) {
            if (node instanceof Slave)
                ((Slave)node).getRetentionStrategy().check(this);
            else
                connect(false);
        }
K
kohsuke 已提交
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
    }

    /**
     * Grabs a {@link ComputerLauncher} out of {@link Node} to keep it in this {@link Computer}.
     * The returned launcher will be set to {@link #launcher} and used to carry out the actual launch operation.
     *
     * <p>
     * Subtypes that needs to decorate {@link ComputerLauncher} can do so by overriding this method.
     * This is useful for {@link SlaveComputer}s for clouds for example, where one normally needs
     * additional pre-launch step (such as waiting for the provisioned node to become available)
     * before the user specified launch step (like SSH connection) kicks in.
     *
     * @see ComputerLauncherFilter
     */
    protected ComputerLauncher grabLauncher(Node node) {
        return ((Slave)node).getLauncher();
688 689
    }

690 691 692 693 694 695 696 697 698 699 700 701 702 703
    /**
     * Get the slave version
     */
    public String getSlaveVersion() throws IOException, InterruptedException {
        return channel.call(new SlaveVersion());
    }

    /**
     * Get the OS description.
     */
    public String getOSDescription() throws IOException, InterruptedException {
        return channel.call(new DetectOS()) ? "Unix" : "Windows";
    }

704 705
    private static final Logger logger = Logger.getLogger(SlaveComputer.class.getName());

706 707 708 709 710 711
    private static final class SlaveVersion implements Callable<String,IOException> {
        public String call() throws IOException {
            try { return Launcher.VERSION; }
            catch (Throwable ex) { return "< 1.335"; } // Older slave.jar won't have VERSION
        }
    }
712 713 714 715 716 717 718 719 720 721 722 723 724
    private static final class DetectOS implements Callable<Boolean,IOException> {
        public Boolean call() throws IOException {
            return File.pathSeparatorChar==':';
        }
    }

    private static final class DetectDefaultCharset implements Callable<String,IOException> {
        public String call() throws IOException {
            return Charset.defaultCharset().name();
        }
    }

    /**
725 726
     * Puts the {@link #SLAVE_LOG_HANDLER} into a separate class so that loading this class
     * in JVM doesn't end up loading tons of additional classes.
727
     */
728 729 730 731 732 733
    static final class LogHolder {
        /**
         * This field is used on each slave node to record log records on the slave.
         */
        static final RingBufferLogHandler SLAVE_LOG_HANDLER = new RingBufferLogHandler();
    }
734

735
    private static class SlaveInitializer implements Callable<Void,RuntimeException> {
736
        public Void call() {
737 738 739
            // avoid double installation of the handler. JNLP slaves can reconnect to the master multiple times
            // and each connection gets a different RemoteClassLoader, so we need to evict them by class name,
            // not by their identity.
K
Kohsuke Kawaguchi 已提交
740
            for (Handler h : LOGGER.getHandlers()) {
741
                if (h.getClass().getName().equals(SLAVE_LOG_HANDLER.getClass().getName()))
K
Kohsuke Kawaguchi 已提交
742
                    LOGGER.removeHandler(h);
743
            }
K
Kohsuke Kawaguchi 已提交
744
            LOGGER.addHandler(SLAVE_LOG_HANDLER);
745

K
Kohsuke Kawaguchi 已提交
746
            // remove Sun PKCS11 provider if present. See http://wiki.jenkins-ci.org/display/JENKINS/Solaris+Issue+6276483
747 748 749 750 751 752
            try {
                Security.removeProvider("SunPKCS11-Solaris");
            } catch (SecurityException e) {
                // ignore this error.
            }

753 754
            Channel.current().setProperty("slave",Boolean.TRUE); // indicate that this side of the channel is the slave side.
            
755 756 757
            return null;
        }
        private static final long serialVersionUID = 1L;
758
        private static final Logger LOGGER = Logger.getLogger("");
759
    }
760 761 762 763 764 765 766 767 768 769 770

    /**
     * Obtains a {@link VirtualChannel} that allows some computation to be performed on the master.
     * This method can be called from any thread on the master, or from slave (more precisely,
     * it only works from the remoting request-handling thread in slaves, which means if you've started
     * separate thread on slaves, that'll fail.)
     *
     * @return null if the calling thread doesn't have any trace of where its master is.
     * @since 1.362
     */
    public static VirtualChannel getChannelToMaster() {
771
        if (Jenkins.getInstance()!=null)
772 773 774 775
            return MasterComputer.localChannel;

        // if this method is called from within the slave computation thread, this should work
        Channel c = Channel.current();
776
        if (c!=null && Boolean.TRUE.equals(c.getProperty("slave")))
777 778 779 780
            return c;

        return null;
    }
781 782 783 784 785 786

    private static class SlaveLogFetcher implements Callable<List<LogRecord>,RuntimeException> {
        public List<LogRecord> call() {
            return new ArrayList<LogRecord>(SLAVE_LOG_HANDLER.getView());
        }
    }
787
}