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