1 /* 2 * Copyright (c) 2015, 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 package com.sun.tools.jextract; 24 25 import jdk.internal.joptsimple.OptionException; 26 import jdk.internal.joptsimple.OptionParser; 27 import jdk.internal.joptsimple.OptionSet; 28 import jdk.internal.joptsimple.util.KeyValuePair; 29 30 import java.io.File; 31 import java.io.IOException; 32 import java.io.PrintWriter; 33 import java.nio.file.Files; 34 import java.nio.file.Path; 35 import java.nio.file.Paths; 36 import java.text.MessageFormat; 37 import java.util.List; 38 import java.util.Locale; 39 import java.util.ResourceBundle; 40 import java.util.logging.ConsoleHandler; 41 import java.util.logging.Level; 42 import java.util.logging.Logger; 43 import java.util.logging.SimpleFormatter; 44 import java.util.regex.PatternSyntaxException; 45 import java.util.spi.ToolProvider; 46 47 public final class Main { 48 public static final boolean DEBUG = Boolean.getBoolean("jextract.debug"); 49 50 // FIXME: Remove this if/when the macros support is deemed stable 51 public static boolean INCLUDE_MACROS = Boolean.parseBoolean(System.getProperty("jextract.INCLUDE_MACROS", "true")); 52 53 private static final String MESSAGES_RESOURCE = "com.sun.tools.jextract.resources.Messages"; 54 55 private static final ResourceBundle MESSAGES_BUNDLE; 56 static { 57 MESSAGES_BUNDLE = ResourceBundle.getBundle(MESSAGES_RESOURCE, Locale.getDefault()); 58 } 59 60 public static String format(String msgId, Object... args) { 61 return new MessageFormat(MESSAGES_BUNDLE.getString(msgId)).format(args); 62 } 63 64 private final Context ctx; 65 private String targetPackage; 66 67 public Main(Context ctx) { 68 this.ctx = ctx; 69 } 70 71 private void processPackageMapping(Object arg) { 72 String str = (String) arg; 73 Path p = null; 74 String pkgName; 75 if (str.indexOf('=') == -1) { 76 pkgName = str; 77 } else { 78 KeyValuePair kv = KeyValuePair.valueOf(str); 79 p = Paths.get(kv.key); 80 pkgName = kv.value; 81 82 if (!Files.isDirectory(p)) { 83 throw new IllegalArgumentException(format("not.a.directory", kv.key)); 84 } 85 } 86 87 Utils.validPackageName(pkgName); 88 ctx.usePackageForFolder(p, pkgName); 89 } 90 91 private void processHeader(Object header) { 92 Path p = Paths.get((String) header); 93 if (!Files.isReadable(p)) { 94 throw new IllegalArgumentException(format("cannot.read.header.file", header)); 95 } 96 p = p.toAbsolutePath(); 97 ctx.usePackageForFolder(p.getParent(), targetPackage); 98 ctx.addSource(p); 99 } 100 101 private void setupLogging(Level level) { 102 Logger logger = ctx.logger; 103 logger.setUseParentHandlers(false); 104 ConsoleHandler log = new ConsoleHandler(); 105 System.setProperty("java.util.logging.SimpleFormatter.format", "%4$s: %5$s%n"); 106 log.setFormatter(new SimpleFormatter()); 107 logger.setLevel(level); 108 log.setLevel(level); 109 logger.addHandler(log); 110 } 111 112 private void printHelp(OptionParser parser) { 113 try { 114 parser.printHelpOn(ctx.err); 115 } catch (IOException ex) { 116 if (Main.DEBUG) { 117 ex.printStackTrace(ctx.err); 118 } 119 } 120 } 121 122 public int run(String[] args) { 123 OptionParser parser = new OptionParser(); 124 parser.accepts("dry-run", format("help.dry_run")); 125 parser.accepts("I", format("help.I")).withRequiredArg(); 126 // option is expected to specify paths to load shared libraries 127 // to check & warn missing symbols during jextract session. 128 parser.accepts("L", format("help.L")).withRequiredArg(); 129 parser.accepts("l", format("help.l")).withRequiredArg(); 130 parser.accepts("d", format("help.d")).withRequiredArg(); 131 parser.acceptsAll(List.of("o", "jar"), format("help.o")).withRequiredArg(); 132 parser.acceptsAll(List.of("t", "target-package"), format("help.t")).withRequiredArg(); 133 parser.acceptsAll(List.of("m", "package-map"), format("help.m")).withRequiredArg(); 134 parser.acceptsAll(List.of("?", "h", "help"), format("help.h")).forHelp(); 135 parser.accepts("C", format("help.C")).withRequiredArg(); 136 parser.accepts("log", format("help.log")).withRequiredArg(); 137 parser.accepts("exclude-symbols", format("help.exclude_symbols")).withRequiredArg(); 138 parser.accepts("rpath", format("help.rpath")).withRequiredArg(); 139 parser.accepts("infer-rpath", format("help.infer.rpath")); 140 parser.nonOptions(format("help.non.option")); 141 142 OptionSet options = null; 143 try { 144 options = parser.parse(args); 145 } catch (OptionException oe) { 146 ctx.err.println(oe.getMessage()); 147 if (Main.DEBUG) { 148 oe.printStackTrace(ctx.err); 149 } 150 printHelp(parser); 151 return 1; 152 } 153 154 if (args.length == 0 || options.has("h")) { 155 printHelp(parser); 156 return args.length == 0? 1 : 0; 157 } 158 159 if (options.nonOptionArguments().isEmpty()) { 160 ctx.err.println(format("err.no.input.files")); 161 return 2; 162 } 163 164 if (options.has("log")) { 165 setupLogging(Level.parse((String) options.valueOf("log"))); 166 } else { 167 setupLogging(Level.WARNING); 168 } 169 170 if (options.has("I")) { 171 options.valuesOf("I").forEach(p -> ctx.addClangArg("-I" + p)); 172 } 173 174 // append the built-in headers directory 175 ctx.addClangArg("-I" + getBuiltinHeadersDir()); 176 177 if (options.has("C")) { 178 options.valuesOf("C").forEach(p -> ctx.addClangArg((String) p)); 179 } 180 181 if (options.has("l")) { 182 for (Object arg : options.valuesOf("l")) { 183 String lib = (String)arg; 184 if (lib.indexOf(File.separatorChar) != -1) { 185 ctx.err.println(format("l.name.should.not.be.path", lib)); 186 return 1; 187 } 188 ctx.addLibraryName(lib); 189 } 190 } 191 192 boolean infer_rpath = options.has("infer-rpath"); 193 if (options.has("rpath")) { 194 if (infer_rpath) { 195 //conflicting rpaths options 196 ctx.err.println(format("warn.rpath.auto.conflict")); 197 infer_rpath = false; 198 } 199 200 // "rpath" with no "l" option! 201 if (options.has("l")) { 202 options.valuesOf("rpath").forEach(p -> ctx.addLibraryPath((String) p)); 203 } else { 204 ctx.err.println(format("warn.rpath.without.l")); 205 } 206 } 207 208 if (options.has("exclude-symbols")) { 209 try { 210 options.valuesOf("exclude-symbols").forEach(sym -> ctx.addExcludeSymbols((String) sym)); 211 } catch (PatternSyntaxException pse) { 212 ctx.err.println(format("exclude.symbols.pattern.error", pse.getMessage())); 213 } 214 } 215 216 if (options.has("L")) { 217 List<?> libpaths = options.valuesOf("L"); 218 // "L" with no "l" option! 219 if (options.has("l")) { 220 libpaths.forEach(p -> ctx.addLinkCheckPath((String) p)); 221 if (infer_rpath) { 222 libpaths.forEach(p -> ctx.addLibraryPath((String) p)); 223 } 224 } else { 225 ctx.err.println(format("warn.L.without.l")); 226 } 227 } else if (infer_rpath) { 228 ctx.err.println(format("warn.rpath.auto.without.L")); 229 } 230 231 targetPackage = options.has("t") ? (String) options.valueOf("t") : ""; 232 if (!targetPackage.isEmpty()) { 233 Utils.validPackageName(targetPackage); 234 } 235 236 if (options.has("m")) { 237 options.valuesOf("m").forEach(this::processPackageMapping); 238 } 239 240 try { 241 options.nonOptionArguments().stream().forEach(this::processHeader); 242 ctx.parse(); 243 } catch (RuntimeException re) { 244 ctx.err.println(re.getMessage()); 245 if (Main.DEBUG) { 246 re.printStackTrace(ctx.err); 247 } 248 return 2; 249 } 250 251 if (options.has("dry-run")) { 252 return 0; 253 } 254 255 boolean hasOutput = false; 256 257 if (options.has("d")) { 258 hasOutput = true; 259 Path dest = Paths.get((String) options.valueOf("d")); 260 dest = dest.toAbsolutePath(); 261 try { 262 if (!Files.exists(dest)) { 263 Files.createDirectories(dest); 264 } else if (!Files.isDirectory(dest)) { 265 ctx.err.println(format("not.a.directory", dest)); 266 return 4; 267 } 268 ctx.collectClassFiles(dest, args, targetPackage); 269 } catch (IOException ex) { 270 ctx.err.println(format("cannot.write.class.file", dest, ex)); 271 if (Main.DEBUG) { 272 ex.printStackTrace(ctx.err); 273 } 274 return 5; 275 } 276 } 277 278 String outputName; 279 if (options.has("o")) { 280 outputName = (String) options.valueOf("o"); 281 } else if (hasOutput) { 282 return 0; 283 } else { 284 outputName = Paths.get((String)options.nonOptionArguments().get(0)).getFileName() + ".jar"; 285 } 286 287 try { 288 ctx.collectJarFile(Paths.get(outputName), args, targetPackage); 289 } catch (IOException ex) { 290 ctx.err.println(format("cannot.write.jar.file", outputName, ex)); 291 if (Main.DEBUG) { 292 ex.printStackTrace(ctx.err); 293 } 294 return 3; 295 } 296 297 return 0; 298 } 299 300 private static Path getBuiltinHeadersDir() { 301 return Paths.get(System.getProperty("java.home"), "conf", "jextract"); 302 } 303 304 public static void main(String... args) { 305 Main instance = new Main(new Context()); 306 307 System.exit(instance.run(args)); 308 } 309 310 public static class JextractToolProvider implements ToolProvider { 311 @Override 312 public String name() { 313 return "jextract"; 314 } 315 316 @Override 317 public int run(PrintWriter out, PrintWriter err, String... args) { 318 // defensive check to throw security exception early. 319 // Note that the successful run of jextract under security 320 // manager would require far more permissions like loading 321 // library (clang), file system access etc. 322 if (System.getSecurityManager() != null) { 323 System.getSecurityManager(). 324 checkPermission(new RuntimePermission("jextract")); 325 } 326 327 Main instance = new Main(new Context(out, err)); 328 return instance.run(args); 329 } 330 } 331 }