1 /* 2 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 */ 23 24 package jdk.testlibrary; 25 26 import java.util.ArrayList; 27 import java.util.Arrays; 28 import java.util.List; 29 30 /** 31 * A utility for constructing command lines for starting JDK tool processes. 32 * 33 * The JDKToolLauncher can in particular be combined with a 34 * java.lang.ProcessBuilder to easily run a JDK tool. For example, the following 35 * code run {@code jmap -heap} against a process with GC logging turned on for 36 * the {@code jmap} process: 37 * 38 * <pre> 39 * {@code 40 * JDKToolLauncher jmap = JDKToolLauncher.create("jmap") 41 * .addVMArg("-XX:+PrintGC"); 42 * .addVMArg("-XX:+PrintGCDetails") 43 * .addToolArg("-heap") 44 * .addToolArg(pid); 45 * ProcessBuilder pb = new ProcessBuilder(jmap.getCommand()); 46 * Process p = pb.start(); 47 * } 48 * </pre> 49 */ 50 public class JDKToolLauncher { 51 private final String executable; 52 private final List<String> vmArgs = new ArrayList<String>(); 53 private final List<String> toolArgs = new ArrayList<String>(); 54 55 private JDKToolLauncher(String tool, boolean useCompilerJDK) { 56 if (useCompilerJDK) { 57 executable = JDKToolFinder.getJDKTool(tool); 58 } else { 59 executable = JDKToolFinder.getTestJDKTool(tool); 60 } 61 vmArgs.addAll(Arrays.asList(ProcessTools.getPlatformSpecificVMArgs())); 62 } 63 64 /** 65 * Creates a new JDKToolLauncher for the specified tool. Using tools path 66 * from the compiler JDK. 67 * 68 * @param tool 69 * The name of the tool 70 * @return A new JDKToolLauncher 71 */ 72 public static JDKToolLauncher create(String tool) { 73 return new JDKToolLauncher(tool, true); 74 } 75 76 /** 77 * Creates a new JDKToolLauncher for the specified tool in the Tested JDK. 78 * 79 * @param tool 80 * The name of the tool 81 * 82 * @return A new JDKToolLauncher 83 */ 84 public static JDKToolLauncher createUsingTestJDK(String tool) { 85 return new JDKToolLauncher(tool, false); 86 } 87 88 /** 89 * Adds an argument to the JVM running the tool. 90 * 91 * The JVM arguments are passed to the underlying JVM running the tool. 92 * Arguments will automatically be prepended with "-J". 93 * 94 * Any platform specific arguments required for running the tool are 95 * automatically added. 96 * 97 * 98 * @param arg 99 * The argument to VM running the tool 100 * @return The JDKToolLauncher instance 101 */ 102 public JDKToolLauncher addVMArg(String arg) { 103 vmArgs.add(arg); 104 return this; 105 } 106 107 /** 108 * Adds an argument to the tool. 109 * 110 * @param arg 111 * The argument to the tool 112 * @return The JDKToolLauncher instance 113 */ 114 public JDKToolLauncher addToolArg(String arg) { 115 toolArgs.add(arg); 116 return this; 117 } 118 119 /** 120 * Returns the command that can be used for running the tool. 121 * 122 * @return An array whose elements are the arguments of the command. 123 */ 124 public String[] getCommand() { 125 List<String> command = new ArrayList<String>(); 126 command.add(executable); 127 // Add -J in front of all vmArgs 128 for (String arg : vmArgs) { 129 command.add("-J" + arg); 130 } 131 command.addAll(toolArgs); 132 return command.toArray(new String[command.size()]); 133 } 134 }