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.codegen;
018
019 import com.google.common.collect.Lists;
020 import com.google.common.collect.Ordering;
021 import com.intellij.openapi.application.ApplicationManager;
022 import com.intellij.openapi.progress.ProcessCanceledException;
023 import com.intellij.openapi.vfs.VirtualFile;
024 import com.intellij.util.ArrayUtil;
025 import com.intellij.util.SmartList;
026 import com.intellij.util.containers.ContainerUtil;
027 import kotlin.Function0;
028 import org.jetbrains.annotations.Mutable;
029 import org.jetbrains.annotations.NotNull;
030 import org.jetbrains.annotations.Nullable;
031 import org.jetbrains.kotlin.codegen.context.CodegenContext;
032 import org.jetbrains.kotlin.codegen.context.FieldOwnerContext;
033 import org.jetbrains.kotlin.codegen.context.MethodContext;
034 import org.jetbrains.kotlin.codegen.context.PackageContext;
035 import org.jetbrains.kotlin.codegen.state.GenerationState;
036 import org.jetbrains.kotlin.config.IncrementalCompilation;
037 import org.jetbrains.kotlin.descriptors.CallableMemberDescriptor;
038 import org.jetbrains.kotlin.descriptors.DeclarationDescriptor;
039 import org.jetbrains.kotlin.descriptors.PackageFragmentDescriptor;
040 import org.jetbrains.kotlin.diagnostics.DiagnosticUtils;
041 import org.jetbrains.kotlin.load.java.JvmAbi;
042 import org.jetbrains.kotlin.load.java.JvmAnnotationNames;
043 import org.jetbrains.kotlin.load.kotlin.PackagePartClassUtils;
044 import org.jetbrains.kotlin.load.kotlin.incremental.IncrementalPackageFragmentProvider;
045 import org.jetbrains.kotlin.name.FqName;
046 import org.jetbrains.kotlin.psi.*;
047 import org.jetbrains.kotlin.resolve.BindingContext;
048 import org.jetbrains.kotlin.resolve.MemberComparator;
049 import org.jetbrains.kotlin.resolve.jvm.jvmSignature.JvmMethodSignature;
050 import org.jetbrains.kotlin.resolve.scopes.DescriptorKindFilter;
051 import org.jetbrains.kotlin.resolve.scopes.JetScope;
052 import org.jetbrains.kotlin.serialization.DescriptorSerializer;
053 import org.jetbrains.kotlin.serialization.PackageData;
054 import org.jetbrains.kotlin.serialization.ProtoBuf;
055 import org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedCallableMemberDescriptor;
056 import org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedPropertyDescriptor;
057 import org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedSimpleFunctionDescriptor;
058 import org.jetbrains.kotlin.serialization.jvm.BitEncoding;
059 import org.jetbrains.org.objectweb.asm.AnnotationVisitor;
060 import org.jetbrains.org.objectweb.asm.MethodVisitor;
061 import org.jetbrains.org.objectweb.asm.Type;
062 import org.jetbrains.org.objectweb.asm.commons.InstructionAdapter;
063 import org.jetbrains.org.objectweb.asm.commons.Method;
064
065 import java.util.*;
066
067 import static org.jetbrains.kotlin.codegen.AsmUtil.asmDescByFqNameWithoutInnerClasses;
068 import static org.jetbrains.kotlin.codegen.AsmUtil.method;
069 import static org.jetbrains.kotlin.load.kotlin.PackageClassUtils.getPackageClassFqName;
070 import static org.jetbrains.kotlin.resolve.jvm.AsmTypes.K_PACKAGE_TYPE;
071 import static org.jetbrains.kotlin.resolve.jvm.AsmTypes.getType;
072 import static org.jetbrains.kotlin.resolve.jvm.diagnostics.DiagnosticsPackage.*;
073 import static org.jetbrains.kotlin.resolve.jvm.diagnostics.JvmDeclarationOrigin.NO_ORIGIN;
074 import static org.jetbrains.kotlin.serialization.NameSerializationUtil.createNameResolver;
075 import static org.jetbrains.org.objectweb.asm.Opcodes.*;
076
077 public class PackageCodegen {
078 private final ClassBuilderOnDemand v;
079 private final GenerationState state;
080 private final Collection<JetFile> files;
081 private final Type packageClassType;
082 private final PackageFragmentDescriptor packageFragment;
083 private final PackageFragmentDescriptor compiledPackageFragment;
084 private final List<DeserializedCallableMemberDescriptor> previouslyCompiledCallables;
085
086 public PackageCodegen(@NotNull GenerationState state, @NotNull Collection<JetFile> files, @NotNull FqName fqName) {
087 this.state = state;
088 this.files = files;
089 this.packageFragment = getOnlyPackageFragment(fqName);
090 this.packageClassType = AsmUtil.asmTypeByFqNameWithoutInnerClasses(getPackageClassFqName(fqName));
091 this.compiledPackageFragment = getCompiledPackageFragment(fqName);
092 this.previouslyCompiledCallables = filterDeserializedCallables(compiledPackageFragment);
093
094 assert packageFragment != null || compiledPackageFragment != null : fqName.asString() + " " + files;
095
096 this.v = new ClassBuilderOnDemand(new Function0<ClassBuilder>() {
097 @Override
098 public ClassBuilder invoke() {
099 Collection<JetFile> files = PackageCodegen.this.files;
100 JetFile sourceFile = getRepresentativePackageFile(files);
101
102 ClassBuilder v = PackageCodegen.this.state.getFactory().newVisitor(
103 PackageFacade(packageFragment == null ? compiledPackageFragment : packageFragment),
104 packageClassType, PackagePartClassUtils.getPackageFilesWithCallables(files)
105 );
106 v.defineClass(sourceFile, V1_6,
107 ACC_PUBLIC | ACC_FINAL,
108 packageClassType.getInternalName(),
109 null,
110 "java/lang/Object",
111 ArrayUtil.EMPTY_STRING_ARRAY
112 );
113 //We don't generate any source information for package with multiple files
114 if (sourceFile != null) {
115 v.visitSource(sourceFile.getName(), null);
116 }
117 return v;
118 }
119 });
120 }
121
122 // Returns null if file has callables in several files
123 @Nullable
124 private JetFile getRepresentativePackageFile(@NotNull Collection<JetFile> packageFiles) {
125 if (!previouslyCompiledCallables.isEmpty()) {
126 return null;
127 }
128
129 List<JetFile> packageFilesWithCallables = PackagePartClassUtils.getPackageFilesWithCallables(packageFiles);
130 return packageFilesWithCallables.size() == 1 ? packageFilesWithCallables.get(0) : null;
131 }
132
133 @Nullable
134 private PackageFragmentDescriptor getCompiledPackageFragment(@NotNull FqName fqName) {
135 if (!IncrementalCompilation.ENABLED) {
136 return null;
137 }
138
139 // TODO rewrite it to something more robust when module system is implemented
140 for (PackageFragmentDescriptor fragment : state.getModule().getPackageFragmentProvider().getPackageFragments(fqName)) {
141 if (fragment instanceof IncrementalPackageFragmentProvider.IncrementalPackageFragment &&
142 ((IncrementalPackageFragmentProvider.IncrementalPackageFragment) fragment).getModuleId().equals(state.getModuleId())) {
143 return fragment;
144 }
145 }
146 return null;
147 }
148
149 @NotNull
150 private static List<DeserializedCallableMemberDescriptor> filterDeserializedCallables(@Nullable PackageFragmentDescriptor packageFragment) {
151 if (packageFragment == null) {
152 return Collections.emptyList();
153 }
154 List<DeserializedCallableMemberDescriptor> callables = Lists.newArrayList();
155 for (DeclarationDescriptor member : packageFragment.getMemberScope().getDescriptors(DescriptorKindFilter.CALLABLES, JetScope.ALL_NAME_FILTER)) {
156 if (member instanceof DeserializedCallableMemberDescriptor) {
157 callables.add((DeserializedCallableMemberDescriptor) member);
158 }
159 }
160 return callables;
161 }
162
163 private void generateDelegationsToPreviouslyCompiled(@NotNull @Mutable Map<CallableMemberDescriptor, Runnable> generateCallableMemberTasks) {
164 for (final DeserializedCallableMemberDescriptor member : previouslyCompiledCallables) {
165 generateCallableMemberTasks.put(member, new Runnable() {
166 @Override
167 public void run() {
168 FieldOwnerContext context = CodegenContext.STATIC.intoPackageFacade(
169 AsmUtil.asmTypeByFqNameWithoutInnerClasses(PackagePartClassUtils.getPackagePartFqName(member)),
170 compiledPackageFragment
171 );
172
173 MemberCodegen<?> memberCodegen = createCodegenForPartOfPackageFacade(context);
174
175 if (member instanceof DeserializedSimpleFunctionDescriptor) {
176 DeserializedSimpleFunctionDescriptor function = (DeserializedSimpleFunctionDescriptor) member;
177 memberCodegen.functionCodegen.generateMethod(OtherOrigin(function), function,
178 new FunctionGenerationStrategy() {
179 @Override
180 public void generateBody(
181 @NotNull MethodVisitor mv,
182 @NotNull FrameMap frameMap,
183 @NotNull JvmMethodSignature signature,
184 @NotNull MethodContext context,
185 @NotNull MemberCodegen<?> parentCodegen
186 ) {
187 throw new IllegalStateException("shouldn't be called");
188 }
189 }
190 );
191
192 memberCodegen.functionCodegen.generateDefaultIfNeeded(
193 context.intoFunction(function), function, OwnerKind.PACKAGE, DefaultParameterValueLoader.DEFAULT, null
194 );
195 }
196 else if (member instanceof DeserializedPropertyDescriptor) {
197 memberCodegen.propertyCodegen.generateInPackageFacade((DeserializedPropertyDescriptor) member);
198 }
199 else {
200 throw new IllegalStateException("Unexpected member: " + member);
201 }
202 }
203 });
204 }
205 }
206
207 public void generate(@NotNull CompilationErrorHandler errorHandler) {
208 List<JvmSerializationBindings> bindings = new ArrayList<JvmSerializationBindings>(files.size() + 1);
209
210 Map<CallableMemberDescriptor, Runnable> generateCallableMemberTasks = new HashMap<CallableMemberDescriptor, Runnable>();
211
212 for (JetFile file : files) {
213 try {
214 ClassBuilder builder = generate(file, generateCallableMemberTasks);
215 if (builder != null) {
216 bindings.add(builder.getSerializationBindings());
217 }
218 }
219 catch (ProcessCanceledException e) {
220 throw e;
221 }
222 catch (Throwable e) {
223 VirtualFile vFile = file.getVirtualFile();
224 errorHandler.reportException(e, vFile == null ? "no file" : vFile.getUrl());
225 DiagnosticUtils.throwIfRunningOnServer(e);
226 if (ApplicationManager.getApplication().isInternal()) {
227 //noinspection CallToPrintStackTrace
228 e.printStackTrace();
229 }
230 }
231 }
232
233 generateDelegationsToPreviouslyCompiled(generateCallableMemberTasks);
234
235 if (!generateCallableMemberTasks.isEmpty()) {
236 generatePackageFacadeClass(generateCallableMemberTasks, bindings);
237 }
238 }
239
240 private void generatePackageFacadeClass(
241 @NotNull Map<CallableMemberDescriptor, Runnable> tasks,
242 @NotNull List<JvmSerializationBindings> bindings
243 ) {
244 generateKotlinPackageReflectionField();
245
246 for (CallableMemberDescriptor member : Ordering.from(MemberComparator.INSTANCE).sortedCopy(tasks.keySet())) {
247 tasks.get(member).run();
248 }
249
250 bindings.add(v.getSerializationBindings());
251 writeKotlinPackageAnnotationIfNeeded(JvmSerializationBindings.union(bindings));
252 }
253
254 private void generateKotlinPackageReflectionField() {
255 MethodVisitor mv = v.newMethod(NO_ORIGIN, ACC_STATIC, "<clinit>", "()V", null, null);
256 Method method = method("createKotlinPackage", K_PACKAGE_TYPE, getType(Class.class));
257 InstructionAdapter iv = new InstructionAdapter(mv);
258 MemberCodegen.generateReflectionObjectField(state, packageClassType, v, method, JvmAbi.KOTLIN_PACKAGE_FIELD_NAME, iv);
259 iv.areturn(Type.VOID_TYPE);
260 FunctionCodegen.endVisit(mv, "package facade static initializer", null);
261 }
262
263 private void writeKotlinPackageAnnotationIfNeeded(@NotNull JvmSerializationBindings bindings) {
264 if (state.getClassBuilderMode() != ClassBuilderMode.FULL) {
265 return;
266 }
267
268 // SCRIPT: Do not write annotations for scripts (if any is??)
269 for (JetFile file : files) {
270 if (file.isScript()) return;
271 }
272
273 DescriptorSerializer serializer = DescriptorSerializer.createTopLevel(new JvmSerializerExtension(bindings, state.getTypeMapper()));
274 Collection<PackageFragmentDescriptor> packageFragments = Lists.newArrayList();
275 ContainerUtil.addIfNotNull(packageFragments, packageFragment);
276 ContainerUtil.addIfNotNull(packageFragments, compiledPackageFragment);
277 ProtoBuf.Package packageProto = serializer.packageProto(packageFragments).build();
278
279 if (packageProto.getMemberCount() == 0) return;
280
281 PackageData data = new PackageData(createNameResolver(serializer.getStringTable()), packageProto);
282
283 AnnotationVisitor av = v.newAnnotation(asmDescByFqNameWithoutInnerClasses(JvmAnnotationNames.KOTLIN_PACKAGE), true);
284 av.visit(JvmAnnotationNames.ABI_VERSION_FIELD_NAME, JvmAbi.VERSION);
285 AnnotationVisitor array = av.visitArray(JvmAnnotationNames.DATA_FIELD_NAME);
286 for (String string : BitEncoding.encodeBytes(data.toBytes())) {
287 array.visit(null, string);
288 }
289 array.visitEnd();
290 av.visitEnd();
291 }
292
293 @Nullable
294 private ClassBuilder generate(@NotNull JetFile file, @NotNull Map<CallableMemberDescriptor, Runnable> generateCallableMemberTasks) {
295 boolean generatePackagePart = false;
296 Type packagePartType = PackagePartClassUtils.getPackagePartType(file);
297 PackageContext packagePartContext = CodegenContext.STATIC.intoPackagePart(packageFragment, packagePartType);
298
299 for (JetDeclaration declaration : file.getDeclarations()) {
300 if (declaration instanceof JetProperty || declaration instanceof JetNamedFunction) {
301 generatePackagePart = true;
302 }
303 else if (declaration instanceof JetClassOrObject) {
304 JetClassOrObject classOrObject = (JetClassOrObject) declaration;
305 if (state.getGenerateDeclaredClassFilter().shouldGenerateClass(classOrObject)) {
306 generateClassOrObject(classOrObject);
307 }
308 }
309 else if (declaration instanceof JetScript) {
310 JetScript script = (JetScript) declaration;
311
312 // SCRIPT: generate script code, should be separate execution branch
313 if (state.getGenerateDeclaredClassFilter().shouldGenerateScript(script)) {
314 ScriptCodegen.createScriptCodegen(script, state, packagePartContext).generate();
315 }
316 }
317 }
318
319 if (!generatePackagePart || !state.getGenerateDeclaredClassFilter().shouldGeneratePackagePart(file)) return null;
320
321 ClassBuilder builder = state.getFactory().newVisitor(PackagePart(file, packageFragment), packagePartType, file);
322
323 new PackagePartCodegen(builder, file, packagePartType, packagePartContext, state).generate();
324
325 FieldOwnerContext packageFacade = CodegenContext.STATIC.intoPackageFacade(packagePartType, packageFragment);
326
327 final MemberCodegen<?> memberCodegen = createCodegenForPartOfPackageFacade(packageFacade);
328
329 for (final JetDeclaration declaration : file.getDeclarations()) {
330 if (declaration instanceof JetNamedFunction || declaration instanceof JetProperty) {
331 DeclarationDescriptor descriptor = state.getBindingContext().get(BindingContext.DECLARATION_TO_DESCRIPTOR, declaration);
332 assert descriptor instanceof CallableMemberDescriptor :
333 "Expected callable member, was " + descriptor + " for " + declaration.getText();
334 generateCallableMemberTasks.put(
335 (CallableMemberDescriptor) descriptor,
336 new Runnable() {
337 @Override
338 public void run() {
339 memberCodegen.genFunctionOrProperty(declaration);
340 }
341 }
342 );
343 }
344 }
345
346 return builder;
347 }
348
349 private MemberCodegen<?> createCodegenForPartOfPackageFacade(@NotNull FieldOwnerContext packageFacade) {
350 return new MemberCodegen<JetFile>(state, null, packageFacade, null, v) {
351 @Override
352 protected void generateDeclaration() {
353 throw new UnsupportedOperationException();
354 }
355
356 @Override
357 protected void generateBody() {
358 throw new UnsupportedOperationException();
359 }
360
361 @Override
362 protected void generateKotlinAnnotation() {
363 throw new UnsupportedOperationException();
364 }
365 };
366 }
367
368 @Nullable
369 private PackageFragmentDescriptor getOnlyPackageFragment(@NotNull FqName expectedFqName) {
370 SmartList<PackageFragmentDescriptor> fragments = new SmartList<PackageFragmentDescriptor>();
371 for (JetFile file : files) {
372 PackageFragmentDescriptor fragment = state.getBindingContext().get(BindingContext.FILE_TO_PACKAGE_FRAGMENT, file);
373 assert fragment != null : "package fragment is null for " + file + "\n" + file.getText();
374
375 assert expectedFqName.equals(fragment.getFqName()) :
376 "expected package fq name: " + expectedFqName + ", actual: " + fragment.getFqName();
377
378 if (!fragments.contains(fragment)) {
379 fragments.add(fragment);
380 }
381 }
382 if (fragments.size() > 1) {
383 throw new IllegalStateException("More than one package fragment, files: " + files + " | fragments: " + fragments);
384 }
385
386 if (fragments.isEmpty()) {
387 return null;
388 }
389 return fragments.get(0);
390 }
391
392 public void generateClassOrObject(@NotNull JetClassOrObject classOrObject) {
393 JetFile file = classOrObject.getContainingJetFile();
394 Type packagePartType = PackagePartClassUtils.getPackagePartType(file);
395 CodegenContext context = CodegenContext.STATIC.intoPackagePart(packageFragment, packagePartType);
396 MemberCodegen.genClassOrObject(context, classOrObject, state, null);
397 }
398
399 public void done() {
400 v.done();
401 }
402 }