| // Copyright (c) 2020, the R8 project authors. Please see the AUTHORS file |
| // for details. All rights reserved. Use of this source code is governed by a |
| // BSD-style license that can be found in the LICENSE file. |
| package com.android.tools.r8.tracereferences; |
| |
| import static com.android.tools.r8.graph.DexProgramClass.asProgramClassOrNull; |
| |
| import com.android.tools.r8.DiagnosticsHandler; |
| import com.android.tools.r8.dex.ApplicationReader; |
| import com.android.tools.r8.features.ClassToFeatureSplitMap; |
| import com.android.tools.r8.graph.AppInfoWithClassHierarchy; |
| import com.android.tools.r8.graph.DexAnnotation; |
| import com.android.tools.r8.graph.DexCallSite; |
| import com.android.tools.r8.graph.DexClass; |
| import com.android.tools.r8.graph.DexEncodedField; |
| import com.android.tools.r8.graph.DexEncodedMethod; |
| import com.android.tools.r8.graph.DexField; |
| import com.android.tools.r8.graph.DexItemFactory; |
| import com.android.tools.r8.graph.DexMethod; |
| import com.android.tools.r8.graph.DexProgramClass; |
| import com.android.tools.r8.graph.DexType; |
| import com.android.tools.r8.graph.DexValue; |
| import com.android.tools.r8.graph.DexValue.DexValueArray; |
| import com.android.tools.r8.graph.DirectMappedDexApplication; |
| import com.android.tools.r8.graph.ProgramMethod; |
| import com.android.tools.r8.graph.ResolutionResult; |
| import com.android.tools.r8.graph.UseRegistry; |
| import com.android.tools.r8.ir.desugar.LambdaDescriptor; |
| import com.android.tools.r8.references.ClassReference; |
| import com.android.tools.r8.references.FieldReference; |
| import com.android.tools.r8.references.MethodReference; |
| import com.android.tools.r8.references.Reference; |
| import com.android.tools.r8.shaking.MainDexClasses; |
| import com.android.tools.r8.tracereferences.TraceReferencesConsumer.AccessFlags; |
| import com.android.tools.r8.tracereferences.TraceReferencesConsumer.ClassAccessFlags; |
| import com.android.tools.r8.tracereferences.TraceReferencesConsumer.FieldAccessFlags; |
| import com.android.tools.r8.tracereferences.TraceReferencesConsumer.MethodAccessFlags; |
| import com.android.tools.r8.tracereferences.TraceReferencesConsumer.TracedClass; |
| import com.android.tools.r8.tracereferences.TraceReferencesConsumer.TracedField; |
| import com.android.tools.r8.tracereferences.TraceReferencesConsumer.TracedMethod; |
| import com.android.tools.r8.tracereferences.TraceReferencesConsumer.TracedReference; |
| import com.android.tools.r8.utils.AndroidApp; |
| import com.android.tools.r8.utils.InternalOptions; |
| import com.android.tools.r8.utils.StringDiagnostic; |
| import com.android.tools.r8.utils.Timing; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Set; |
| |
| class Tracer { |
| |
| static class AccessFlagsImpl<T extends com.android.tools.r8.graph.AccessFlags<T>> |
| implements AccessFlags { |
| T accessFlags; |
| |
| AccessFlagsImpl(T accessFlags) { |
| this.accessFlags = accessFlags; |
| } |
| |
| @Override |
| public boolean isStatic() { |
| return accessFlags.isStatic(); |
| } |
| |
| @Override |
| public boolean isPublic() { |
| return accessFlags.isPublic(); |
| } |
| |
| @Override |
| public boolean isProtected() { |
| return accessFlags.isProtected(); |
| } |
| |
| @Override |
| public boolean isPrivate() { |
| return accessFlags.isPrivate(); |
| } |
| } |
| |
| static class ClassAccessFlagsImpl |
| extends AccessFlagsImpl<com.android.tools.r8.graph.ClassAccessFlags> |
| implements ClassAccessFlags { |
| ClassAccessFlagsImpl(com.android.tools.r8.graph.ClassAccessFlags accessFlags) { |
| super(accessFlags); |
| } |
| |
| @Override |
| public boolean isInterface() { |
| return accessFlags.isInterface(); |
| } |
| |
| @Override |
| public boolean isEnum() { |
| return accessFlags.isEnum(); |
| } |
| } |
| |
| static class FieldAccessFlagsImpl |
| extends AccessFlagsImpl<com.android.tools.r8.graph.FieldAccessFlags> |
| implements FieldAccessFlags { |
| FieldAccessFlagsImpl(com.android.tools.r8.graph.FieldAccessFlags accessFlags) { |
| super(accessFlags); |
| } |
| } |
| |
| static class MethodAccessFlagsImpl |
| extends AccessFlagsImpl<com.android.tools.r8.graph.MethodAccessFlags> |
| implements MethodAccessFlags { |
| MethodAccessFlagsImpl(com.android.tools.r8.graph.MethodAccessFlags accessFlags) { |
| super(accessFlags); |
| } |
| } |
| |
| abstract static class TracedReferenceBase<T, F> implements TracedReference<T, F> { |
| private final T reference; |
| private final F accessFlags; |
| private final boolean missingDefinition; |
| |
| private TracedReferenceBase(T reference, F accessFlags, boolean missingDefinition) { |
| assert accessFlags != null || missingDefinition; |
| this.reference = reference; |
| this.accessFlags = accessFlags; |
| this.missingDefinition = missingDefinition; |
| } |
| |
| @Override |
| public T getReference() { |
| return reference; |
| } |
| |
| @Override |
| public boolean isMissingDefinition() { |
| return missingDefinition; |
| } |
| |
| @Override |
| public F getAccessFlags() { |
| return accessFlags; |
| } |
| |
| @Override |
| public int hashCode() { |
| // Equality is only based on the reference. |
| return reference.hashCode(); |
| } |
| |
| @Override |
| public boolean equals(Object other) { |
| // Equality is only based on the reference. |
| if (!(other instanceof TracedReferenceBase)) { |
| return false; |
| } |
| return reference.equals(((TracedReferenceBase<?, ?>) other).reference); |
| } |
| |
| public abstract String getKindName(); |
| } |
| |
| static class TracedClassImpl extends TracedReferenceBase<ClassReference, ClassAccessFlags> |
| implements TracedClass { |
| private TracedClassImpl(DexType reference, DexClass definition) { |
| super( |
| Reference.classFromDescriptor(reference.toDescriptorString()), |
| definition != null ? new ClassAccessFlagsImpl(definition.getAccessFlags()) : null, |
| definition == null); |
| } |
| |
| @Override |
| public String getKindName() { |
| return "type"; |
| } |
| |
| @Override |
| public String toString() { |
| return getReference().getTypeName(); |
| } |
| } |
| |
| static class TracedFieldImpl extends TracedReferenceBase<FieldReference, FieldAccessFlags> |
| implements TracedField { |
| private TracedFieldImpl(DexField reference, DexEncodedField definition) { |
| super( |
| Reference.field( |
| Reference.classFromDescriptor(reference.holder.toDescriptorString()), |
| reference.name.toString(), |
| Reference.typeFromDescriptor(reference.type.toDescriptorString())), |
| definition != null ? new FieldAccessFlagsImpl(definition.getAccessFlags()) : null, |
| definition == null); |
| } |
| |
| @Override |
| public String getKindName() { |
| return "field"; |
| } |
| |
| @Override |
| public String toString() { |
| return getReference().toString(); |
| } |
| } |
| |
| static class TracedMethodImpl extends TracedReferenceBase<MethodReference, MethodAccessFlags> |
| implements TracedMethod { |
| private TracedMethodImpl(DexMethod reference, DexEncodedMethod definition) { |
| super( |
| reference.asMethodReference(), |
| definition != null ? new MethodAccessFlagsImpl(definition.getAccessFlags()) : null, |
| definition == null); |
| } |
| |
| @Override |
| public String getKindName() { |
| return "method"; |
| } |
| |
| @Override |
| public String toString() { |
| return getReference().toString(); |
| } |
| } |
| |
| private final Set<String> descriptors; |
| private final DiagnosticsHandler diagnostics; |
| private final DirectMappedDexApplication application; |
| private final AppInfoWithClassHierarchy appInfo; |
| |
| Tracer(Set<String> descriptors, AndroidApp inputApp, DiagnosticsHandler diagnostics) |
| throws Exception { |
| this.descriptors = descriptors; |
| this.diagnostics = diagnostics; |
| InternalOptions options = new InternalOptions(); |
| application = |
| new ApplicationReader(inputApp, options, new Timing("ReferenceTrace")).read().toDirect(); |
| appInfo = |
| AppInfoWithClassHierarchy.createInitialAppInfoWithClassHierarchy( |
| application, |
| ClassToFeatureSplitMap.createEmptyClassToFeatureSplitMap(), |
| MainDexClasses.createEmptyMainDexClasses()); |
| } |
| |
| void run(TraceReferencesConsumer consumer) { |
| UseCollector useCollector = new UseCollector(appInfo.dexItemFactory(), consumer, diagnostics); |
| for (DexProgramClass clazz : application.classes()) { |
| useCollector.setContext(clazz); |
| useCollector.registerSuperType(clazz, clazz.superType); |
| for (DexType implementsType : clazz.interfaces.values) { |
| useCollector.registerSuperType(clazz, implementsType); |
| } |
| clazz.forEachProgramMethod(useCollector::registerMethod); |
| clazz.forEachField(useCollector::registerField); |
| } |
| consumer.finished(); |
| } |
| |
| class UseCollector extends UseRegistry { |
| |
| private final TraceReferencesConsumer consumer; |
| private DexProgramClass context; |
| private final DiagnosticsHandler diagnostics; |
| private Set<TracedReference<?, ?>> missingDefinitionReported = new HashSet<>(); |
| |
| UseCollector( |
| DexItemFactory factory, TraceReferencesConsumer consumer, DiagnosticsHandler diagnostics) { |
| super(factory); |
| this.consumer = consumer; |
| this.diagnostics = diagnostics; |
| } |
| |
| private boolean isTargetType(DexType type) { |
| return descriptors.contains(type.toDescriptorString()); |
| } |
| |
| private void addType(DexType type) { |
| if (isTargetType(type)) { |
| DexClass clazz = appInfo.definitionFor(type); |
| TracedClassImpl tracedClass = new TracedClassImpl(type, clazz); |
| consumer.acceptType(tracedClass); |
| checkDiagnostics(tracedClass); |
| if (clazz != null && clazz.accessFlags.isVisibilityDependingOnPackage()) { |
| consumer.acceptPackage(Reference.packageFromString(clazz.type.getPackageName())); |
| } |
| } |
| } |
| |
| private void addField(DexField field) { |
| addType(field.type); |
| DexEncodedField baseField = appInfo.resolveField(field).getResolvedField(); |
| if (baseField != null && baseField.holder() != field.holder) { |
| field = baseField.field; |
| } |
| addType(field.holder); |
| if (isTargetType(field.holder)) { |
| TracedFieldImpl tracedField = new TracedFieldImpl(field, baseField); |
| consumer.acceptField(tracedField); |
| checkDiagnostics(tracedField); |
| if (baseField != null && baseField.accessFlags.isVisibilityDependingOnPackage()) { |
| consumer.acceptPackage(Reference.packageFromString(baseField.holder().getPackageName())); |
| } |
| } |
| } |
| |
| private void addMethod(DexMethod method) { |
| addType(method.holder); |
| for (DexType parameterType : method.proto.parameters.values) { |
| addType(parameterType); |
| } |
| addType(method.proto.returnType); |
| if (isTargetType(method.holder)) { |
| DexClass holder = appInfo.definitionForHolder(method); |
| DexEncodedMethod definition = method.lookupOnClass(holder); |
| TracedMethodImpl tracedMethod = new TracedMethodImpl(method, definition); |
| consumer.acceptMethod(tracedMethod); |
| checkDiagnostics(tracedMethod); |
| if (definition != null && definition.accessFlags.isVisibilityDependingOnPackage()) { |
| consumer.acceptPackage(Reference.packageFromString(definition.holder().getPackageName())); |
| } |
| } |
| } |
| |
| private void checkDiagnostics(TracedReferenceBase<?, ?> tracedReference) { |
| if (tracedReference.isMissingDefinition() && missingDefinitionReported.add(tracedReference)) { |
| diagnostics.warning( |
| new StringDiagnostic( |
| "Missing definition of " + tracedReference.getKindName() + " " + tracedReference)); |
| } |
| } |
| |
| public void setContext(DexProgramClass context) { |
| this.context = context; |
| } |
| |
| @Override |
| public void registerInitClass(DexType clazz) { |
| addType(clazz); |
| } |
| |
| @Override |
| public void registerInvokeVirtual(DexMethod method) { |
| ResolutionResult resolutionResult = appInfo.unsafeResolveMethodDueToDexFormat(method); |
| DexEncodedMethod target = |
| resolutionResult.isVirtualTarget() ? resolutionResult.getSingleTarget() : null; |
| if (target != null && target.method != method) { |
| addType(method.holder); |
| addMethod(target.method); |
| } else { |
| addMethod(method); |
| } |
| } |
| |
| @Override |
| public void registerInvokeDirect(DexMethod method) { |
| addMethod(method); |
| } |
| |
| @Override |
| public void registerInvokeStatic(DexMethod method) { |
| DexEncodedMethod target = appInfo.unsafeResolveMethodDueToDexFormat(method).getSingleTarget(); |
| if (target != null && target.method != method) { |
| addType(method.holder); |
| addMethod(target.method); |
| } else { |
| addMethod(method); |
| } |
| } |
| |
| @Override |
| public void registerInvokeInterface(DexMethod method) { |
| registerInvokeVirtual(method); |
| } |
| |
| @Override |
| public void registerInvokeSuper(DexMethod method) { |
| DexEncodedMethod superTarget = appInfo.lookupSuperTarget(method, context); |
| if (superTarget != null) { |
| addMethod(superTarget.method); |
| } else { |
| addMethod(method); |
| } |
| } |
| |
| @Override |
| public void registerInstanceFieldWrite(DexField field) { |
| addField(field); |
| } |
| |
| @Override |
| public void registerInstanceFieldRead(DexField field) { |
| addField(field); |
| } |
| |
| @Override |
| public void registerNewInstance(DexType type) { |
| addType(type); |
| } |
| |
| @Override |
| public void registerStaticFieldRead(DexField field) { |
| addField(field); |
| } |
| |
| @Override |
| public void registerStaticFieldWrite(DexField field) { |
| addField(field); |
| } |
| |
| @Override |
| public void registerTypeReference(DexType type) { |
| addType(type); |
| } |
| |
| @Override |
| public void registerInstanceOf(DexType type) { |
| addType(type); |
| } |
| |
| private void registerField(DexEncodedField field) { |
| registerTypeReference(field.field.type); |
| } |
| |
| private void registerMethod(ProgramMethod method) { |
| DexEncodedMethod superTarget = |
| appInfo |
| .resolveMethodOn(method.getHolder(), method.getReference()) |
| .lookupInvokeSpecialTarget(context, appInfo); |
| if (superTarget != null) { |
| addMethod(superTarget.method); |
| } |
| for (DexType type : method.getDefinition().parameters().values) { |
| registerTypeReference(type); |
| } |
| for (DexAnnotation annotation : method.getDefinition().annotations().annotations) { |
| if (annotation.annotation.type == appInfo.dexItemFactory().annotationThrows) { |
| DexValueArray dexValues = annotation.annotation.elements[0].value.asDexValueArray(); |
| for (DexValue dexValType : dexValues.getValues()) { |
| registerTypeReference(dexValType.asDexValueType().value); |
| } |
| } |
| } |
| registerTypeReference(method.getDefinition().returnType()); |
| method.registerCodeReferences(this); |
| } |
| |
| private void registerSuperType(DexProgramClass clazz, DexType superType) { |
| registerTypeReference(superType); |
| // If clazz overrides any methods in superType, we should keep those as well. |
| clazz.forEachMethod( |
| method -> { |
| ResolutionResult resolutionResult = |
| appInfo.resolveMethodOn(superType, method.method, superType != clazz.superType); |
| DexEncodedMethod dexEncodedMethod = resolutionResult.getSingleTarget(); |
| if (dexEncodedMethod != null) { |
| addMethod(dexEncodedMethod.method); |
| } |
| }); |
| } |
| |
| @Override |
| public void registerCallSite(DexCallSite callSite) { |
| super.registerCallSite(callSite); |
| |
| // For Lambda's, in order to find the correct use, we need to register the method for the |
| // functional interface. |
| List<DexType> directInterfaces = LambdaDescriptor.getInterfaces(callSite, appInfo); |
| if (directInterfaces != null) { |
| for (DexType directInterface : directInterfaces) { |
| DexProgramClass clazz = asProgramClassOrNull(appInfo.definitionFor(directInterface)); |
| if (clazz != null) { |
| clazz.forEachProgramVirtualMethodMatching( |
| definition -> definition.getReference().name.equals(callSite.methodName), |
| this::registerMethod); |
| } |
| } |
| } |
| } |
| } |
| } |
