001 /*
002 * Copyright 2010-2015 JetBrains s.r.o.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017 package org.jetbrains.kotlin.cli.jvm.compiler;
018
019 import com.google.common.base.Function;
020 import com.google.common.base.Joiner;
021 import com.google.common.collect.Collections2;
022 import com.google.common.collect.Lists;
023 import com.google.common.collect.Maps;
024 import com.intellij.util.ArrayUtil;
025 import kotlin.Unit;
026 import kotlin.jvm.functions.Function0;
027 import kotlin.jvm.functions.Function1;
028 import org.jetbrains.annotations.NotNull;
029 import org.jetbrains.annotations.Nullable;
030 import org.jetbrains.kotlin.analyzer.AnalysisResult;
031 import org.jetbrains.kotlin.asJava.FilteredJvmDiagnostics;
032 import org.jetbrains.kotlin.cli.common.CLIConfigurationKeys;
033 import org.jetbrains.kotlin.cli.common.CompilerPlugin;
034 import org.jetbrains.kotlin.cli.common.CompilerPluginContext;
035 import org.jetbrains.kotlin.cli.common.messages.AnalyzerWithCompilerReport;
036 import org.jetbrains.kotlin.cli.common.messages.MessageCollector;
037 import org.jetbrains.kotlin.cli.common.output.outputUtils.OutputUtilsKt;
038 import org.jetbrains.kotlin.cli.jvm.K2JVMCompiler;
039 import org.jetbrains.kotlin.cli.jvm.config.JVMConfigurationKeys;
040 import org.jetbrains.kotlin.cli.jvm.config.JvmContentRootsKt;
041 import org.jetbrains.kotlin.cli.jvm.config.ModuleNameKt;
042 import org.jetbrains.kotlin.codegen.*;
043 import org.jetbrains.kotlin.codegen.state.GenerationState;
044 import org.jetbrains.kotlin.config.CompilerConfiguration;
045 import org.jetbrains.kotlin.config.ContentRootsKt;
046 import org.jetbrains.kotlin.context.ModuleContext;
047 import org.jetbrains.kotlin.fileClasses.JvmFileClassUtil;
048 import org.jetbrains.kotlin.idea.MainFunctionDetector;
049 import org.jetbrains.kotlin.load.kotlin.ModuleVisibilityManager;
050 import org.jetbrains.kotlin.load.kotlin.incremental.components.IncrementalCache;
051 import org.jetbrains.kotlin.load.kotlin.incremental.components.IncrementalCompilationComponents;
052 import org.jetbrains.kotlin.modules.JavaRootPath;
053 import org.jetbrains.kotlin.modules.Module;
054 import org.jetbrains.kotlin.modules.TargetId;
055 import org.jetbrains.kotlin.modules.TargetIdKt;
056 import org.jetbrains.kotlin.name.FqName;
057 import org.jetbrains.kotlin.parsing.KotlinScriptDefinition;
058 import org.jetbrains.kotlin.parsing.KotlinScriptDefinitionProvider;
059 import org.jetbrains.kotlin.progress.ProgressIndicatorAndCompilationCanceledStatus;
060 import org.jetbrains.kotlin.psi.KtFile;
061 import org.jetbrains.kotlin.resolve.AnalyzerScriptParameter;
062 import org.jetbrains.kotlin.resolve.BindingTrace;
063 import org.jetbrains.kotlin.resolve.BindingTraceContext;
064 import org.jetbrains.kotlin.resolve.ScriptNameUtil;
065 import org.jetbrains.kotlin.resolve.jvm.JvmClassName;
066 import org.jetbrains.kotlin.resolve.jvm.TopDownAnalyzerFacadeForJVM;
067 import org.jetbrains.kotlin.util.PerformanceCounter;
068 import org.jetbrains.kotlin.utils.KotlinPaths;
069
070 import java.io.File;
071 import java.net.URL;
072 import java.net.URLClassLoader;
073 import java.util.*;
074 import java.util.concurrent.TimeUnit;
075
076 public class KotlinToJVMBytecodeCompiler {
077
078 private KotlinToJVMBytecodeCompiler() {
079 }
080
081 @NotNull
082 private static List<String> getAbsolutePaths(@NotNull File directory, @NotNull Module module) {
083 List<String> result = Lists.newArrayList();
084
085 for (String sourceFile : module.getSourceFiles()) {
086 File source = new File(sourceFile);
087 if (!source.isAbsolute()) {
088 source = new File(directory, sourceFile);
089 }
090 result.add(source.getAbsolutePath());
091 }
092 return result;
093 }
094
095 private static void writeOutput(
096 @NotNull CompilerConfiguration configuration,
097 @NotNull ClassFileFactory outputFiles,
098 @Nullable File outputDir,
099 @Nullable File jarPath,
100 boolean jarRuntime,
101 @Nullable FqName mainClass
102 ) {
103 if (jarPath != null) {
104 CompileEnvironmentUtil.writeToJar(jarPath, jarRuntime, mainClass, outputFiles);
105 }
106 else {
107 MessageCollector messageCollector = configuration.get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, MessageCollector.NONE);
108 OutputUtilsKt.writeAll(outputFiles, outputDir == null ? new File(".") : outputDir, messageCollector);
109 }
110 }
111
112 public static boolean compileModules(
113 @NotNull KotlinCoreEnvironment environment,
114 @NotNull CompilerConfiguration configuration,
115 @NotNull List<Module> chunk,
116 @NotNull File directory,
117 @Nullable File jarPath,
118 @NotNull List<String> friendPaths,
119 boolean jarRuntime
120 ) {
121 Map<Module, ClassFileFactory> outputFiles = Maps.newHashMap();
122
123 ProgressIndicatorAndCompilationCanceledStatus.checkCanceled();
124
125 ModuleVisibilityManager moduleVisibilityManager = ModuleVisibilityManager.SERVICE.getInstance(environment.getProject());
126
127 for (Module module: chunk) {
128 moduleVisibilityManager.addModule(module);
129 }
130
131 for (String path : friendPaths) {
132 moduleVisibilityManager.addFriendPath(path);
133 }
134
135 String targetDescription = "in targets [" + Joiner.on(", ").join(Collections2.transform(chunk, new Function<Module, String>() {
136 @Override
137 public String apply(@Nullable Module input) {
138 return input != null ? input.getModuleName() + "-" + input.getModuleType() : "<null>";
139 }
140 })) + "] ";
141 AnalysisResult result = analyze(environment, targetDescription);
142 if (result == null) {
143 return false;
144 }
145
146 ProgressIndicatorAndCompilationCanceledStatus.checkCanceled();
147
148 result.throwIfError();
149
150 for (Module module : chunk) {
151 ProgressIndicatorAndCompilationCanceledStatus.checkCanceled();
152 List<KtFile> jetFiles = CompileEnvironmentUtil.getKtFiles(
153 environment.getProject(), getAbsolutePaths(directory, module), new Function1<String, Unit>() {
154 @Override
155 public Unit invoke(String s) {
156 throw new IllegalStateException("Should have been checked before: " + s);
157 }
158 }
159 );
160 File moduleOutputDirectory = new File(module.getOutputDirectory());
161 GenerationState generationState =
162 generate(environment, result, jetFiles, module, moduleOutputDirectory,
163 module.getModuleName());
164 outputFiles.put(module, generationState.getFactory());
165 }
166
167 for (Module module : chunk) {
168 ProgressIndicatorAndCompilationCanceledStatus.checkCanceled();
169 writeOutput(configuration, outputFiles.get(module), new File(module.getOutputDirectory()), jarPath, jarRuntime, null);
170 }
171 return true;
172 }
173
174 @NotNull
175 public static CompilerConfiguration createCompilerConfiguration(
176 @NotNull CompilerConfiguration base,
177 @NotNull List<Module> chunk,
178 @NotNull File directory
179 ) {
180 CompilerConfiguration configuration = base.copy();
181
182 for (Module module : chunk) {
183 ContentRootsKt.addKotlinSourceRoots(configuration, getAbsolutePaths(directory, module));
184 }
185
186 for (Module module : chunk) {
187 for (JavaRootPath javaRootPath : module.getJavaSourceRoots()) {
188 JvmContentRootsKt.addJavaSourceRoot(configuration, new File(javaRootPath.getPath()), javaRootPath.getPackagePrefix());
189 }
190 }
191
192 for (Module module : chunk) {
193 for (String classpathRoot : module.getClasspathRoots()) {
194 JvmContentRootsKt.addJvmClasspathRoot(configuration, new File(classpathRoot));
195 }
196 }
197
198 for (Module module : chunk) {
199 configuration.add(JVMConfigurationKeys.MODULES, module);
200 }
201
202 return configuration;
203 }
204
205 @Nullable
206 private static FqName findMainClass(@NotNull GenerationState generationState, @NotNull List<KtFile> files) {
207 MainFunctionDetector mainFunctionDetector = new MainFunctionDetector(generationState.getBindingContext());
208 FqName mainClass = null;
209 for (KtFile file : files) {
210 if (mainFunctionDetector.hasMain(file.getDeclarations())) {
211 if (mainClass != null) {
212 // more than one main
213 return null;
214 }
215 FqName fqName = file.getPackageFqName();
216 mainClass = JvmFileClassUtil.getFileClassInfoNoResolve(file).getFacadeClassFqName();
217 }
218 }
219 return mainClass;
220 }
221
222 public static boolean compileBunchOfSources(
223 @NotNull KotlinCoreEnvironment environment,
224 @Nullable File jar,
225 @Nullable File outputDir,
226 @NotNull List<String> friendPaths,
227 boolean includeRuntime
228 ) {
229
230 ModuleVisibilityManager moduleVisibilityManager = ModuleVisibilityManager.SERVICE.getInstance(environment.getProject());
231
232 for (String path : friendPaths) {
233 moduleVisibilityManager.addFriendPath(path);
234 }
235
236 GenerationState generationState = analyzeAndGenerate(environment);
237 if (generationState == null) {
238 return false;
239 }
240
241 FqName mainClass = findMainClass(generationState, environment.getSourceFiles());
242
243 try {
244 writeOutput(environment.getConfiguration(), generationState.getFactory(), outputDir, jar, includeRuntime, mainClass);
245 return true;
246 }
247 finally {
248 generationState.destroy();
249 }
250 }
251
252 public static void compileAndExecuteScript(
253 @NotNull CompilerConfiguration configuration,
254 @NotNull KotlinPaths paths,
255 @NotNull KotlinCoreEnvironment environment,
256 @NotNull List<String> scriptArgs
257 ) {
258 Class<?> scriptClass = compileScript(configuration, paths, environment);
259 if (scriptClass == null) return;
260
261 try {
262 scriptClass.getConstructor(String[].class).newInstance(new Object[] {ArrayUtil.toStringArray(scriptArgs)});
263 }
264 catch (RuntimeException e) {
265 throw e;
266 }
267 catch (Exception e) {
268 throw new RuntimeException("Failed to evaluate script: " + e, e);
269 }
270 }
271
272 @Nullable
273 public static Class<?> compileScript(
274 @NotNull CompilerConfiguration configuration,
275 @NotNull KotlinPaths paths,
276 @NotNull KotlinCoreEnvironment environment
277 ) {
278 List<AnalyzerScriptParameter> scriptParameters = environment.getConfiguration().getList(JVMConfigurationKeys.SCRIPT_PARAMETERS);
279 if (!scriptParameters.isEmpty()) {
280 KotlinScriptDefinitionProvider.getInstance(environment.getProject()).addScriptDefinition(
281 new KotlinScriptDefinition(".kts", scriptParameters)
282 );
283 }
284 GenerationState state = analyzeAndGenerate(environment);
285 if (state == null) {
286 return null;
287 }
288
289 GeneratedClassLoader classLoader;
290 try {
291 List<URL> classPaths = Lists.newArrayList(paths.getRuntimePath().toURI().toURL());
292 for (File file : JvmContentRootsKt.getJvmClasspathRoots(configuration)) {
293 classPaths.add(file.toURI().toURL());
294 }
295 //noinspection UnnecessaryFullyQualifiedName
296 classLoader = new GeneratedClassLoader(state.getFactory(),
297 new URLClassLoader(classPaths.toArray(new URL[classPaths.size()]), null)
298 );
299
300 FqName nameForScript = ScriptNameUtil.classNameForScript(environment.getSourceFiles().get(0).getScript());
301 return classLoader.loadClass(nameForScript.asString());
302 }
303 catch (Exception e) {
304 throw new RuntimeException("Failed to evaluate script: " + e, e);
305 }
306 }
307
308 @Nullable
309 public static GenerationState analyzeAndGenerate(@NotNull KotlinCoreEnvironment environment) {
310 AnalysisResult result = analyze(environment, null);
311
312 if (result == null) {
313 return null;
314 }
315
316 if (!result.getShouldGenerateCode()) return null;
317
318 result.throwIfError();
319
320 return generate(environment, result, environment.getSourceFiles(), null, null, null);
321 }
322
323 @Nullable
324 private static AnalysisResult analyze(@NotNull final KotlinCoreEnvironment environment, @Nullable String targetDescription) {
325 MessageCollector collector = environment.getConfiguration().get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY);
326 assert collector != null;
327
328 long analysisStart = PerformanceCounter.Companion.currentTime();
329 AnalyzerWithCompilerReport analyzerWithCompilerReport = new AnalyzerWithCompilerReport(collector);
330 analyzerWithCompilerReport.analyzeAndReport(
331 environment.getSourceFiles(), new Function0<AnalysisResult>() {
332 @NotNull
333 @Override
334 public AnalysisResult invoke() {
335 BindingTrace sharedTrace = new CliLightClassGenerationSupport.NoScopeRecordCliBindingTrace();
336 ModuleContext moduleContext = TopDownAnalyzerFacadeForJVM.createContextWithSealedModule(environment.getProject(),
337 ModuleNameKt
338 .getModuleName(environment));
339
340 return TopDownAnalyzerFacadeForJVM.analyzeFilesWithJavaIntegrationWithCustomContext(
341 moduleContext,
342 environment.getSourceFiles(),
343 sharedTrace,
344 environment.getConfiguration().get(JVMConfigurationKeys.MODULES),
345 environment.getConfiguration().get(JVMConfigurationKeys.INCREMENTAL_COMPILATION_COMPONENTS),
346 new JvmPackagePartProvider(environment)
347 );
348 }
349 }
350 );
351 long analysisNanos = PerformanceCounter.Companion.currentTime() - analysisStart;
352 String message = "ANALYZE: " + environment.getSourceFiles().size() + " files (" +
353 environment.getSourceLinesOfCode() + " lines) " +
354 (targetDescription != null ? targetDescription : "") +
355 "in " + TimeUnit.NANOSECONDS.toMillis(analysisNanos) + " ms";
356 K2JVMCompiler.Companion.reportPerf(environment.getConfiguration(), message);
357
358 AnalysisResult result = analyzerWithCompilerReport.getAnalysisResult();
359 assert result != null : "AnalysisResult should be non-null, compiling: " + environment.getSourceFiles();
360
361 CompilerPluginContext context = new CompilerPluginContext(environment.getProject(), result.getBindingContext(),
362 environment.getSourceFiles());
363 for (CompilerPlugin plugin : environment.getConfiguration().getList(CLIConfigurationKeys.COMPILER_PLUGINS)) {
364 plugin.processFiles(context);
365 }
366
367 return analyzerWithCompilerReport.hasErrors() ? null : result;
368 }
369
370 @NotNull
371 private static GenerationState generate(
372 @NotNull KotlinCoreEnvironment environment,
373 @NotNull AnalysisResult result,
374 @NotNull List<KtFile> sourceFiles,
375 @Nullable Module module,
376 File outputDirectory,
377 String moduleName
378 ) {
379 CompilerConfiguration configuration = environment.getConfiguration();
380 IncrementalCompilationComponents incrementalCompilationComponents = configuration.get(JVMConfigurationKeys.INCREMENTAL_COMPILATION_COMPONENTS);
381
382 Collection<FqName> packagesWithObsoleteParts;
383 List<FqName> obsoleteMultifileClasses;
384 TargetId targetId = null;
385
386 if (module == null || incrementalCompilationComponents == null) {
387 packagesWithObsoleteParts = Collections.emptySet();
388 obsoleteMultifileClasses = Collections.emptyList();
389 }
390 else {
391 targetId = TargetIdKt.TargetId(module);
392 IncrementalCache incrementalCache = incrementalCompilationComponents.getIncrementalCache(targetId);
393
394 packagesWithObsoleteParts = new HashSet<FqName>();
395 for (String internalName : incrementalCache.getObsoletePackageParts()) {
396 packagesWithObsoleteParts.add(JvmClassName.byInternalName(internalName).getPackageFqName());
397 }
398
399 obsoleteMultifileClasses = new ArrayList<FqName>();
400 for (String obsoleteFacadeInternalName : incrementalCache.getObsoleteMultifileClasses()) {
401 obsoleteMultifileClasses.add(JvmClassName.byInternalName(obsoleteFacadeInternalName).getFqNameForClassNameWithoutDollars());
402 }
403 }
404 BindingTraceContext diagnosticHolder = new BindingTraceContext();
405 GenerationState generationState = new GenerationState(
406 environment.getProject(),
407 ClassBuilderFactories.BINARIES,
408 result.getModuleDescriptor(),
409 result.getBindingContext(),
410 sourceFiles,
411 configuration.get(JVMConfigurationKeys.DISABLE_CALL_ASSERTIONS, false),
412 configuration.get(JVMConfigurationKeys.DISABLE_PARAM_ASSERTIONS, false),
413 GenerationState.GenerateClassFilter.GENERATE_ALL,
414 configuration.get(JVMConfigurationKeys.DISABLE_INLINE, false),
415 configuration.get(JVMConfigurationKeys.DISABLE_OPTIMIZATION, false),
416 /* useTypeTableInSerializer = */ false,
417 diagnosticHolder,
418 packagesWithObsoleteParts,
419 obsoleteMultifileClasses,
420 targetId,
421 moduleName,
422 outputDirectory,
423 incrementalCompilationComponents
424 );
425 ProgressIndicatorAndCompilationCanceledStatus.checkCanceled();
426
427 long generationStart = PerformanceCounter.Companion.currentTime();
428
429 KotlinCodegenFacade.compileCorrectFiles(generationState, CompilationErrorHandler.THROW_EXCEPTION);
430
431 long generationNanos = PerformanceCounter.Companion.currentTime() - generationStart;
432 String desc = module != null ? "target " + module.getModuleName() + "-" + module.getModuleType() + " " : "";
433 String message = "GENERATE: " + sourceFiles.size() + " files (" +
434 environment.countLinesOfCode(sourceFiles) + " lines) " + desc + "in " + TimeUnit.NANOSECONDS.toMillis(generationNanos) + " ms";
435 K2JVMCompiler.Companion.reportPerf(environment.getConfiguration(), message);
436 ProgressIndicatorAndCompilationCanceledStatus.checkCanceled();
437
438 AnalyzerWithCompilerReport.reportDiagnostics(
439 new FilteredJvmDiagnostics(
440 diagnosticHolder.getBindingContext().getDiagnostics(),
441 result.getBindingContext().getDiagnostics()
442 ),
443 environment.getConfiguration().get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY)
444 );
445 ProgressIndicatorAndCompilationCanceledStatus.checkCanceled();
446 return generationState;
447 }
448 }