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.jvm.functions.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.*;
053 import org.jetbrains.kotlin.serialization.deserialization.NameResolver;
054 import org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedCallableMemberDescriptor;
055 import org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedPropertyDescriptor;
056 import org.jetbrains.kotlin.serialization.deserialization.descriptors.DeserializedSimpleFunctionDescriptor;
057 import org.jetbrains.kotlin.serialization.jvm.BitEncoding;
058 import org.jetbrains.org.objectweb.asm.AnnotationVisitor;
059 import org.jetbrains.org.objectweb.asm.MethodVisitor;
060 import org.jetbrains.org.objectweb.asm.Type;
061 import org.jetbrains.org.objectweb.asm.commons.InstructionAdapter;
062 import org.jetbrains.org.objectweb.asm.commons.Method;
063
064 import java.util.*;
065
066 import static org.jetbrains.kotlin.codegen.AsmUtil.asmDescByFqNameWithoutInnerClasses;
067 import static org.jetbrains.kotlin.codegen.AsmUtil.method;
068 import static org.jetbrains.kotlin.load.kotlin.PackageClassUtils.getPackageClassFqName;
069 import static org.jetbrains.kotlin.resolve.jvm.AsmTypes.K_PACKAGE_TYPE;
070 import static org.jetbrains.kotlin.resolve.jvm.AsmTypes.getType;
071 import static org.jetbrains.kotlin.resolve.jvm.diagnostics.DiagnosticsPackage.*;
072 import static org.jetbrains.kotlin.resolve.jvm.diagnostics.JvmDeclarationOrigin.NO_ORIGIN;
073 import static org.jetbrains.org.objectweb.asm.Opcodes.*;
074
075 public class PackageCodegen {
076 private final ClassBuilderOnDemand v;
077 private final GenerationState state;
078 private final Collection<JetFile> files;
079 private final Type packageClassType;
080 private final PackageFragmentDescriptor packageFragment;
081 private final PackageFragmentDescriptor compiledPackageFragment;
082 private final List<DeserializedCallableMemberDescriptor> previouslyCompiledCallables;
083
084 public PackageCodegen(@NotNull GenerationState state, @NotNull Collection<JetFile> files, @NotNull FqName fqName) {
085 this.state = state;
086 this.files = files;
087 this.packageFragment = getOnlyPackageFragment(fqName);
088 this.packageClassType = AsmUtil.asmTypeByFqNameWithoutInnerClasses(getPackageClassFqName(fqName));
089 this.compiledPackageFragment = getCompiledPackageFragment(fqName);
090 this.previouslyCompiledCallables = filterDeserializedCallables(compiledPackageFragment);
091
092 assert packageFragment != null || compiledPackageFragment != null : fqName.asString() + " " + files;
093
094 this.v = new ClassBuilderOnDemand(new Function0<ClassBuilder>() {
095 @Override
096 public ClassBuilder invoke() {
097 Collection<JetFile> files = PackageCodegen.this.files;
098 JetFile sourceFile = getRepresentativePackageFile(files);
099
100 ClassBuilder v = PackageCodegen.this.state.getFactory().newVisitor(
101 PackageFacade(packageFragment == null ? compiledPackageFragment : packageFragment),
102 packageClassType, PackagePartClassUtils.getPackageFilesWithCallables(files)
103 );
104 v.defineClass(sourceFile, V1_6,
105 ACC_PUBLIC | ACC_FINAL,
106 packageClassType.getInternalName(),
107 null,
108 "java/lang/Object",
109 ArrayUtil.EMPTY_STRING_ARRAY
110 );
111 //We don't generate any source information for package with multiple files
112 if (sourceFile != null) {
113 v.visitSource(sourceFile.getName(), null);
114 }
115 return v;
116 }
117 });
118 }
119
120 // Returns null if file has callables in several files
121 @Nullable
122 private JetFile getRepresentativePackageFile(@NotNull Collection<JetFile> packageFiles) {
123 if (!previouslyCompiledCallables.isEmpty()) {
124 return null;
125 }
126
127 List<JetFile> packageFilesWithCallables = PackagePartClassUtils.getPackageFilesWithCallables(packageFiles);
128 return packageFilesWithCallables.size() == 1 ? packageFilesWithCallables.get(0) : null;
129 }
130
131 @Nullable
132 private PackageFragmentDescriptor getCompiledPackageFragment(@NotNull FqName fqName) {
133 if (!IncrementalCompilation.ENABLED) {
134 return null;
135 }
136
137 // TODO rewrite it to something more robust when module system is implemented
138 for (PackageFragmentDescriptor fragment : state.getModule().getPackage(fqName).getFragments()) {
139 if (fragment instanceof IncrementalPackageFragmentProvider.IncrementalPackageFragment &&
140 ((IncrementalPackageFragmentProvider.IncrementalPackageFragment) fragment).getModuleId().equals(state.getModuleId())) {
141 return fragment;
142 }
143 }
144 return null;
145 }
146
147 @NotNull
148 private static List<DeserializedCallableMemberDescriptor> filterDeserializedCallables(@Nullable PackageFragmentDescriptor packageFragment) {
149 if (packageFragment == null) {
150 return Collections.emptyList();
151 }
152 List<DeserializedCallableMemberDescriptor> callables = Lists.newArrayList();
153 for (DeclarationDescriptor member : packageFragment.getMemberScope().getDescriptors(DescriptorKindFilter.CALLABLES, JetScope.ALL_NAME_FILTER)) {
154 if (member instanceof DeserializedCallableMemberDescriptor) {
155 callables.add((DeserializedCallableMemberDescriptor) member);
156 }
157 }
158 return callables;
159 }
160
161 private void generateDelegationsToPreviouslyCompiled(@NotNull @Mutable Map<CallableMemberDescriptor, Runnable> generateCallableMemberTasks) {
162 for (final DeserializedCallableMemberDescriptor member : previouslyCompiledCallables) {
163 generateCallableMemberTasks.put(member, new Runnable() {
164 @Override
165 public void run() {
166 FieldOwnerContext context = CodegenContext.STATIC.intoPackageFacade(
167 AsmUtil.asmTypeByFqNameWithoutInnerClasses(PackagePartClassUtils.getPackagePartFqName(member)),
168 compiledPackageFragment
169 );
170
171 MemberCodegen<?> memberCodegen = createCodegenForPartOfPackageFacade(context);
172
173 if (member instanceof DeserializedSimpleFunctionDescriptor) {
174 DeserializedSimpleFunctionDescriptor function = (DeserializedSimpleFunctionDescriptor) member;
175 memberCodegen.functionCodegen.generateMethod(OtherOrigin(function), function,
176 new FunctionGenerationStrategy() {
177 @Override
178 public void generateBody(
179 @NotNull MethodVisitor mv,
180 @NotNull FrameMap frameMap,
181 @NotNull JvmMethodSignature signature,
182 @NotNull MethodContext context,
183 @NotNull MemberCodegen<?> parentCodegen
184 ) {
185 throw new IllegalStateException("shouldn't be called");
186 }
187 }
188 );
189
190 memberCodegen.functionCodegen.generateDefaultIfNeeded(
191 context.intoFunction(function), function, OwnerKind.PACKAGE, DefaultParameterValueLoader.DEFAULT, null
192 );
193
194 memberCodegen.functionCodegen.generateOverloadsWithDefaultValues(null, function, function);
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 StringTable strings = serializer.getStringTable();
282 NameResolver nameResolver = new NameResolver(strings.serializeSimpleNames(), strings.serializeQualifiedNames());
283 PackageData data = new PackageData(nameResolver, packageProto);
284
285 AnnotationVisitor av = v.newAnnotation(asmDescByFqNameWithoutInnerClasses(JvmAnnotationNames.KOTLIN_PACKAGE), true);
286 av.visit(JvmAnnotationNames.ABI_VERSION_FIELD_NAME, JvmAbi.VERSION);
287 AnnotationVisitor array = av.visitArray(JvmAnnotationNames.DATA_FIELD_NAME);
288 for (String string : BitEncoding.encodeBytes(SerializationUtil.serializePackageData(data))) {
289 array.visit(null, string);
290 }
291 array.visitEnd();
292 av.visitEnd();
293 }
294
295 @Nullable
296 private ClassBuilder generate(@NotNull JetFile file, @NotNull Map<CallableMemberDescriptor, Runnable> generateCallableMemberTasks) {
297 boolean generatePackagePart = false;
298 Type packagePartType = PackagePartClassUtils.getPackagePartType(file);
299 PackageContext packagePartContext = CodegenContext.STATIC.intoPackagePart(packageFragment, packagePartType);
300
301 for (JetDeclaration declaration : file.getDeclarations()) {
302 if (declaration instanceof JetProperty || declaration instanceof JetNamedFunction) {
303 generatePackagePart = true;
304 }
305 else if (declaration instanceof JetClassOrObject) {
306 JetClassOrObject classOrObject = (JetClassOrObject) declaration;
307 if (state.getGenerateDeclaredClassFilter().shouldGenerateClass(classOrObject)) {
308 generateClassOrObject(classOrObject);
309 }
310 }
311 else if (declaration instanceof JetScript) {
312 JetScript script = (JetScript) declaration;
313
314 // SCRIPT: generate script code, should be separate execution branch
315 if (state.getGenerateDeclaredClassFilter().shouldGenerateScript(script)) {
316 ScriptCodegen.createScriptCodegen(script, state, packagePartContext).generate();
317 }
318 }
319 }
320
321 if (!generatePackagePart || !state.getGenerateDeclaredClassFilter().shouldGeneratePackagePart(file)) return null;
322
323 ClassBuilder builder = state.getFactory().newVisitor(PackagePart(file, packageFragment), packagePartType, file);
324
325 new PackagePartCodegen(builder, file, packagePartType, packagePartContext, state).generate();
326
327 FieldOwnerContext packageFacade = CodegenContext.STATIC.intoPackageFacade(packagePartType, packageFragment);
328
329 final MemberCodegen<?> memberCodegen = createCodegenForPartOfPackageFacade(packageFacade);
330
331 for (final JetDeclaration declaration : file.getDeclarations()) {
332 if (declaration instanceof JetNamedFunction || declaration instanceof JetProperty) {
333 DeclarationDescriptor descriptor = state.getBindingContext().get(BindingContext.DECLARATION_TO_DESCRIPTOR, declaration);
334 assert descriptor instanceof CallableMemberDescriptor :
335 "Expected callable member, was " + descriptor + " for " + declaration.getText();
336 generateCallableMemberTasks.put(
337 (CallableMemberDescriptor) descriptor,
338 new Runnable() {
339 @Override
340 public void run() {
341 memberCodegen.genFunctionOrProperty(declaration);
342 }
343 }
344 );
345 }
346 }
347
348 return builder;
349 }
350
351 private MemberCodegen<?> createCodegenForPartOfPackageFacade(@NotNull FieldOwnerContext packageFacade) {
352 return new MemberCodegen<JetFile>(state, null, packageFacade, null, v) {
353 @Override
354 protected void generateDeclaration() {
355 throw new UnsupportedOperationException();
356 }
357
358 @Override
359 protected void generateBody() {
360 throw new UnsupportedOperationException();
361 }
362
363 @Override
364 protected void generateKotlinAnnotation() {
365 throw new UnsupportedOperationException();
366 }
367 };
368 }
369
370 @Nullable
371 private PackageFragmentDescriptor getOnlyPackageFragment(@NotNull FqName expectedFqName) {
372 SmartList<PackageFragmentDescriptor> fragments = new SmartList<PackageFragmentDescriptor>();
373 for (JetFile file : files) {
374 PackageFragmentDescriptor fragment = state.getBindingContext().get(BindingContext.FILE_TO_PACKAGE_FRAGMENT, file);
375 assert fragment != null : "package fragment is null for " + file + "\n" + file.getText();
376
377 assert expectedFqName.equals(fragment.getFqName()) :
378 "expected package fq name: " + expectedFqName + ", actual: " + fragment.getFqName();
379
380 if (!fragments.contains(fragment)) {
381 fragments.add(fragment);
382 }
383 }
384 if (fragments.size() > 1) {
385 throw new IllegalStateException("More than one package fragment, files: " + files + " | fragments: " + fragments);
386 }
387
388 if (fragments.isEmpty()) {
389 return null;
390 }
391 return fragments.get(0);
392 }
393
394 public void generateClassOrObject(@NotNull JetClassOrObject classOrObject) {
395 JetFile file = classOrObject.getContainingJetFile();
396 Type packagePartType = PackagePartClassUtils.getPackagePartType(file);
397 CodegenContext context = CodegenContext.STATIC.intoPackagePart(packageFragment, packagePartType);
398 MemberCodegen.genClassOrObject(context, classOrObject, state, null);
399 }
400
401 public void done() {
402 v.done();
403 }
404 }