blob: e5de7ff773cef53e5e25db6f4bfa468a0a06514b [file] [log] [blame]
// Copyright (c) 2017, 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.graph;
import com.android.tools.r8.ir.code.Invoke.Type;
import com.google.common.collect.BiMap;
import com.google.common.collect.HashBiMap;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Sets;
import it.unimi.dsi.fastutil.objects.Object2BooleanArrayMap;
import it.unimi.dsi.fastutil.objects.Object2BooleanMap;
import java.util.ArrayDeque;
import java.util.Collections;
import java.util.Deque;
import java.util.IdentityHashMap;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.function.Supplier;
/**
* A GraphLense implements a virtual view on top of the graph, used to delay global rewrites until
* later IR processing stages.
* <p>
* Valid remappings are limited to the following operations:
* <ul>
* <li>Mapping a classes type to one of the super/subtypes.</li>
* <li>Renaming private methods/fields.</li>
* <li>Moving methods/fields to a super/subclass.</li>
* <li>Replacing method/field references by the same method/field on a super/subtype</li>
* <li>Moved methods might require changed invocation type at the call site</li>
* </ul>
* Note that the latter two have to take visibility into account.
*/
public abstract class GraphLense {
/**
* Result of a method lookup in a GraphLense.
*
* This provide the new target and the invoke type to use.
*/
public static class GraphLenseLookupResult {
private final DexMethod method;
private final Type type;
public GraphLenseLookupResult(DexMethod method, Type type) {
this.method = method;
this.type = type;
}
public DexMethod getMethod() {
return method;
}
public Type getType() {
return type;
}
}
public static class Builder {
protected Builder() {}
protected final Map<DexType, DexType> typeMap = new IdentityHashMap<>();
protected final Map<DexMethod, DexMethod> methodMap = new IdentityHashMap<>();
protected final Map<DexField, DexField> fieldMap = new IdentityHashMap<>();
protected final BiMap<DexField, DexField> originalFieldSignatures = HashBiMap.create();
protected final BiMap<DexMethod, DexMethod> originalMethodSignatures = HashBiMap.create();
public void map(DexType from, DexType to) {
if (from == to) {
return;
}
typeMap.put(from, to);
}
public void map(DexMethod from, DexMethod to) {
if (from == to) {
return;
}
methodMap.put(from, to);
}
public void map(DexField from, DexField to) {
if (from == to) {
return;
}
fieldMap.put(from, to);
}
public void move(DexMethod from, DexMethod to) {
if (from == to) {
return;
}
map(from, to);
originalMethodSignatures.put(to, from);
}
public void move(DexField from, DexField to) {
if (from == to) {
return;
}
fieldMap.put(from, to);
originalFieldSignatures.put(to, from);
}
public GraphLense build(DexItemFactory dexItemFactory) {
return build(dexItemFactory, getIdentityLense());
}
public GraphLense build(DexItemFactory dexItemFactory, GraphLense previousLense) {
if (typeMap.isEmpty() && methodMap.isEmpty() && fieldMap.isEmpty()) {
return previousLense;
}
return new NestedGraphLense(
typeMap,
methodMap,
fieldMap,
originalFieldSignatures,
originalMethodSignatures,
previousLense,
dexItemFactory);
}
}
public static Builder builder() {
return new Builder();
}
public abstract DexType getOriginalType(DexType type);
public abstract DexField getOriginalFieldSignature(DexField field);
public abstract DexMethod getOriginalMethodSignature(DexMethod method);
public abstract DexField getRenamedFieldSignature(DexField originalField);
public abstract DexMethod getRenamedMethodSignature(DexMethod originalMethod);
public DexEncodedMethod mapDexEncodedMethod(
DexEncodedMethod originalEncodedMethod, DexDefinitionSupplier definitions) {
assert originalEncodedMethod != DexEncodedMethod.SENTINEL;
if (originalEncodedMethod == DexEncodedMethod.ANNOTATION_REFERENCE) {
return DexEncodedMethod.ANNOTATION_REFERENCE;
}
DexMethod newMethod = getRenamedMethodSignature(originalEncodedMethod.method);
// Note that:
// * Even if `newMethod` is the same as `originalEncodedMethod.method`, we still need to look it
// up, since `originalEncodedMethod` may be obsolete.
// * We can't directly use AppInfo#definitionFor(DexMethod) since definitions may not be
// updated either yet.
DexClass newHolder = definitions.definitionFor(newMethod.holder);
assert newHolder != null;
DexEncodedMethod newEncodedMethod = newHolder.lookupMethod(newMethod);
assert newEncodedMethod != null;
return newEncodedMethod;
}
public abstract DexType lookupType(DexType type);
// This overload can be used when the graph lense is known to be context insensitive.
public DexMethod lookupMethod(DexMethod method) {
assert verifyIsContextFreeForMethod(method);
return lookupMethod(method, null, null).getMethod();
}
public abstract GraphLenseLookupResult lookupMethod(
DexMethod method, DexMethod context, Type type);
public abstract RewrittenPrototypeDescription lookupPrototypeChanges(DexMethod method);
// Context sensitive graph lenses should override this method.
public Set<DexMethod> lookupMethodInAllContexts(DexMethod method) {
DexMethod result = lookupMethod(method);
assert result != null;
return ImmutableSet.of(result);
}
public abstract DexField lookupField(DexField field);
public DexMethod lookupGetFieldForMethod(DexField field, DexMethod context) {
return null;
}
public DexMethod lookupPutFieldForMethod(DexField field, DexMethod context) {
return null;
}
public DexReference lookupReference(DexReference reference) {
if (reference.isDexType()) {
return lookupType(reference.asDexType());
} else if (reference.isDexMethod()) {
return lookupMethod(reference.asDexMethod());
} else {
assert reference.isDexField();
return lookupField(reference.asDexField());
}
}
// The method lookupMethod() maps a pair INVOKE=(method signature, invoke type) to a new pair
// INVOKE'=(method signature', invoke type'). This mapping can be context sensitive, meaning that
// the result INVOKE' depends on where the invocation INVOKE is in the program. This is, for
// example, used by the vertical class merger to translate invoke-super instructions that hit
// a method in the direct super class to invoke-direct instructions after class merging.
//
// This method can be used to determine if a graph lense is context sensitive. If a graph lense
// is context insensitive, it is safe to invoke lookupMethod() without a context (or to pass null
// as context). Trying to invoke a context sensitive graph lense without a context will lead to
// an assertion error.
public abstract boolean isContextFreeForMethods();
public boolean verifyIsContextFreeForMethod(DexMethod method) {
return isContextFreeForMethods();
}
public static GraphLense getIdentityLense() {
return IdentityGraphLense.getInstance();
}
public boolean hasCodeRewritings() {
return true;
}
public final boolean isIdentityLense() {
return this == getIdentityLense();
}
public GraphLense withCodeRewritingsApplied() {
if (hasCodeRewritings()) {
return new ClearCodeRewritingGraphLens(this);
}
return this;
}
public <T extends DexDefinition> boolean assertDefinitionsNotModified(Iterable<T> definitions) {
for (DexDefinition definition : definitions) {
DexReference reference = definition.toReference();
// We allow changes to bridge methods as these get retargeted even if they are kept.
boolean isBridge =
definition.isDexEncodedMethod() && definition.asDexEncodedMethod().accessFlags.isBridge();
assert isBridge || lookupReference(reference) == reference;
}
return true;
}
public <T extends DexReference> boolean assertReferencesNotModified(Iterable<T> references) {
for (DexReference reference : references) {
if (reference.isDexField()) {
DexField field = reference.asDexField();
assert getRenamedFieldSignature(field) == field;
} else if (reference.isDexMethod()) {
DexMethod method = reference.asDexMethod();
assert getRenamedMethodSignature(method) == method;
} else {
assert reference.isDexType();
DexType type = reference.asDexType();
assert lookupType(type) == type;
}
}
return true;
}
public ImmutableSet<DexReference> rewriteReferencesConservatively(Set<DexReference> original) {
ImmutableSet.Builder<DexReference> builder = ImmutableSet.builder();
for (DexReference item : original) {
if (item.isDexMethod()) {
DexMethod method = item.asDexMethod();
builder.addAll(lookupMethodInAllContexts(method));
} else {
builder.add(lookupReference(item));
}
}
return builder.build();
}
public Object2BooleanMap<DexReference> rewriteReferencesConservatively(
Object2BooleanMap<DexReference> original) {
Object2BooleanMap<DexReference> result = new Object2BooleanArrayMap<>();
for (Object2BooleanMap.Entry<DexReference> entry : original.object2BooleanEntrySet()) {
DexReference item = entry.getKey();
if (item.isDexMethod()) {
DexMethod method = item.asDexMethod();
for (DexMethod candidate : lookupMethodInAllContexts(method)) {
result.put(candidate, entry.getBooleanValue());
}
} else {
result.put(lookupReference(item), entry.getBooleanValue());
}
}
return result;
}
public ImmutableSortedSet<DexMethod> rewriteMethodsWithRenamedSignature(Set<DexMethod> methods) {
ImmutableSortedSet.Builder<DexMethod> builder =
new ImmutableSortedSet.Builder<>(PresortedComparable::slowCompare);
for (DexMethod method : methods) {
builder.add(getRenamedMethodSignature(method));
}
return builder.build();
}
public ImmutableSortedSet<DexMethod> rewriteMethodsConservatively(Set<DexMethod> original) {
ImmutableSortedSet.Builder<DexMethod> builder =
new ImmutableSortedSet.Builder<>(PresortedComparable::slowCompare);
if (isContextFreeForMethods()) {
for (DexMethod item : original) {
builder.add(lookupMethod(item));
}
} else {
for (DexMethod item : original) {
builder.addAll(lookupMethodInAllContexts(item));
}
}
return builder.build();
}
public static <T extends DexReference, S> ImmutableMap<T, S> rewriteReferenceKeys(
Map<T, S> original, Function<T, T> rewrite) {
ImmutableMap.Builder<T, S> builder = ImmutableMap.builder();
original.forEach((item, value) -> builder.put(rewrite.apply(item), value));
return builder.build();
}
public boolean verifyMappingToOriginalProgram(
Iterable<DexProgramClass> classes,
DexApplication originalApplication,
DexItemFactory dexItemFactory) {
// Collect all original fields and methods for efficient querying.
Set<DexField> originalFields = Sets.newIdentityHashSet();
Set<DexMethod> originalMethods = Sets.newIdentityHashSet();
for (DexProgramClass clazz : originalApplication.classes()) {
for (DexEncodedField field : clazz.fields()) {
originalFields.add(field.field);
}
for (DexEncodedMethod method : clazz.methods()) {
originalMethods.add(method.method);
}
}
// Check that all fields and methods in the generated program can be mapped back to one of the
// original fields or methods.
for (DexProgramClass clazz : classes) {
if (clazz.type.isD8R8SynthesizedClassType()) {
continue;
}
for (DexEncodedField field : clazz.fields()) {
// The field $r8$clinitField may be synthesized by R8 in order to trigger the initialization
// of the enclosing class. It is not present in the input, and therefore we do not require
// that it can be mapped back to the original program.
if (field.field.match(dexItemFactory.objectMembers.clinitField)) {
continue;
}
DexField originalField = getOriginalFieldSignature(field.field);
assert originalFields.contains(originalField)
: "Unable to map field `" + field.field.toSourceString() + "` back to original program";
}
for (DexEncodedMethod method : clazz.methods()) {
if (method.isD8R8Synthesized()) {
// Methods synthesized by D8/R8 may not be mapped.
continue;
}
DexMethod originalMethod = getOriginalMethodSignature(method.method);
assert originalMethods.contains(originalMethod)
|| verifyIsBridgeMethod(
originalMethod, originalApplication, originalMethods, dexItemFactory)
: "Unable to map method `"
+ originalMethod.toSourceString()
+ "` back to original program";
}
}
return true;
}
// Check if `method` is a bridge method for a method that is in the original application.
// This is needed because member rebinding synthesizes bridge methods for visibility.
private static boolean verifyIsBridgeMethod(
DexMethod method,
DexApplication originalApplication,
Set<DexMethod> originalMethods,
DexItemFactory dexItemFactory) {
Deque<DexType> worklist = new ArrayDeque<>();
Set<DexType> visited = Sets.newIdentityHashSet();
worklist.add(method.holder);
while (!worklist.isEmpty()) {
DexType holder = worklist.removeFirst();
if (!visited.add(holder)) {
// Already visited previously.
continue;
}
DexMethod targetMethod = dexItemFactory.createMethod(holder, method.proto, method.name);
if (originalMethods.contains(targetMethod)) {
return true;
}
// Stop traversing upwards if we reach the Object.
if (holder == dexItemFactory.objectType) {
continue;
}
DexClass clazz = originalApplication.definitionFor(holder);
if (clazz != null) {
worklist.add(clazz.superType);
Collections.addAll(worklist, clazz.interfaces.values);
}
}
return false;
}
private static class IdentityGraphLense extends GraphLense {
private static IdentityGraphLense INSTANCE = new IdentityGraphLense();
private IdentityGraphLense() {}
private static IdentityGraphLense getInstance() {
return INSTANCE;
}
@Override
public DexType getOriginalType(DexType type) {
return type;
}
@Override
public DexField getOriginalFieldSignature(DexField field) {
return field;
}
@Override
public DexMethod getOriginalMethodSignature(DexMethod method) {
return method;
}
@Override
public DexField getRenamedFieldSignature(DexField originalField) {
return originalField;
}
@Override
public DexMethod getRenamedMethodSignature(DexMethod originalMethod) {
return originalMethod;
}
@Override
public DexType lookupType(DexType type) {
return type;
}
@Override
public GraphLenseLookupResult lookupMethod(DexMethod method, DexMethod context, Type type) {
return new GraphLenseLookupResult(method, type);
}
@Override
public RewrittenPrototypeDescription lookupPrototypeChanges(DexMethod method) {
return RewrittenPrototypeDescription.none();
}
@Override
public DexField lookupField(DexField field) {
return field;
}
@Override
public boolean isContextFreeForMethods() {
return true;
}
@Override
public boolean hasCodeRewritings() {
return false;
}
}
// This lens clears all code rewriting (lookup methods mimics identity lens behavior) but still
// relies on the previous lens for names (getRenamed/Original methods).
public static class ClearCodeRewritingGraphLens extends IdentityGraphLense {
private final GraphLense previous;
public ClearCodeRewritingGraphLens(GraphLense previous) {
this.previous = previous;
}
@Override
public DexType getOriginalType(DexType type) {
return previous.getOriginalType(type);
}
@Override
public DexField getOriginalFieldSignature(DexField field) {
return previous.getOriginalFieldSignature(field);
}
@Override
public DexMethod getOriginalMethodSignature(DexMethod method) {
return previous.getOriginalMethodSignature(method);
}
@Override
public DexField getRenamedFieldSignature(DexField originalField) {
return previous.getRenamedFieldSignature(originalField);
}
@Override
public DexMethod getRenamedMethodSignature(DexMethod originalMethod) {
return previous.getRenamedMethodSignature(originalMethod);
}
@Override
public DexType lookupType(DexType type) {
return previous.lookupType(type);
}
}
/**
* GraphLense implementation with a parent lense using a simple mapping for type, method and field
* mapping.
*
* <p>Subclasses can override the lookup methods.
*
* <p>For method mapping where invocation type can change just override {@link
* #mapInvocationType(DexMethod, DexMethod, Type)} if the default name mapping applies, and only
* invocation type might need to change.
*/
public static class NestedGraphLense extends GraphLense {
protected GraphLense previousLense;
protected final DexItemFactory dexItemFactory;
protected final Map<DexType, DexType> typeMap;
private final Map<DexType, DexType> arrayTypeCache = new IdentityHashMap<>();
protected final Map<DexMethod, DexMethod> methodMap;
protected final Map<DexField, DexField> fieldMap;
// Maps that store the original signature of fields and methods that have been affected, for
// example, by vertical class merging. Needed to generate a correct Proguard map in the end.
protected final BiMap<DexField, DexField> originalFieldSignatures;
protected final BiMap<DexMethod, DexMethod> originalMethodSignatures;
// Overrides this if the sub type needs to be a nested lense while it doesn't have any mappings
// at all, e.g., publicizer lense that changes invocation type only.
protected boolean isLegitimateToHaveEmptyMappings() {
return false;
}
public NestedGraphLense(
Map<DexType, DexType> typeMap,
Map<DexMethod, DexMethod> methodMap,
Map<DexField, DexField> fieldMap,
BiMap<DexField, DexField> originalFieldSignatures,
BiMap<DexMethod, DexMethod> originalMethodSignatures,
GraphLense previousLense,
DexItemFactory dexItemFactory) {
assert !typeMap.isEmpty() || !methodMap.isEmpty() || !fieldMap.isEmpty()
|| isLegitimateToHaveEmptyMappings();
this.typeMap = typeMap.isEmpty() ? null : typeMap;
this.methodMap = methodMap;
this.fieldMap = fieldMap;
this.originalFieldSignatures = originalFieldSignatures;
this.originalMethodSignatures = originalMethodSignatures;
this.previousLense = previousLense;
this.dexItemFactory = dexItemFactory;
}
public <T> T withAlternativeParentLens(GraphLense lens, Supplier<T> action) {
GraphLense oldParent = previousLense;
previousLense = lens;
T result = action.get();
previousLense = oldParent;
return result;
}
@Override
public DexType getOriginalType(DexType type) {
return previousLense.getOriginalType(type);
}
@Override
public DexField getOriginalFieldSignature(DexField field) {
DexField originalField =
originalFieldSignatures != null
? originalFieldSignatures.getOrDefault(field, field)
: field;
return previousLense.getOriginalFieldSignature(originalField);
}
@Override
public DexMethod getOriginalMethodSignature(DexMethod method) {
DexMethod originalMethod =
originalMethodSignatures != null
? originalMethodSignatures.getOrDefault(method, method)
: method;
return previousLense.getOriginalMethodSignature(originalMethod);
}
@Override
public DexField getRenamedFieldSignature(DexField originalField) {
DexField renamedField = previousLense.getRenamedFieldSignature(originalField);
return originalFieldSignatures != null
? originalFieldSignatures.inverse().getOrDefault(renamedField, renamedField)
: renamedField;
}
@Override
public DexMethod getRenamedMethodSignature(DexMethod originalMethod) {
DexMethod renamedMethod = previousLense.getRenamedMethodSignature(originalMethod);
return originalMethodSignatures != null
? originalMethodSignatures.inverse().getOrDefault(renamedMethod, renamedMethod)
: renamedMethod;
}
@Override
public DexType lookupType(DexType type) {
if (type.isArrayType()) {
synchronized (this) {
// This block need to be synchronized due to arrayTypeCache.
DexType result = arrayTypeCache.get(type);
if (result == null) {
DexType baseType = type.toBaseType(dexItemFactory);
DexType newType = lookupType(baseType);
if (baseType == newType) {
result = type;
} else {
result = type.replaceBaseType(newType, dexItemFactory);
}
arrayTypeCache.put(type, result);
}
return result;
}
}
DexType previous = previousLense.lookupType(type);
return typeMap != null ? typeMap.getOrDefault(previous, previous) : previous;
}
@Override
public GraphLenseLookupResult lookupMethod(DexMethod method, DexMethod context, Type type) {
DexMethod previousContext =
originalMethodSignatures != null
? originalMethodSignatures.getOrDefault(context, context)
: context;
GraphLenseLookupResult previous = previousLense.lookupMethod(method, previousContext, type);
DexMethod newMethod = methodMap.get(previous.getMethod());
if (newMethod == null) {
return previous;
}
// TODO(sgjesse): Should we always do interface to virtual mapping? Is it a performance win
// that only subclasses which are known to need it actually do it?
return new GraphLenseLookupResult(
newMethod, mapInvocationType(newMethod, method, previous.getType()));
}
@Override
public RewrittenPrototypeDescription lookupPrototypeChanges(DexMethod method) {
return previousLense.lookupPrototypeChanges(method);
}
@Override
public DexMethod lookupGetFieldForMethod(DexField field, DexMethod context) {
return previousLense.lookupGetFieldForMethod(field, context);
}
@Override
public DexMethod lookupPutFieldForMethod(DexField field, DexMethod context) {
return previousLense.lookupPutFieldForMethod(field, context);
}
/**
* Default invocation type mapping.
*
* <p>This is an identity mapping. If a subclass need invocation type mapping either override
* this method or {@link #lookupMethod(DexMethod, DexMethod, Type)}
*/
protected Type mapInvocationType(DexMethod newMethod, DexMethod originalMethod, Type type) {
return type;
}
/**
* Standard mapping between interface and virtual invoke type.
*
* <p>Handle methods moved from interface to class or class to interface.
*/
protected final Type mapVirtualInterfaceInvocationTypes(
DexDefinitionSupplier definitions,
DexMethod newMethod,
DexMethod originalMethod,
Type type) {
if (type == Type.VIRTUAL || type == Type.INTERFACE) {
// Get the invoke type of the actual definition.
DexClass newTargetClass = definitions.definitionFor(newMethod.holder);
if (newTargetClass == null) {
return type;
}
DexClass originalTargetClass = definitions.definitionFor(originalMethod.holder);
if (originalTargetClass != null
&& (originalTargetClass.isInterface() ^ (type == Type.INTERFACE))) {
// The invoke was wrong to start with, so we keep it wrong. This is to ensure we get
// the IncompatibleClassChangeError the original invoke would have triggered.
return newTargetClass.accessFlags.isInterface() ? Type.VIRTUAL : Type.INTERFACE;
}
return newTargetClass.accessFlags.isInterface() ? Type.INTERFACE : Type.VIRTUAL;
}
return type;
}
@Override
public Set<DexMethod> lookupMethodInAllContexts(DexMethod method) {
Set<DexMethod> result = Sets.newIdentityHashSet();
for (DexMethod previous : previousLense.lookupMethodInAllContexts(method)) {
result.add(methodMap.getOrDefault(previous, previous));
}
return result;
}
@Override
public DexField lookupField(DexField field) {
DexField previous = previousLense.lookupField(field);
return fieldMap.getOrDefault(previous, previous);
}
@Override
public boolean isContextFreeForMethods() {
return previousLense.isContextFreeForMethods();
}
@Override
public boolean verifyIsContextFreeForMethod(DexMethod method) {
assert previousLense.verifyIsContextFreeForMethod(method);
return true;
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
if (typeMap != null) {
for (Map.Entry<DexType, DexType> entry : typeMap.entrySet()) {
builder.append(entry.getKey().toSourceString()).append(" -> ");
builder.append(entry.getValue().toSourceString()).append(System.lineSeparator());
}
}
for (Map.Entry<DexMethod, DexMethod> entry : methodMap.entrySet()) {
builder.append(entry.getKey().toSourceString()).append(" -> ");
builder.append(entry.getValue().toSourceString()).append(System.lineSeparator());
}
for (Map.Entry<DexField, DexField> entry : fieldMap.entrySet()) {
builder.append(entry.getKey().toSourceString()).append(" -> ");
builder.append(entry.getValue().toSourceString()).append(System.lineSeparator());
}
builder.append(previousLense.toString());
return builder.toString();
}
}
}