SjavacImpl.java revision 3080:155f6671cab4
1/* 2 * Copyright (c) 2014, 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. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25package com.sun.tools.sjavac.comp; 26 27import java.io.IOException; 28import java.io.PrintWriter; 29import java.io.Writer; 30import java.nio.file.Files; 31import java.nio.file.Path; 32import java.util.ArrayList; 33import java.util.Collections; 34import java.util.HashMap; 35import java.util.HashSet; 36import java.util.List; 37import java.util.Map; 38import java.util.Set; 39import java.util.stream.Stream; 40 41import com.sun.tools.javac.file.JavacFileManager; 42import com.sun.tools.javac.main.Main; 43import com.sun.tools.javac.util.Context; 44import com.sun.tools.sjavac.JavacState; 45import com.sun.tools.sjavac.Log; 46import com.sun.tools.sjavac.Module; 47import com.sun.tools.sjavac.ProblemException; 48import com.sun.tools.sjavac.Source; 49import com.sun.tools.sjavac.Transformer; 50import com.sun.tools.sjavac.Util; 51import com.sun.tools.sjavac.options.Option; 52import com.sun.tools.sjavac.options.Options; 53import com.sun.tools.sjavac.options.SourceLocation; 54import com.sun.tools.sjavac.server.Sjavac; 55 56import javax.tools.JavaFileManager; 57 58/** 59 * The sjavac implementation that interacts with javac and performs the actual 60 * compilation. 61 * 62 * <p><b>This is NOT part of any supported API. 63 * If you write code that depends on this, you do so at your own risk. 64 * This code and its internal interfaces are subject to change or 65 * deletion without notice.</b> 66 */ 67public class SjavacImpl implements Sjavac { 68 69 @Override 70 public int compile(String[] args, Writer out, Writer err) { 71 Options options; 72 try { 73 options = Options.parseArgs(args); 74 } catch (IllegalArgumentException e) { 75 Log.error(e.getMessage()); 76 return RC_FATAL; 77 } 78 79 Log.setLogLevel(options.getLogLevel()); 80 81 if (!validateOptions(options)) 82 return RC_FATAL; 83 84 if (!createIfMissing(options.getDestDir())) 85 return RC_FATAL; 86 87 Path stateDir = options.getStateDir(); 88 if (stateDir != null && !createIfMissing(options.getStateDir())) 89 return RC_FATAL; 90 91 Path gensrc = options.getGenSrcDir(); 92 if (gensrc != null && !createIfMissing(gensrc)) 93 return RC_FATAL; 94 95 Path hdrdir = options.getHeaderDir(); 96 if (hdrdir != null && !createIfMissing(hdrdir)) 97 return RC_FATAL; 98 99 if (stateDir == null) { 100 // Prepare context. Direct logging to our byte array stream. 101 Context context = new Context(); 102 PrintWriter writer = new PrintWriter(err); 103 com.sun.tools.javac.util.Log.preRegister(context, writer); 104 JavacFileManager.preRegister(context); 105 106 // Prepare arguments 107 String[] passThroughArgs = Stream.of(args) 108 .filter(arg -> !arg.startsWith(Option.SERVER.arg)) 109 .toArray(String[]::new); 110 111 // Compile 112 com.sun.tools.javac.main.Main compiler = new com.sun.tools.javac.main.Main("javac", writer); 113 Main.Result result = compiler.compile(passThroughArgs, context); 114 115 // Clean up 116 JavaFileManager fileManager = context.get(JavaFileManager.class); 117 if (fileManager instanceof JavacFileManager) { 118 ((JavacFileManager) fileManager).close(); 119 } 120 return result.exitCode; 121 122 } else { 123 // Load the prev build state database. 124 JavacState javac_state = JavacState.load(options, out, err); 125 126 // Setup the suffix rules from the command line. 127 Map<String, Transformer> suffixRules = new HashMap<>(); 128 129 // Handling of .java-compilation 130 suffixRules.putAll(javac_state.getJavaSuffixRule()); 131 132 // Handling of -copy and -tr 133 suffixRules.putAll(options.getTranslationRules()); 134 135 // All found modules are put here. 136 Map<String,Module> modules = new HashMap<>(); 137 // We start out in the legacy empty no-name module. 138 // As soon as we stumble on a module-info.java file we change to that module. 139 Module current_module = new Module("", ""); 140 modules.put("", current_module); 141 142 // Find all sources, use the suffix rules to know which files are sources. 143 Map<String,Source> sources = new HashMap<>(); 144 145 // Find the files, this will automatically populate the found modules 146 // with found packages where the sources are found! 147 findSourceFiles(options.getSources(), 148 suffixRules.keySet(), 149 sources, 150 modules, 151 current_module, 152 options.isDefaultPackagePermitted(), 153 false); 154 155 if (sources.isEmpty()) { 156 Log.error("Found nothing to compile!"); 157 return RC_FATAL; 158 } 159 160 161 // Create a map of all source files that are available for linking. Both -src and 162 // -sourcepath point to such files. It is possible to specify multiple 163 // -sourcepath options to enable different filtering rules. If the 164 // filters are the same for multiple sourcepaths, they may be concatenated 165 // using :(;). Before sending the list of sourcepaths to javac, they are 166 // all concatenated. The list created here is used by the SmartFileWrapper to 167 // make sure only the correct sources are actually available. 168 // We might find more modules here as well. 169 Map<String,Source> sources_to_link_to = new HashMap<>(); 170 171 List<SourceLocation> sourceResolutionLocations = new ArrayList<>(); 172 sourceResolutionLocations.addAll(options.getSources()); 173 sourceResolutionLocations.addAll(options.getSourceSearchPaths()); 174 findSourceFiles(sourceResolutionLocations, 175 Collections.singleton(".java"), 176 sources_to_link_to, 177 modules, 178 current_module, 179 options.isDefaultPackagePermitted(), 180 true); 181 182 // Add the set of sources to the build database. 183 javac_state.now().flattenPackagesSourcesAndArtifacts(modules); 184 javac_state.now().checkInternalState("checking sources", false, sources); 185 javac_state.now().checkInternalState("checking linked sources", true, sources_to_link_to); 186 javac_state.setVisibleSources(sources_to_link_to); 187 188 int round = 0; 189 printRound(round); 190 191 // If there is any change in the source files, taint packages 192 // and mark the database in need of saving. 193 javac_state.checkSourceStatus(false); 194 195 // Find all existing artifacts. Their timestamp will match the last modified timestamps stored 196 // in javac_state, simply because loading of the JavacState will clean out all artifacts 197 // that do not match the javac_state database. 198 javac_state.findAllArtifacts(); 199 200 // Remove unidentified artifacts from the bin, gensrc and header dirs. 201 // (Unless we allow them to be there.) 202 // I.e. artifacts that are not known according to the build database (javac_state). 203 // For examples, files that have been manually copied into these dirs. 204 // Artifacts with bad timestamps (ie the on disk timestamp does not match the timestamp 205 // in javac_state) have already been removed when the javac_state was loaded. 206 if (!options.areUnidentifiedArtifactsPermitted()) { 207 javac_state.removeUnidentifiedArtifacts(); 208 } 209 // Go through all sources and taint all packages that miss artifacts. 210 javac_state.taintPackagesThatMissArtifacts(); 211 212 try { 213 // Check recorded classpath public apis. Taint packages that depend on 214 // classpath classes whose public apis have changed. 215 javac_state.taintPackagesDependingOnChangedClasspathPackages(); 216 217 // Now clean out all known artifacts belonging to tainted packages. 218 javac_state.deleteClassArtifactsInTaintedPackages(); 219 // Copy files, for example property files, images files, xml files etc etc. 220 javac_state.performCopying(Util.pathToFile(options.getDestDir()), suffixRules); 221 // Translate files, for example compile properties or compile idls. 222 javac_state.performTranslation(Util.pathToFile(gensrc), suffixRules); 223 // Add any potentially generated java sources to the tobe compiled list. 224 // (Generated sources must always have a package.) 225 Map<String,Source> generated_sources = new HashMap<>(); 226 227 Source.scanRoot(Util.pathToFile(options.getGenSrcDir()), Util.set(".java"), null, null, null, null, 228 generated_sources, modules, current_module, false, true, false); 229 javac_state.now().flattenPackagesSourcesAndArtifacts(modules); 230 // Recheck the the source files and their timestamps again. 231 javac_state.checkSourceStatus(true); 232 233 // Now do a safety check that the list of source files is identical 234 // to the list Make believes we are compiling. If we do not get this 235 // right, then incremental builds will fail with subtility. 236 // If any difference is detected, then we will fail hard here. 237 // This is an important safety net. 238 javac_state.compareWithMakefileList(Util.pathToFile(options.getSourceReferenceList())); 239 240 // Do the compilations, repeatedly until no tainted packages exist. 241 boolean again; 242 // Collect the name of all compiled packages. 243 Set<String> recently_compiled = new HashSet<>(); 244 boolean[] rc = new boolean[1]; 245 246 CompilationService compilationService = new CompilationService(); 247 do { 248 if (round > 0) 249 printRound(round); 250 // Clean out artifacts in tainted packages. 251 javac_state.deleteClassArtifactsInTaintedPackages(); 252 again = javac_state.performJavaCompilations(compilationService, options, recently_compiled, rc); 253 if (!rc[0]) { 254 Log.debug("Compilation failed."); 255 break; 256 } 257 if (!again) { 258 Log.debug("Nothing left to do."); 259 } 260 round++; 261 } while (again); 262 Log.debug("No need to do another round."); 263 264 // Only update the state if the compile went well. 265 if (rc[0]) { 266 javac_state.save(); 267 // Reflatten only the artifacts. 268 javac_state.now().flattenArtifacts(modules); 269 // Remove artifacts that were generated during the last compile, but not this one. 270 javac_state.removeSuperfluousArtifacts(recently_compiled); 271 } 272 273 return rc[0] ? RC_OK : RC_FATAL; 274 } catch (ProblemException e) { 275 Log.error(e.getMessage()); 276 return RC_FATAL; 277 } catch (Exception e) { 278 e.printStackTrace(new PrintWriter(err)); 279 return RC_FATAL; 280 } 281 } 282 } 283 284 @Override 285 public void shutdown() { 286 // Nothing to clean up 287 } 288 289 private static boolean validateOptions(Options options) { 290 291 String err = null; 292 293 if (options.getDestDir() == null) { 294 err = "Please specify output directory."; 295 } else if (options.isJavaFilesAmongJavacArgs()) { 296 err = "Sjavac does not handle explicit compilation of single .java files."; 297 } else if (options.getServerConf() == null) { 298 err = "No server configuration provided."; 299 } else if (!options.getImplicitPolicy().equals("none")) { 300 err = "The only allowed setting for sjavac is -implicit:none"; 301 } else if (options.getSources().isEmpty() && options.getStateDir() != null) { 302 err = "You have to specify -src when using --state-dir."; 303 } else if (options.getTranslationRules().size() > 1 304 && options.getGenSrcDir() == null) { 305 err = "You have translators but no gensrc dir (-s) specified!"; 306 } 307 308 if (err != null) 309 Log.error(err); 310 311 return err == null; 312 313 } 314 315 private static boolean createIfMissing(Path dir) { 316 317 if (Files.isDirectory(dir)) 318 return true; 319 320 if (Files.exists(dir)) { 321 Log.error(dir + " is not a directory."); 322 return false; 323 } 324 325 try { 326 Files.createDirectories(dir); 327 } catch (IOException e) { 328 Log.error("Could not create directory: " + e.getMessage()); 329 return false; 330 } 331 332 return true; 333 } 334 335 /** Find source files in the given source locations. */ 336 public static void findSourceFiles(List<SourceLocation> sourceLocations, 337 Set<String> sourceTypes, 338 Map<String,Source> foundFiles, 339 Map<String, Module> foundModules, 340 Module currentModule, 341 boolean permitSourcesInDefaultPackage, 342 boolean inLinksrc) { 343 344 for (SourceLocation source : sourceLocations) { 345 source.findSourceFiles(sourceTypes, 346 foundFiles, 347 foundModules, 348 currentModule, 349 permitSourcesInDefaultPackage, 350 inLinksrc); 351 } 352 } 353 354 private static void printRound(int round) { 355 Log.debug("****************************************"); 356 Log.debug("* Round " + round + " *"); 357 Log.debug("****************************************"); 358 } 359} 360