001 /*
002 * Copyright 2010-2014 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.jet.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.jet.codegen.context.CodegenContext;
032 import org.jetbrains.jet.codegen.context.FieldOwnerContext;
033 import org.jetbrains.jet.codegen.context.MethodContext;
034 import org.jetbrains.jet.codegen.context.PackageContext;
035 import org.jetbrains.jet.codegen.state.GenerationState;
036 import org.jetbrains.jet.config.IncrementalCompilation;
037 import org.jetbrains.jet.descriptors.serialization.BitEncoding;
038 import org.jetbrains.jet.descriptors.serialization.DescriptorSerializer;
039 import org.jetbrains.jet.descriptors.serialization.PackageData;
040 import org.jetbrains.jet.descriptors.serialization.ProtoBuf;
041 import org.jetbrains.jet.descriptors.serialization.descriptors.DeserializedCallableMemberDescriptor;
042 import org.jetbrains.jet.descriptors.serialization.descriptors.DeserializedPropertyDescriptor;
043 import org.jetbrains.jet.descriptors.serialization.descriptors.DeserializedSimpleFunctionDescriptor;
044 import org.jetbrains.jet.lang.descriptors.CallableMemberDescriptor;
045 import org.jetbrains.jet.lang.descriptors.DeclarationDescriptor;
046 import org.jetbrains.jet.lang.descriptors.PackageFragmentDescriptor;
047 import org.jetbrains.jet.lang.diagnostics.DiagnosticUtils;
048 import org.jetbrains.jet.lang.psi.*;
049 import org.jetbrains.jet.lang.resolve.BindingContext;
050 import org.jetbrains.jet.lang.resolve.MemberComparator;
051 import org.jetbrains.jet.lang.resolve.java.JvmAbi;
052 import org.jetbrains.jet.lang.resolve.java.JvmAnnotationNames;
053 import org.jetbrains.jet.lang.resolve.java.jvmSignature.JvmMethodSignature;
054 import org.jetbrains.jet.lang.resolve.kotlin.PackagePartClassUtils;
055 import org.jetbrains.jet.lang.resolve.kotlin.incremental.IncrementalPackageFragmentProvider;
056 import org.jetbrains.jet.lang.resolve.name.FqName;
057 import org.jetbrains.org.objectweb.asm.AnnotationVisitor;
058 import org.jetbrains.org.objectweb.asm.MethodVisitor;
059 import org.jetbrains.org.objectweb.asm.Type;
060 import org.jetbrains.org.objectweb.asm.commons.InstructionAdapter;
061 import org.jetbrains.org.objectweb.asm.commons.Method;
062
063 import java.util.*;
064
065 import static org.jetbrains.jet.codegen.AsmUtil.asmDescByFqNameWithoutInnerClasses;
066 import static org.jetbrains.jet.codegen.AsmUtil.method;
067 import static org.jetbrains.jet.descriptors.serialization.NameSerializationUtil.createNameResolver;
068 import static org.jetbrains.jet.lang.resolve.java.AsmTypeConstants.K_PACKAGE_IMPL_TYPE;
069 import static org.jetbrains.jet.lang.resolve.java.AsmTypeConstants.getType;
070 import static org.jetbrains.jet.lang.resolve.java.PackageClassUtils.getPackageClassFqName;
071 import static org.jetbrains.jet.lang.resolve.java.diagnostics.DiagnosticsPackage.*;
072 import static org.jetbrains.jet.lang.resolve.java.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().getPackageFragmentProvider().getPackageFragments(fqName)) {
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().getAllDescriptors()) {
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 JvmMethodSignature signature = state.getTypeMapper().mapSignature(function, OwnerKind.PACKAGE);
176 memberCodegen.functionCodegen.generateMethod(OtherOrigin(function), signature, function,
177 new FunctionGenerationStrategy() {
178 @Override
179 public void generateBody(
180 @NotNull MethodVisitor mv,
181 @NotNull FrameMap frameMap,
182 @NotNull JvmMethodSignature signature,
183 @NotNull MethodContext context,
184 @NotNull MemberCodegen<?> parentCodegen
185 ) {
186 throw new IllegalStateException("shouldn't be called");
187 }
188 }
189 );
190
191 memberCodegen.functionCodegen.generateDefaultIfNeeded(
192 context.intoFunction(function), signature, function, OwnerKind.PACKAGE,
193 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("kPackage", K_PACKAGE_IMPL_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 = new DescriptorSerializer(new JavaSerializerExtension(bindings));
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.getNameTable()), 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().shouldProcess(classOrObject)) {
306 generateClassOrObject(classOrObject);
307 }
308 }
309 else if (declaration instanceof JetScript) {
310 // SCRIPT: generate script code, should be separate execution branch
311 ScriptCodegen.createScriptCodegen((JetScript) declaration, state, packagePartContext).generate();
312 }
313 }
314
315 if (!generatePackagePart) return null;
316
317 ClassBuilder builder = state.getFactory().newVisitor(PackagePart(file, packageFragment), packagePartType, file);
318
319 new PackagePartCodegen(builder, file, packagePartType, packagePartContext, state).generate();
320
321 FieldOwnerContext packageFacade = CodegenContext.STATIC.intoPackageFacade(packagePartType, packageFragment);
322
323 final MemberCodegen<?> memberCodegen = createCodegenForPartOfPackageFacade(packageFacade);
324
325 for (final JetDeclaration declaration : file.getDeclarations()) {
326 if (declaration instanceof JetNamedFunction || declaration instanceof JetProperty) {
327 DeclarationDescriptor descriptor = state.getBindingContext().get(BindingContext.DECLARATION_TO_DESCRIPTOR, declaration);
328 assert descriptor instanceof CallableMemberDescriptor :
329 "Expected callable member, was " + descriptor + " for " + declaration.getText();
330 generateCallableMemberTasks.put(
331 (CallableMemberDescriptor) descriptor,
332 new Runnable() {
333 @Override
334 public void run() {
335 memberCodegen.genFunctionOrProperty(declaration);
336 }
337 }
338 );
339 }
340 }
341
342 return builder;
343 }
344
345 private MemberCodegen<?> createCodegenForPartOfPackageFacade(@NotNull FieldOwnerContext packageFacade) {
346 return new MemberCodegen<JetFile>(state, null, packageFacade, null, v) {
347 @Override
348 protected void generateDeclaration() {
349 throw new UnsupportedOperationException();
350 }
351
352 @Override
353 protected void generateBody() {
354 throw new UnsupportedOperationException();
355 }
356
357 @Override
358 protected void generateKotlinAnnotation() {
359 throw new UnsupportedOperationException();
360 }
361 };
362 }
363
364 @Nullable
365 private PackageFragmentDescriptor getOnlyPackageFragment(@NotNull FqName expectedFqName) {
366 SmartList<PackageFragmentDescriptor> fragments = new SmartList<PackageFragmentDescriptor>();
367 for (JetFile file : files) {
368 PackageFragmentDescriptor fragment = state.getBindingContext().get(BindingContext.FILE_TO_PACKAGE_FRAGMENT, file);
369 assert fragment != null : "package fragment is null for " + file + "\n" + file.getText();
370
371 assert expectedFqName.equals(fragment.getFqName()) :
372 "expected package fq name: " + expectedFqName + ", actual: " + fragment.getFqName();
373
374 if (!fragments.contains(fragment)) {
375 fragments.add(fragment);
376 }
377 }
378 if (fragments.size() > 1) {
379 throw new IllegalStateException("More than one package fragment, files: " + files + " | fragments: " + fragments);
380 }
381
382 if (fragments.isEmpty()) {
383 return null;
384 }
385 return fragments.get(0);
386 }
387
388 public void generateClassOrObject(@NotNull JetClassOrObject classOrObject) {
389 JetFile file = classOrObject.getContainingJetFile();
390 Type packagePartType = PackagePartClassUtils.getPackagePartType(file);
391 CodegenContext context = CodegenContext.STATIC.intoPackagePart(packageFragment, packagePartType);
392 MemberCodegen.genClassOrObject(context, classOrObject, state, null);
393 }
394
395 public void done() {
396 v.done();
397 }
398 }