| // Copyright (c) 2016, 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.shaking; |
| |
| import static com.android.tools.r8.shaking.ReprocessClassInitializerRule.Type.ALWAYS; |
| import static com.android.tools.r8.shaking.ReprocessClassInitializerRule.Type.NEVER; |
| |
| import com.android.tools.r8.dex.Constants; |
| import com.android.tools.r8.errors.Unreachable; |
| import com.android.tools.r8.graph.AppInfo; |
| import com.android.tools.r8.graph.AppInfoWithSubtyping; |
| import com.android.tools.r8.graph.AppView; |
| import com.android.tools.r8.graph.BottomUpClassHierarchyTraversal; |
| import com.android.tools.r8.graph.DexAnnotation; |
| import com.android.tools.r8.graph.DexAnnotationSet; |
| import com.android.tools.r8.graph.DexApplication; |
| import com.android.tools.r8.graph.DexClass; |
| import com.android.tools.r8.graph.DexDefinition; |
| import com.android.tools.r8.graph.DexEncodedField; |
| import com.android.tools.r8.graph.DexEncodedMember; |
| import com.android.tools.r8.graph.DexEncodedMethod; |
| import com.android.tools.r8.graph.DexField; |
| import com.android.tools.r8.graph.DexLibraryClass; |
| import com.android.tools.r8.graph.DexMember; |
| import com.android.tools.r8.graph.DexMethod; |
| import com.android.tools.r8.graph.DexProgramClass; |
| import com.android.tools.r8.graph.DexReference; |
| import com.android.tools.r8.graph.DexType; |
| import com.android.tools.r8.graph.DirectMappedDexApplication; |
| import com.android.tools.r8.graph.ProgramMethod; |
| import com.android.tools.r8.graph.ResolutionResult.SingleResolutionResult; |
| import com.android.tools.r8.ir.analysis.proto.GeneratedMessageLiteBuilderShrinker; |
| import com.android.tools.r8.logging.Log; |
| import com.android.tools.r8.shaking.AnnotationMatchResult.AnnotationsIgnoredMatchResult; |
| import com.android.tools.r8.shaking.AnnotationMatchResult.ConcreteAnnotationMatchResult; |
| import com.android.tools.r8.shaking.DelayedRootSetActionItem.InterfaceMethodSyntheticBridgeAction; |
| import com.android.tools.r8.utils.ArrayUtils; |
| import com.android.tools.r8.utils.Consumer3; |
| import com.android.tools.r8.utils.InternalOptions; |
| import com.android.tools.r8.utils.MethodSignatureEquivalence; |
| import com.android.tools.r8.utils.PredicateSet; |
| import com.android.tools.r8.utils.StringDiagnostic; |
| import com.android.tools.r8.utils.ThreadUtils; |
| import com.google.common.base.Equivalence.Wrapper; |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.collect.ImmutableSet; |
| import com.google.common.collect.Lists; |
| import com.google.common.collect.Sets; |
| import com.google.common.collect.Streams; |
| import java.io.PrintStream; |
| import java.util.ArrayDeque; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.Comparator; |
| import java.util.Deque; |
| import java.util.HashMap; |
| import java.util.HashSet; |
| import java.util.IdentityHashMap; |
| import java.util.LinkedHashMap; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Map.Entry; |
| import java.util.Queue; |
| import java.util.Set; |
| import java.util.Stack; |
| import java.util.concurrent.ConcurrentLinkedQueue; |
| import java.util.concurrent.ExecutionException; |
| import java.util.concurrent.ExecutorService; |
| import java.util.concurrent.Future; |
| import java.util.function.Consumer; |
| import java.util.function.Predicate; |
| import java.util.stream.Collectors; |
| |
| public class RootSetBuilder { |
| |
| private final AppView<? extends AppInfoWithSubtyping> appView; |
| private final DirectMappedDexApplication application; |
| private final Iterable<? extends ProguardConfigurationRule> rules; |
| private final Map<DexReference, Set<ProguardKeepRuleBase>> noShrinking = new IdentityHashMap<>(); |
| private final Set<DexReference> noObfuscation = Sets.newIdentityHashSet(); |
| private final LinkedHashMap<DexReference, DexReference> reasonAsked = new LinkedHashMap<>(); |
| private final LinkedHashMap<DexReference, DexReference> checkDiscarded = new LinkedHashMap<>(); |
| private final Set<DexMethod> alwaysInline = Sets.newIdentityHashSet(); |
| private final Set<DexMethod> forceInline = Sets.newIdentityHashSet(); |
| private final Set<DexMethod> neverInline = Sets.newIdentityHashSet(); |
| private final Set<DexMethod> bypassClinitforInlining = Sets.newIdentityHashSet(); |
| private final Set<DexMethod> whyAreYouNotInlining = Sets.newIdentityHashSet(); |
| private final Set<DexMethod> keepParametersWithConstantValue = Sets.newIdentityHashSet(); |
| private final Set<DexMethod> keepUnusedArguments = Sets.newIdentityHashSet(); |
| private final Set<DexMethod> reprocess = Sets.newIdentityHashSet(); |
| private final Set<DexMethod> neverReprocess = Sets.newIdentityHashSet(); |
| private final PredicateSet<DexType> alwaysClassInline = new PredicateSet<>(); |
| private final Set<DexType> neverClassInline = Sets.newIdentityHashSet(); |
| private final Set<DexType> neverMerge = Sets.newIdentityHashSet(); |
| private final Set<DexReference> neverPropagateValue = Sets.newIdentityHashSet(); |
| private final Map<DexReference, Map<DexReference, Set<ProguardKeepRuleBase>>> |
| dependentNoShrinking = new IdentityHashMap<>(); |
| private final Map<DexType, Set<ProguardKeepRuleBase>> dependentKeepClassCompatRule = |
| new IdentityHashMap<>(); |
| private final Map<DexReference, ProguardMemberRule> mayHaveSideEffects = new IdentityHashMap<>(); |
| private final Map<DexReference, ProguardMemberRule> noSideEffects = new IdentityHashMap<>(); |
| private final Map<DexReference, ProguardMemberRule> assumedValues = new IdentityHashMap<>(); |
| private final Set<DexReference> identifierNameStrings = Sets.newIdentityHashSet(); |
| private final Queue<DelayedRootSetActionItem> delayedRootSetActionItems = |
| new ConcurrentLinkedQueue<>(); |
| private final InternalOptions options; |
| |
| private final DexStringCache dexStringCache = new DexStringCache(); |
| private final Set<ProguardIfRule> ifRules = Sets.newIdentityHashSet(); |
| |
| public RootSetBuilder( |
| AppView<? extends AppInfoWithSubtyping> appView, |
| DexApplication application, |
| Iterable<? extends ProguardConfigurationRule> rules) { |
| this.appView = appView; |
| this.application = application.asDirect(); |
| this.rules = rules; |
| this.options = appView.options(); |
| } |
| |
| public RootSetBuilder( |
| AppView<? extends AppInfoWithSubtyping> appView, Collection<ProguardIfRule> ifRules) { |
| this(appView, appView.appInfo().app(), ifRules); |
| } |
| |
| public RootSetBuilder(AppView<? extends AppInfoWithSubtyping> appView) { |
| this(appView, appView.appInfo().app(), null); |
| } |
| |
| void handleMatchedAnnotation(AnnotationMatchResult annotation) { |
| // Intentionally empty. |
| } |
| |
| // Process a class with the keep rule. |
| private void process( |
| DexClass clazz, |
| ProguardConfigurationRule rule, |
| ProguardIfRule ifRule) { |
| if (!satisfyClassType(rule, clazz)) { |
| return; |
| } |
| if (!satisfyAccessFlag(rule, clazz)) { |
| return; |
| } |
| AnnotationMatchResult annotationMatchResult = satisfyAnnotation(rule, clazz); |
| if (annotationMatchResult == null) { |
| return; |
| } |
| handleMatchedAnnotation(annotationMatchResult); |
| // In principle it should make a difference whether the user specified in a class |
| // spec that a class either extends or implements another type. However, proguard |
| // seems not to care, so users have started to use this inconsistently. We are thus |
| // inconsistent, as well, but tell them. |
| // TODO(herhut): One day make this do what it says. |
| if (rule.hasInheritanceClassName() && !satisfyInheritanceRule(clazz, rule)) { |
| return; |
| } |
| |
| if (!rule.getClassNames().matches(clazz.type)) { |
| return; |
| } |
| |
| Collection<ProguardMemberRule> memberKeepRules = rule.getMemberRules(); |
| Map<Predicate<DexDefinition>, DexDefinition> preconditionSupplier; |
| if (rule instanceof ProguardKeepRule) { |
| if (clazz.isNotProgramClass()) { |
| return; |
| } |
| switch (((ProguardKeepRule) rule).getType()) { |
| case KEEP_CLASS_MEMBERS: |
| // Members mentioned at -keepclassmembers always depend on their holder. |
| preconditionSupplier = ImmutableMap.of(definition -> true, clazz); |
| markMatchingVisibleMethods( |
| clazz, memberKeepRules, rule, preconditionSupplier, false, ifRule); |
| markMatchingVisibleFields( |
| clazz, memberKeepRules, rule, preconditionSupplier, false, ifRule); |
| break; |
| case KEEP_CLASSES_WITH_MEMBERS: |
| if (!allRulesSatisfied(memberKeepRules, clazz)) { |
| break; |
| } |
| // fallthrough; |
| case KEEP: |
| markClass(clazz, rule, ifRule); |
| preconditionSupplier = new HashMap<>(); |
| if (ifRule != null) { |
| // Static members in -keep are pinned no matter what. |
| preconditionSupplier.put(DexDefinition::isStaticMember, null); |
| // Instance members may need to be kept even though the holder is not instantiated. |
| preconditionSupplier.put(definition -> !definition.isStaticMember(), clazz); |
| } else { |
| // Members mentioned at -keep should always be pinned as long as that -keep rule is |
| // not triggered conditionally. |
| preconditionSupplier.put((definition -> true), null); |
| } |
| markMatchingVisibleMethods( |
| clazz, memberKeepRules, rule, preconditionSupplier, false, ifRule); |
| markMatchingVisibleFields( |
| clazz, memberKeepRules, rule, preconditionSupplier, false, ifRule); |
| break; |
| case CONDITIONAL: |
| throw new Unreachable("-if rule will be evaluated separately, not here."); |
| } |
| return; |
| } |
| // Only the ordinary keep rules are supported in a conditional rule. |
| assert ifRule == null; |
| if (rule instanceof ProguardIfRule) { |
| throw new Unreachable("-if rule will be evaluated separately, not here."); |
| } else if (rule instanceof ProguardCheckDiscardRule) { |
| if (memberKeepRules.isEmpty()) { |
| markClass(clazz, rule, ifRule); |
| } else { |
| preconditionSupplier = ImmutableMap.of((definition -> true), clazz); |
| markMatchingVisibleMethods( |
| clazz, memberKeepRules, rule, preconditionSupplier, true, ifRule); |
| markMatchingVisibleFields(clazz, memberKeepRules, rule, preconditionSupplier, true, ifRule); |
| } |
| } else if (rule instanceof ProguardWhyAreYouKeepingRule) { |
| markClass(clazz, rule, ifRule); |
| markMatchingVisibleMethods(clazz, memberKeepRules, rule, null, true, ifRule); |
| markMatchingVisibleFields(clazz, memberKeepRules, rule, null, true, ifRule); |
| } else if (rule instanceof ProguardAssumeMayHaveSideEffectsRule |
| || rule instanceof ProguardAssumeNoSideEffectRule |
| || rule instanceof ProguardAssumeValuesRule) { |
| markMatchingVisibleMethods(clazz, memberKeepRules, rule, null, true, ifRule); |
| markMatchingOverriddenMethods( |
| appView.appInfo(), clazz, memberKeepRules, rule, null, true, ifRule); |
| markMatchingVisibleFields(clazz, memberKeepRules, rule, null, true, ifRule); |
| } else if (rule instanceof InlineRule |
| || rule instanceof ConstantArgumentRule |
| || rule instanceof UnusedArgumentRule |
| || rule instanceof ReprocessMethodRule |
| || rule instanceof WhyAreYouNotInliningRule) { |
| markMatchingMethods(clazz, memberKeepRules, rule, null, ifRule); |
| } else if (rule instanceof ClassInlineRule |
| || rule instanceof ClassMergingRule |
| || rule instanceof ReprocessClassInitializerRule) { |
| if (allRulesSatisfied(memberKeepRules, clazz)) { |
| markClass(clazz, rule, ifRule); |
| } |
| } else if (rule instanceof MemberValuePropagationRule) { |
| markMatchingVisibleMethods(clazz, memberKeepRules, rule, null, true, ifRule); |
| markMatchingVisibleFields(clazz, memberKeepRules, rule, null, true, ifRule); |
| } else { |
| assert rule instanceof ProguardIdentifierNameStringRule; |
| markMatchingFields(clazz, memberKeepRules, rule, null, ifRule); |
| markMatchingMethods(clazz, memberKeepRules, rule, null, ifRule); |
| } |
| } |
| |
| void runPerRule( |
| ExecutorService executorService, |
| List<Future<?>> futures, |
| ProguardConfigurationRule rule, |
| ProguardIfRule ifRule) { |
| List<DexType> specifics = rule.getClassNames().asSpecificDexTypes(); |
| if (specifics != null) { |
| // This keep rule only lists specific type matches. |
| // This means there is no need to iterate over all classes. |
| for (DexType type : specifics) { |
| DexClass clazz = application.definitionFor(type); |
| // Ignore keep rule iff it does not reference a class in the app. |
| if (clazz != null) { |
| process(clazz, rule, ifRule); |
| } |
| } |
| return; |
| } |
| |
| futures.add( |
| executorService.submit( |
| () -> { |
| for (DexProgramClass clazz : |
| rule.relevantCandidatesForRule(appView, application.classes())) { |
| process(clazz, rule, ifRule); |
| } |
| if (rule.applyToNonProgramClasses()) { |
| for (DexLibraryClass clazz : application.libraryClasses()) { |
| process(clazz, rule, ifRule); |
| } |
| } |
| })); |
| } |
| |
| public RootSet run(ExecutorService executorService) throws ExecutionException { |
| application.timing.begin("Build root set..."); |
| try { |
| List<Future<?>> futures = new ArrayList<>(); |
| // Mark all the things explicitly listed in keep rules. |
| if (rules != null) { |
| for (ProguardConfigurationRule rule : rules) { |
| if (rule instanceof ProguardIfRule) { |
| ProguardIfRule ifRule = (ProguardIfRule) rule; |
| ifRules.add(ifRule); |
| } else { |
| runPerRule(executorService, futures, rule, null); |
| } |
| } |
| ThreadUtils.awaitFutures(futures); |
| } |
| } finally { |
| application.timing.end(); |
| } |
| if (!noSideEffects.isEmpty() || !assumedValues.isEmpty()) { |
| BottomUpClassHierarchyTraversal.forAllClasses(appView) |
| .visit(appView.appInfo().classes(), this::propagateAssumeRules); |
| } |
| if (appView.options().protoShrinking().enableGeneratedMessageLiteBuilderShrinking) { |
| GeneratedMessageLiteBuilderShrinker.addInliningHeuristicsForBuilderInlining( |
| appView, |
| alwaysClassInline, |
| neverMerge, |
| alwaysInline, |
| bypassClinitforInlining); |
| } |
| assert Sets.intersection(neverInline, alwaysInline).isEmpty() |
| && Sets.intersection(neverInline, forceInline).isEmpty() |
| : "A method cannot be marked as both -neverinline and -forceinline/-alwaysinline."; |
| return new RootSet( |
| noShrinking, |
| noObfuscation, |
| ImmutableList.copyOf(reasonAsked.values()), |
| ImmutableList.copyOf(checkDiscarded.values()), |
| alwaysInline, |
| forceInline, |
| neverInline, |
| bypassClinitforInlining, |
| whyAreYouNotInlining, |
| keepParametersWithConstantValue, |
| keepUnusedArguments, |
| reprocess, |
| neverReprocess, |
| alwaysClassInline, |
| neverClassInline, |
| neverMerge, |
| neverPropagateValue, |
| mayHaveSideEffects, |
| noSideEffects, |
| assumedValues, |
| dependentNoShrinking, |
| dependentKeepClassCompatRule, |
| identifierNameStrings, |
| ifRules, |
| Lists.newArrayList(delayedRootSetActionItems)); |
| } |
| |
| private void propagateAssumeRules(DexClass clazz) { |
| Set<DexType> subTypes = appView.appInfo().allImmediateSubtypes(clazz.type); |
| if (subTypes.isEmpty()) { |
| return; |
| } |
| for (DexEncodedMethod encodedMethod : clazz.virtualMethods()) { |
| // If the method has a body, it may have side effects. Don't do bottom-up propagation. |
| if (encodedMethod.hasCode()) { |
| assert !encodedMethod.shouldNotHaveCode(); |
| continue; |
| } |
| propagateAssumeRules(clazz.type, encodedMethod.method, subTypes, noSideEffects); |
| propagateAssumeRules(clazz.type, encodedMethod.method, subTypes, assumedValues); |
| } |
| } |
| |
| private void propagateAssumeRules( |
| DexType type, |
| DexMethod reference, |
| Set<DexType> subTypes, |
| Map<DexReference, ProguardMemberRule> assumeRulePool) { |
| ProguardMemberRule ruleToBePropagated = null; |
| for (DexType subType : subTypes) { |
| DexMethod referenceInSubType = |
| appView.dexItemFactory().createMethod(subType, reference.proto, reference.name); |
| // Those rules are bound to definitions, not references. If the current subtype does not |
| // override the method, and when the retrieval of bound rule fails, it is unclear whether it |
| // is due to the lack of the definition or it indeed means no matching rules. Similar to how |
| // we apply those assume rules, here we use a resolved target. |
| DexEncodedMethod target = |
| appView.appInfo().resolveMethod(subType, referenceInSubType).getSingleTarget(); |
| // But, the resolution should not be landed on the current type we are visiting. |
| if (target == null || target.holder() == type) { |
| continue; |
| } |
| ProguardMemberRule ruleInSubType = assumeRulePool.get(target.method); |
| // We are looking for the greatest lower bound of assume rules from all sub types. |
| // If any subtype doesn't have a matching assume rule, the lower bound is literally nothing. |
| if (ruleInSubType == null) { |
| ruleToBePropagated = null; |
| break; |
| } |
| if (ruleToBePropagated == null) { |
| ruleToBePropagated = ruleInSubType; |
| } else { |
| // TODO(b/133208961): Introduce comparison/meet of assume rules. |
| if (!ruleToBePropagated.equals(ruleInSubType)) { |
| ruleToBePropagated = null; |
| break; |
| } |
| } |
| } |
| if (ruleToBePropagated != null) { |
| assumeRulePool.put(reference, ruleToBePropagated); |
| } |
| } |
| |
| ConsequentRootSet buildConsequentRootSet() { |
| return new ConsequentRootSet( |
| neverInline, |
| neverClassInline, |
| noShrinking, |
| noObfuscation, |
| dependentNoShrinking, |
| dependentKeepClassCompatRule, |
| Lists.newArrayList(delayedRootSetActionItems)); |
| } |
| |
| private static DexDefinition testAndGetPrecondition( |
| DexDefinition definition, Map<Predicate<DexDefinition>, DexDefinition> preconditionSupplier) { |
| if (preconditionSupplier == null) { |
| return null; |
| } |
| DexDefinition precondition = null; |
| boolean conditionEverMatched = false; |
| for (Entry<Predicate<DexDefinition>, DexDefinition> entry : preconditionSupplier.entrySet()) { |
| if (entry.getKey().test(definition)) { |
| precondition = entry.getValue(); |
| conditionEverMatched = true; |
| break; |
| } |
| } |
| // If precondition-supplier is given, there should be at least one predicate that holds. |
| // Actually, there should be only one predicate as we break the loop when it is found. |
| assert conditionEverMatched; |
| return precondition; |
| } |
| |
| private void markMatchingVisibleMethods( |
| DexClass clazz, |
| Collection<ProguardMemberRule> memberKeepRules, |
| ProguardConfigurationRule rule, |
| Map<Predicate<DexDefinition>, DexDefinition> preconditionSupplier, |
| boolean includeLibraryClasses, |
| ProguardIfRule ifRule) { |
| Set<Wrapper<DexMethod>> methodsMarked = |
| options.forceProguardCompatibility ? null : new HashSet<>(); |
| Stack<DexClass> worklist = new Stack<>(); |
| worklist.add(clazz); |
| while (!worklist.isEmpty()) { |
| DexClass currentClass = worklist.pop(); |
| if (!includeLibraryClasses && currentClass.isNotProgramClass()) { |
| break; |
| } |
| // In compat mode traverse all direct methods in the hierarchy. |
| if (currentClass == clazz || options.forceProguardCompatibility) { |
| currentClass |
| .directMethods() |
| .forEach( |
| method -> { |
| DexDefinition precondition = testAndGetPrecondition(method, preconditionSupplier); |
| markMethod(method, memberKeepRules, methodsMarked, rule, precondition, ifRule); |
| }); |
| } |
| currentClass |
| .virtualMethods() |
| .forEach( |
| method -> { |
| DexDefinition precondition = testAndGetPrecondition(method, preconditionSupplier); |
| markMethod(method, memberKeepRules, methodsMarked, rule, precondition, ifRule); |
| }); |
| if (currentClass.superType != null) { |
| DexClass dexClass = application.definitionFor(currentClass.superType); |
| if (dexClass != null) { |
| worklist.add(dexClass); |
| } |
| } |
| } |
| // TODO(b/143643942): Generalize the below approach to also work for subtyping hierarchies in |
| // fullmode. |
| if (clazz.isProgramClass() |
| && rule.isProguardKeepRule() |
| && !rule.asProguardKeepRule().getModifiers().allowsShrinking) { |
| new SynthesizeMissingInterfaceMethodsForMemberRules( |
| clazz.asProgramClass(), memberKeepRules, rule, preconditionSupplier, ifRule) |
| .run(); |
| } |
| } |
| |
| /** |
| * Utility class for visiting all super interfaces to ensure we keep method definitions specified |
| * by proguard rules. If possible, we generate a forwarding bridge to the resolved target. If not, |
| * we specifically synthesize a keep rule for the interface method. |
| */ |
| private class SynthesizeMissingInterfaceMethodsForMemberRules { |
| private final DexProgramClass originalClazz; |
| private final Collection<ProguardMemberRule> memberKeepRules; |
| private final ProguardConfigurationRule context; |
| private final Map<Predicate<DexDefinition>, DexDefinition> preconditionSupplier; |
| private final ProguardIfRule ifRule; |
| private final Set<Wrapper<DexMethod>> seenMethods = Sets.newHashSet(); |
| private final Set<DexType> seenTypes = Sets.newIdentityHashSet(); |
| |
| private SynthesizeMissingInterfaceMethodsForMemberRules( |
| DexProgramClass originalClazz, |
| Collection<ProguardMemberRule> memberKeepRules, |
| ProguardConfigurationRule context, |
| Map<Predicate<DexDefinition>, DexDefinition> preconditionSupplier, |
| ProguardIfRule ifRule) { |
| assert context.isProguardKeepRule(); |
| assert !context.asProguardKeepRule().getModifiers().allowsShrinking; |
| this.originalClazz = originalClazz; |
| this.memberKeepRules = memberKeepRules; |
| this.context = context; |
| this.preconditionSupplier = preconditionSupplier; |
| this.ifRule = ifRule; |
| } |
| |
| void handleMatchedAnnotation(AnnotationMatchResult annotationMatchResult) { |
| // Intentionally empty. |
| } |
| |
| void run() { |
| visitAllSuperInterfaces(originalClazz.type); |
| } |
| |
| private void visitAllSuperInterfaces(DexType type) { |
| DexClass clazz = appView.definitionFor(type); |
| if (clazz == null || clazz.isNotProgramClass() || !seenTypes.add(type)) { |
| return; |
| } |
| for (DexType iface : clazz.interfaces.values) { |
| visitAllSuperInterfaces(iface); |
| } |
| if (!clazz.isInterface()) { |
| visitAllSuperInterfaces(clazz.superType); |
| return; |
| } |
| if (originalClazz == clazz) { |
| return; |
| } |
| for (DexEncodedMethod method : clazz.virtualMethods()) { |
| // Check if we already added this. |
| Wrapper<DexMethod> wrapped = MethodSignatureEquivalence.get().wrap(method.method); |
| if (!seenMethods.add(wrapped)) { |
| continue; |
| } |
| for (ProguardMemberRule rule : memberKeepRules) { |
| if (rule.matches(method, appView, this::handleMatchedAnnotation, dexStringCache)) { |
| tryAndKeepMethodOnClass(method, rule); |
| } |
| } |
| } |
| } |
| |
| private void tryAndKeepMethodOnClass(DexEncodedMethod method, ProguardMemberRule rule) { |
| SingleResolutionResult resolutionResult = |
| appView.appInfo().resolveMethod(originalClazz, method.method).asSingleResolution(); |
| if (resolutionResult == null || !resolutionResult.isVirtualTarget()) { |
| return; |
| } |
| if (resolutionResult.getResolvedHolder() == originalClazz |
| || resolutionResult.getResolvedHolder().isNotProgramClass()) { |
| return; |
| } |
| if (!resolutionResult.getResolvedHolder().isInterface()) { |
| // TODO(b/143643942): For fullmode, this check should probably be removed. |
| return; |
| } |
| ProgramMethod resolutionMethod = |
| new ProgramMethod( |
| resolutionResult.getResolvedHolder().asProgramClass(), |
| resolutionResult.getResolvedMethod()); |
| ProgramMethod methodToKeep = |
| canInsertForwardingMethod(originalClazz, resolutionMethod.getMethod()) |
| ? new ProgramMethod( |
| originalClazz, |
| resolutionMethod.getMethod().toForwardingMethod(originalClazz, appView)) |
| : resolutionMethod; |
| |
| delayedRootSetActionItems.add( |
| new InterfaceMethodSyntheticBridgeAction( |
| methodToKeep, |
| resolutionMethod, |
| (rootSetBuilder) -> { |
| if (Log.ENABLED) { |
| Log.verbose( |
| getClass(), |
| "Marking method `%s` due to `%s { %s }`.", |
| methodToKeep, |
| context, |
| rule); |
| } |
| DexDefinition precondition = |
| testAndGetPrecondition(methodToKeep.getMethod(), preconditionSupplier); |
| rootSetBuilder.addItemToSets( |
| methodToKeep.getMethod(), context, rule, precondition, ifRule); |
| })); |
| } |
| } |
| |
| private boolean canInsertForwardingMethod(DexClass holder, DexEncodedMethod target) { |
| return appView.options().isGeneratingDex() |
| || ArrayUtils.contains(holder.interfaces.values, target.holder()); |
| } |
| |
| private void markMatchingOverriddenMethods( |
| AppInfoWithSubtyping appInfoWithSubtyping, |
| DexClass clazz, |
| Collection<ProguardMemberRule> memberKeepRules, |
| ProguardConfigurationRule rule, |
| Map<Predicate<DexDefinition>, DexDefinition> preconditionSupplier, |
| boolean onlyIncludeProgramClasses, |
| ProguardIfRule ifRule) { |
| Set<DexType> visited = new HashSet<>(); |
| Deque<DexType> worklist = new ArrayDeque<>(); |
| // Intentionally skip the current `clazz`, assuming it's covered by markMatchingVisibleMethods. |
| worklist.addAll(appInfoWithSubtyping.allImmediateSubtypes(clazz.type)); |
| |
| while (!worklist.isEmpty()) { |
| DexType currentType = worklist.poll(); |
| if (!visited.add(currentType)) { |
| continue; |
| } |
| DexClass currentClazz = appView.definitionFor(currentType); |
| if (currentClazz == null) { |
| continue; |
| } |
| if (!onlyIncludeProgramClasses && currentClazz.isNotProgramClass()) { |
| continue; |
| } |
| currentClazz |
| .virtualMethods() |
| .forEach( |
| method -> { |
| DexDefinition precondition = testAndGetPrecondition(method, preconditionSupplier); |
| markMethod(method, memberKeepRules, null, rule, precondition, ifRule); |
| }); |
| worklist.addAll(appInfoWithSubtyping.allImmediateSubtypes(currentClazz.type)); |
| } |
| } |
| |
| private void markMatchingMethods( |
| DexClass clazz, |
| Collection<ProguardMemberRule> memberKeepRules, |
| ProguardConfigurationRule rule, |
| Map<Predicate<DexDefinition>, DexDefinition> preconditionSupplier, |
| ProguardIfRule ifRule) { |
| clazz.forEachMethod( |
| method -> { |
| DexDefinition precondition = testAndGetPrecondition(method, preconditionSupplier); |
| markMethod(method, memberKeepRules, null, rule, precondition, ifRule); |
| }); |
| } |
| |
| private void markMatchingVisibleFields( |
| DexClass clazz, |
| Collection<ProguardMemberRule> memberKeepRules, |
| ProguardConfigurationRule rule, |
| Map<Predicate<DexDefinition>, DexDefinition> preconditionSupplier, |
| boolean includeLibraryClasses, |
| ProguardIfRule ifRule) { |
| while (clazz != null) { |
| if (!includeLibraryClasses && clazz.isNotProgramClass()) { |
| return; |
| } |
| clazz.forEachField( |
| field -> { |
| DexDefinition precondition = testAndGetPrecondition(field, preconditionSupplier); |
| markField(field, memberKeepRules, rule, precondition, ifRule); |
| }); |
| clazz = clazz.superType == null ? null : application.definitionFor(clazz.superType); |
| } |
| } |
| |
| private void markMatchingFields( |
| DexClass clazz, |
| Collection<ProguardMemberRule> memberKeepRules, |
| ProguardConfigurationRule rule, |
| Map<Predicate<DexDefinition>, DexDefinition> preconditionSupplier, |
| ProguardIfRule ifRule) { |
| clazz.forEachField( |
| field -> { |
| DexDefinition precondition = testAndGetPrecondition(field, preconditionSupplier); |
| markField(field, memberKeepRules, rule, precondition, ifRule); |
| }); |
| } |
| |
| // TODO(b/67934426): Test this code. |
| public static void writeSeeds( |
| AppInfoWithLiveness appInfo, PrintStream out, Predicate<DexType> include) { |
| for (DexReference seed : appInfo.getPinnedItems()) { |
| if (seed.isDexType()) { |
| if (include.test(seed.asDexType())) { |
| out.println(seed.toSourceString()); |
| } |
| } else if (seed.isDexField()) { |
| DexField field = seed.asDexField(); |
| if (include.test(field.holder)) { |
| out.println( |
| field.holder.toSourceString() |
| + ": " |
| + field.type.toSourceString() |
| + " " |
| + field.name.toSourceString()); |
| } |
| } else { |
| assert seed.isDexMethod(); |
| DexMethod method = seed.asDexMethod(); |
| if (!include.test(method.holder)) { |
| continue; |
| } |
| out.print(method.holder.toSourceString() + ": "); |
| DexEncodedMethod encodedMethod = appInfo.definitionFor(method); |
| if (encodedMethod.accessFlags.isConstructor()) { |
| if (encodedMethod.accessFlags.isStatic()) { |
| out.print(Constants.CLASS_INITIALIZER_NAME); |
| } else { |
| String holderName = method.holder.toSourceString(); |
| String constrName = holderName.substring(holderName.lastIndexOf('.') + 1); |
| out.print(constrName); |
| } |
| } else { |
| out.print( |
| method.proto.returnType.toSourceString() + " " + method.name.toSourceString()); |
| } |
| boolean first = true; |
| out.print("("); |
| for (DexType param : method.proto.parameters.values) { |
| if (!first) { |
| out.print(","); |
| } |
| first = false; |
| out.print(param.toSourceString()); |
| } |
| out.println(")"); |
| } |
| } |
| out.close(); |
| } |
| |
| static boolean satisfyClassType(ProguardConfigurationRule rule, DexClass clazz) { |
| return rule.getClassType().matches(clazz) != rule.getClassTypeNegated(); |
| } |
| |
| static boolean satisfyAccessFlag(ProguardConfigurationRule rule, DexClass clazz) { |
| return rule.getClassAccessFlags().containsAll(clazz.accessFlags) |
| && rule.getNegatedClassAccessFlags().containsNone(clazz.accessFlags); |
| } |
| |
| static AnnotationMatchResult satisfyAnnotation(ProguardConfigurationRule rule, DexClass clazz) { |
| return containsAnnotation(rule.getClassAnnotation(), clazz); |
| } |
| |
| boolean satisfyInheritanceRule(DexClass clazz, ProguardConfigurationRule rule) { |
| if (satisfyExtendsRule(clazz, rule)) { |
| return true; |
| } |
| |
| return satisfyImplementsRule(clazz, rule); |
| } |
| |
| boolean satisfyExtendsRule(DexClass clazz, ProguardConfigurationRule rule) { |
| if (anySuperTypeMatchesExtendsRule(clazz.superType, rule)) { |
| return true; |
| } |
| // It is possible that this class used to inherit from another class X, but no longer does it, |
| // because X has been merged into `clazz`. |
| return anySourceMatchesInheritanceRuleDirectly(clazz, rule, false); |
| } |
| |
| boolean anySuperTypeMatchesExtendsRule(DexType type, ProguardConfigurationRule rule) { |
| while (type != null) { |
| DexClass clazz = application.definitionFor(type); |
| if (clazz == null) { |
| // TODO(herhut): Warn about broken supertype chain? |
| return false; |
| } |
| // TODO(b/110141157): Should the vertical class merger move annotations from the source to |
| // the target class? If so, it is sufficient only to apply the annotation-matcher to the |
| // annotations of `class`. |
| if (rule.getInheritanceClassName().matches(clazz.type, appView)) { |
| AnnotationMatchResult annotationMatchResult = |
| containsAnnotation(rule.getInheritanceAnnotation(), clazz); |
| if (annotationMatchResult != null) { |
| handleMatchedAnnotation(annotationMatchResult); |
| return true; |
| } |
| } |
| type = clazz.superType; |
| } |
| return false; |
| } |
| |
| boolean satisfyImplementsRule(DexClass clazz, ProguardConfigurationRule rule) { |
| if (anyImplementedInterfaceMatchesImplementsRule(clazz, rule)) { |
| return true; |
| } |
| // It is possible that this class used to implement an interface I, but no longer does it, |
| // because I has been merged into `clazz`. |
| return anySourceMatchesInheritanceRuleDirectly(clazz, rule, true); |
| } |
| |
| private boolean anyImplementedInterfaceMatchesImplementsRule( |
| DexClass clazz, ProguardConfigurationRule rule) { |
| // TODO(herhut): Maybe it would be better to do this breadth first. |
| if (clazz == null) { |
| return false; |
| } |
| for (DexType iface : clazz.interfaces.values) { |
| DexClass ifaceClass = application.definitionFor(iface); |
| if (ifaceClass == null) { |
| // TODO(herhut): Warn about broken supertype chain? |
| return false; |
| } |
| // TODO(b/110141157): Should the vertical class merger move annotations from the source to |
| // the target class? If so, it is sufficient only to apply the annotation-matcher to the |
| // annotations of `ifaceClass`. |
| if (rule.getInheritanceClassName().matches(iface, appView)) { |
| AnnotationMatchResult annotationMatchResult = |
| containsAnnotation(rule.getInheritanceAnnotation(), ifaceClass); |
| if (annotationMatchResult != null) { |
| handleMatchedAnnotation(annotationMatchResult); |
| return true; |
| } |
| } |
| if (anyImplementedInterfaceMatchesImplementsRule(ifaceClass, rule)) { |
| return true; |
| } |
| } |
| if (clazz.superType == null) { |
| return false; |
| } |
| DexClass superClass = application.definitionFor(clazz.superType); |
| if (superClass == null) { |
| // TODO(herhut): Warn about broken supertype chain? |
| return false; |
| } |
| return anyImplementedInterfaceMatchesImplementsRule(superClass, rule); |
| } |
| |
| private boolean anySourceMatchesInheritanceRuleDirectly( |
| DexClass clazz, ProguardConfigurationRule rule, boolean isInterface) { |
| // TODO(b/110141157): Figure out what to do with annotations. Should the annotations of |
| // the DexClass corresponding to `sourceType` satisfy the `annotation`-matcher? |
| return appView.verticallyMergedClasses() != null |
| && appView.verticallyMergedClasses().getSourcesFor(clazz.type).stream() |
| .filter( |
| sourceType -> |
| appView.definitionFor(sourceType).accessFlags.isInterface() == isInterface) |
| .anyMatch(rule.getInheritanceClassName()::matches); |
| } |
| |
| private boolean allRulesSatisfied(Collection<ProguardMemberRule> memberKeepRules, |
| DexClass clazz) { |
| for (ProguardMemberRule rule : memberKeepRules) { |
| if (!ruleSatisfied(rule, clazz)) { |
| return false; |
| } |
| } |
| return true; |
| } |
| |
| /** |
| * Checks whether the given rule is satisfied by this clazz, not taking superclasses into |
| * account. |
| */ |
| private boolean ruleSatisfied(ProguardMemberRule rule, DexClass clazz) { |
| return ruleSatisfiedByMethods(rule, clazz.directMethods()) |
| || ruleSatisfiedByMethods(rule, clazz.virtualMethods()) |
| || ruleSatisfiedByFields(rule, clazz.staticFields()) |
| || ruleSatisfiedByFields(rule, clazz.instanceFields()); |
| } |
| |
| boolean ruleSatisfiedByMethods(ProguardMemberRule rule, Iterable<DexEncodedMethod> methods) { |
| if (rule.getRuleType().includesMethods()) { |
| for (DexEncodedMethod method : methods) { |
| if (rule.matches(method, appView, this::handleMatchedAnnotation, dexStringCache)) { |
| return true; |
| } |
| } |
| } |
| return false; |
| } |
| |
| boolean ruleSatisfiedByFields(ProguardMemberRule rule, Iterable<DexEncodedField> fields) { |
| if (rule.getRuleType().includesFields()) { |
| for (DexEncodedField field : fields) { |
| if (rule.matches(field, appView, this::handleMatchedAnnotation, dexStringCache)) { |
| return true; |
| } |
| } |
| } |
| return false; |
| } |
| |
| static AnnotationMatchResult containsAnnotation( |
| ProguardTypeMatcher classAnnotation, DexClass clazz) { |
| return containsAnnotation(classAnnotation, clazz.annotations()); |
| } |
| |
| static <D extends DexEncodedMember<D, R>, R extends DexMember<D, R>> boolean containsAnnotation( |
| ProguardTypeMatcher classAnnotation, |
| DexEncodedMember<D, R> member, |
| Consumer<AnnotationMatchResult> matchedAnnotationsConsumer) { |
| AnnotationMatchResult annotationMatchResult = |
| containsAnnotation(classAnnotation, member.annotations()); |
| if (annotationMatchResult != null) { |
| matchedAnnotationsConsumer.accept(annotationMatchResult); |
| return true; |
| } |
| if (member.isDexEncodedMethod()) { |
| DexEncodedMethod method = member.asDexEncodedMethod(); |
| for (int i = 0; i < method.parameterAnnotationsList.size(); i++) { |
| annotationMatchResult = |
| containsAnnotation(classAnnotation, method.parameterAnnotationsList.get(i)); |
| if (annotationMatchResult != null) { |
| matchedAnnotationsConsumer.accept(annotationMatchResult); |
| return true; |
| } |
| } |
| } |
| return false; |
| } |
| |
| private static AnnotationMatchResult containsAnnotation( |
| ProguardTypeMatcher classAnnotation, DexAnnotationSet annotations) { |
| if (classAnnotation == null) { |
| return AnnotationsIgnoredMatchResult.getInstance(); |
| } |
| for (DexAnnotation annotation : annotations.annotations) { |
| if (classAnnotation.matches(annotation.annotation.type)) { |
| return new ConcreteAnnotationMatchResult(annotation); |
| } |
| } |
| return null; |
| } |
| |
| private void markMethod( |
| DexEncodedMethod method, |
| Collection<ProguardMemberRule> rules, |
| Set<Wrapper<DexMethod>> methodsMarked, |
| ProguardConfigurationRule context, |
| DexDefinition precondition, |
| ProguardIfRule ifRule) { |
| if (methodsMarked != null |
| && methodsMarked.contains(MethodSignatureEquivalence.get().wrap(method.method))) { |
| // Ignore, method is overridden in sub class. |
| return; |
| } |
| for (ProguardMemberRule rule : rules) { |
| if (rule.matches(method, appView, this::handleMatchedAnnotation, dexStringCache)) { |
| if (Log.ENABLED) { |
| Log.verbose(getClass(), "Marking method `%s` due to `%s { %s }`.", method, context, |
| rule); |
| } |
| if (methodsMarked != null) { |
| methodsMarked.add(MethodSignatureEquivalence.get().wrap(method.method)); |
| } |
| addItemToSets(method, context, rule, precondition, ifRule); |
| } |
| } |
| } |
| |
| private void markField( |
| DexEncodedField field, |
| Collection<ProguardMemberRule> rules, |
| ProguardConfigurationRule context, |
| DexDefinition precondition, |
| ProguardIfRule ifRule) { |
| for (ProguardMemberRule rule : rules) { |
| if (rule.matches(field, appView, this::handleMatchedAnnotation, dexStringCache)) { |
| if (Log.ENABLED) { |
| Log.verbose(getClass(), "Marking field `%s` due to `%s { %s }`.", field, context, |
| rule); |
| } |
| addItemToSets(field, context, rule, precondition, ifRule); |
| } |
| } |
| } |
| |
| private void markClass(DexClass clazz, ProguardConfigurationRule rule, ProguardIfRule ifRule) { |
| if (Log.ENABLED) { |
| Log.verbose(getClass(), "Marking class `%s` due to `%s`.", clazz.type, rule); |
| } |
| addItemToSets(clazz, rule, null, null, ifRule); |
| } |
| |
| private void includeDescriptor(DexDefinition item, DexType type, ProguardKeepRuleBase context) { |
| if (type.isVoidType()) { |
| return; |
| } |
| if (type.isArrayType()) { |
| type = type.toBaseType(appView.dexItemFactory()); |
| } |
| if (type.isPrimitiveType()) { |
| return; |
| } |
| DexClass definition = appView.definitionFor(type); |
| if (definition == null || definition.isNotProgramClass()) { |
| return; |
| } |
| // Keep the type if the item is also kept. |
| dependentNoShrinking |
| .computeIfAbsent(item.toReference(), x -> new IdentityHashMap<>()) |
| .computeIfAbsent(type, k -> new HashSet<>()) |
| .add(context); |
| // Unconditionally add to no-obfuscation, as that is only checked for surviving items. |
| noObfuscation.add(type); |
| } |
| |
| private void includeDescriptorClasses(DexDefinition item, ProguardKeepRuleBase context) { |
| if (item.isDexEncodedMethod()) { |
| DexMethod method = item.asDexEncodedMethod().method; |
| includeDescriptor(item, method.proto.returnType, context); |
| for (DexType value : method.proto.parameters.values) { |
| includeDescriptor(item, value, context); |
| } |
| } else if (item.isDexEncodedField()) { |
| DexField field = item.asDexEncodedField().field; |
| includeDescriptor(item, field.type, context); |
| } else { |
| assert item.isDexClass(); |
| } |
| } |
| |
| private synchronized void addItemToSets( |
| DexDefinition item, |
| ProguardConfigurationRule context, |
| ProguardMemberRule rule, |
| DexDefinition precondition, |
| ProguardIfRule ifRule) { |
| if (context instanceof ProguardKeepRule) { |
| if (item.isDexEncodedField()) { |
| DexEncodedField encodedField = item.asDexEncodedField(); |
| if (encodedField.getOptimizationInfo().cannotBeKept()) { |
| // We should only ever get here with if rules. |
| assert ifRule != null; |
| return; |
| } |
| } else if (item.isDexEncodedMethod()) { |
| DexEncodedMethod encodedMethod = item.asDexEncodedMethod(); |
| if (encodedMethod.isClassInitializer() && !options.debug) { |
| // Don't keep class initializers. |
| return; |
| } |
| if (encodedMethod.getOptimizationInfo().cannotBeKept()) { |
| // We should only ever get here with if rules. |
| assert ifRule != null; |
| return; |
| } |
| if (options.isGeneratingDex() |
| && encodedMethod.method.isLambdaDeserializeMethod(appView.dexItemFactory())) { |
| // Don't keep lambda deserialization methods. |
| return; |
| } |
| // If desugaring is enabled, private and static interface methods will be moved to a |
| // companion class. So we don't need to add them to the root set in the beginning. |
| if (options.isInterfaceMethodDesugaringEnabled() |
| && encodedMethod.hasCode() |
| && (encodedMethod.isPrivateMethod() || encodedMethod.isStaticMember())) { |
| DexClass holder = appView.definitionFor(encodedMethod.holder()); |
| if (holder != null && holder.isInterface()) { |
| if (rule.isSpecific()) { |
| options.reporter.warning( |
| new StringDiagnostic( |
| "The rule `" + rule + "` is ignored because the targeting interface method `" |
| + encodedMethod.method.toSourceString() + "` will be desugared.")); |
| } |
| return; |
| } |
| } |
| } |
| |
| // The reason for keeping should link to the conditional rule as a whole, if present. |
| ProguardKeepRuleBase keepRule = ifRule != null ? ifRule : (ProguardKeepRuleBase) context; |
| // The modifiers are specified on the actual keep rule (ie, the consequent/context). |
| ProguardKeepRuleModifiers modifiers = ((ProguardKeepRule) context).getModifiers(); |
| // In compatibility mode, for a match on instance members a referenced class becomes live. |
| if (options.forceProguardCompatibility |
| && !modifiers.allowsShrinking |
| && precondition != null |
| && precondition.isDexClass()) { |
| if (!item.isDexClass() && !item.isStaticMember()) { |
| dependentKeepClassCompatRule |
| .computeIfAbsent(precondition.asDexClass().getType(), i -> new HashSet<>()) |
| .add(keepRule); |
| context.markAsUsed(); |
| } |
| } |
| if (!modifiers.allowsShrinking) { |
| if (precondition != null) { |
| dependentNoShrinking |
| .computeIfAbsent(precondition.toReference(), x -> new IdentityHashMap<>()) |
| .computeIfAbsent(item.toReference(), i -> new HashSet<>()) |
| .add(keepRule); |
| } else { |
| noShrinking.computeIfAbsent(item.toReference(), i -> new HashSet<>()).add(keepRule); |
| } |
| context.markAsUsed(); |
| } |
| if (!modifiers.allowsOptimization) { |
| // The -dontoptimize flag has only effect through the keep all rule, but we still |
| // need to mark the rule as used. |
| context.markAsUsed(); |
| } |
| |
| if (!modifiers.allowsObfuscation) { |
| noObfuscation.add(item.toReference()); |
| context.markAsUsed(); |
| } |
| if (modifiers.includeDescriptorClasses) { |
| includeDescriptorClasses(item, keepRule); |
| context.markAsUsed(); |
| } |
| } else if (context instanceof ProguardAssumeMayHaveSideEffectsRule) { |
| mayHaveSideEffects.put(item.toReference(), rule); |
| context.markAsUsed(); |
| } else if (context instanceof ProguardAssumeNoSideEffectRule) { |
| noSideEffects.put(item.toReference(), rule); |
| context.markAsUsed(); |
| } else if (context instanceof ProguardWhyAreYouKeepingRule) { |
| reasonAsked.computeIfAbsent(item.toReference(), i -> i); |
| context.markAsUsed(); |
| } else if (context instanceof ProguardAssumeValuesRule) { |
| assumedValues.put(item.toReference(), rule); |
| context.markAsUsed(); |
| } else if (context instanceof ProguardCheckDiscardRule) { |
| checkDiscarded.computeIfAbsent(item.toReference(), i -> i); |
| context.markAsUsed(); |
| } else if (context instanceof InlineRule) { |
| if (item.isDexEncodedMethod()) { |
| switch (((InlineRule) context).getType()) { |
| case ALWAYS: |
| alwaysInline.add(item.asDexEncodedMethod().method); |
| break; |
| case FORCE: |
| forceInline.add(item.asDexEncodedMethod().method); |
| break; |
| case NEVER: |
| neverInline.add(item.asDexEncodedMethod().method); |
| break; |
| default: |
| throw new Unreachable(); |
| } |
| context.markAsUsed(); |
| } |
| } else if (context instanceof WhyAreYouNotInliningRule) { |
| if (!item.isDexEncodedMethod()) { |
| throw new Unreachable(); |
| } |
| whyAreYouNotInlining.add(item.asDexEncodedMethod().method); |
| context.markAsUsed(); |
| } else if (context.isClassInlineRule()) { |
| ClassInlineRule classInlineRule = context.asClassInlineRule(); |
| DexClass clazz = item.asDexClass(); |
| if (clazz == null) { |
| throw new IllegalStateException( |
| "Unexpected -" |
| + classInlineRule.typeString() |
| + " rule for a non-class type: `" |
| + item.toReference().toSourceString() |
| + "`"); |
| } |
| switch (classInlineRule.getType()) { |
| case ALWAYS: |
| alwaysClassInline.addElement(item.asDexClass().type); |
| break; |
| case NEVER: |
| neverClassInline.add(item.asDexClass().type); |
| break; |
| default: |
| throw new Unreachable(); |
| } |
| context.markAsUsed(); |
| } else if (context instanceof ClassMergingRule) { |
| switch (((ClassMergingRule) context).getType()) { |
| case NEVER: |
| if (item.isDexClass()) { |
| neverMerge.add(item.asDexClass().type); |
| } |
| break; |
| default: |
| throw new Unreachable(); |
| } |
| context.markAsUsed(); |
| } else if (context instanceof MemberValuePropagationRule) { |
| switch (((MemberValuePropagationRule) context).getType()) { |
| case NEVER: |
| // Only add members from propgram classes to `neverPropagateValue` since class member |
| // values from library types are not propagated by default. |
| if (item.isDexEncodedField()) { |
| DexEncodedField field = item.asDexEncodedField(); |
| if (field.isProgramField(appView)) { |
| neverPropagateValue.add(item.asDexEncodedField().field); |
| context.markAsUsed(); |
| } |
| } else if (item.isDexEncodedMethod()) { |
| DexEncodedMethod method = item.asDexEncodedMethod(); |
| if (method.isProgramMethod(appView)) { |
| neverPropagateValue.add(item.asDexEncodedMethod().method); |
| context.markAsUsed(); |
| } |
| } |
| break; |
| default: |
| throw new Unreachable(); |
| } |
| } else if (context instanceof ProguardIdentifierNameStringRule) { |
| if (item.isDexEncodedField()) { |
| identifierNameStrings.add(item.asDexEncodedField().field); |
| context.markAsUsed(); |
| } else if (item.isDexEncodedMethod()) { |
| identifierNameStrings.add(item.asDexEncodedMethod().method); |
| context.markAsUsed(); |
| } |
| } else if (context instanceof ConstantArgumentRule) { |
| if (item.isDexEncodedMethod()) { |
| keepParametersWithConstantValue.add(item.asDexEncodedMethod().method); |
| context.markAsUsed(); |
| } |
| } else if (context instanceof ReprocessClassInitializerRule) { |
| DexProgramClass clazz = item.asProgramClass(); |
| if (clazz != null && clazz.hasClassInitializer()) { |
| switch (context.asReprocessClassInitializerRule().getType()) { |
| case ALWAYS: |
| reprocess.add(clazz.getClassInitializer().method); |
| break; |
| case NEVER: |
| neverReprocess.add(clazz.getClassInitializer().method); |
| break; |
| default: |
| throw new Unreachable(); |
| } |
| context.markAsUsed(); |
| } |
| } else if (context.isReprocessMethodRule()) { |
| if (item.isDexEncodedMethod()) { |
| DexEncodedMethod method = item.asDexEncodedMethod(); |
| switch (context.asReprocessMethodRule().getType()) { |
| case ALWAYS: |
| reprocess.add(method.method); |
| break; |
| case NEVER: |
| neverReprocess.add(method.method); |
| break; |
| default: |
| throw new Unreachable(); |
| } |
| context.markAsUsed(); |
| } |
| } else if (context instanceof UnusedArgumentRule) { |
| if (item.isDexEncodedMethod()) { |
| keepUnusedArguments.add(item.asDexEncodedMethod().method); |
| context.markAsUsed(); |
| } |
| } else { |
| throw new Unreachable(); |
| } |
| } |
| |
| public static class RootSet { |
| |
| public final Map<DexReference, Set<ProguardKeepRuleBase>> noShrinking; |
| private final Set<DexReference> noObfuscation; |
| public final ImmutableList<DexReference> reasonAsked; |
| public final ImmutableList<DexReference> checkDiscarded; |
| public final Set<DexMethod> alwaysInline; |
| public final Set<DexMethod> forceInline; |
| public final Set<DexMethod> neverInline; |
| public final Set<DexMethod> bypassClinitForInlining; |
| public final Set<DexMethod> whyAreYouNotInlining; |
| public final Set<DexMethod> keepConstantArguments; |
| public final Set<DexMethod> keepUnusedArguments; |
| public final Set<DexMethod> reprocess; |
| public final Set<DexMethod> neverReprocess; |
| public final PredicateSet<DexType> alwaysClassInline; |
| public final Set<DexType> neverClassInline; |
| public final Set<DexType> neverMerge; |
| public final Set<DexReference> neverPropagateValue; |
| public final Map<DexReference, ProguardMemberRule> mayHaveSideEffects; |
| public final Map<DexReference, ProguardMemberRule> noSideEffects; |
| public final Map<DexReference, ProguardMemberRule> assumedValues; |
| private final Map<DexReference, Map<DexReference, Set<ProguardKeepRuleBase>>> |
| dependentNoShrinking; |
| private final Map<DexType, Set<ProguardKeepRuleBase>> dependentKeepClassCompatRule; |
| public final Set<DexReference> identifierNameStrings; |
| public final Set<ProguardIfRule> ifRules; |
| public final List<DelayedRootSetActionItem> delayedRootSetActionItems; |
| |
| private RootSet( |
| Map<DexReference, Set<ProguardKeepRuleBase>> noShrinking, |
| Set<DexReference> noObfuscation, |
| ImmutableList<DexReference> reasonAsked, |
| ImmutableList<DexReference> checkDiscarded, |
| Set<DexMethod> alwaysInline, |
| Set<DexMethod> forceInline, |
| Set<DexMethod> neverInline, |
| Set<DexMethod> bypassClinitForInlining, |
| Set<DexMethod> whyAreYouNotInlining, |
| Set<DexMethod> keepConstantArguments, |
| Set<DexMethod> keepUnusedArguments, |
| Set<DexMethod> reprocess, |
| Set<DexMethod> neverReprocess, |
| PredicateSet<DexType> alwaysClassInline, |
| Set<DexType> neverClassInline, |
| Set<DexType> neverMerge, |
| Set<DexReference> neverPropagateValue, |
| Map<DexReference, ProguardMemberRule> mayHaveSideEffects, |
| Map<DexReference, ProguardMemberRule> noSideEffects, |
| Map<DexReference, ProguardMemberRule> assumedValues, |
| Map<DexReference, Map<DexReference, Set<ProguardKeepRuleBase>>> dependentNoShrinking, |
| Map<DexType, Set<ProguardKeepRuleBase>> dependentKeepClassCompatRule, |
| Set<DexReference> identifierNameStrings, |
| Set<ProguardIfRule> ifRules, |
| List<DelayedRootSetActionItem> delayedRootSetActionItems) { |
| this.noShrinking = noShrinking; |
| this.noObfuscation = noObfuscation; |
| this.reasonAsked = reasonAsked; |
| this.checkDiscarded = checkDiscarded; |
| this.alwaysInline = Collections.unmodifiableSet(alwaysInline); |
| this.forceInline = Collections.unmodifiableSet(forceInline); |
| this.neverInline = neverInline; |
| this.bypassClinitForInlining = bypassClinitForInlining; |
| this.whyAreYouNotInlining = whyAreYouNotInlining; |
| this.keepConstantArguments = keepConstantArguments; |
| this.keepUnusedArguments = keepUnusedArguments; |
| this.reprocess = reprocess; |
| this.neverReprocess = neverReprocess; |
| this.alwaysClassInline = alwaysClassInline; |
| this.neverClassInline = neverClassInline; |
| this.neverMerge = Collections.unmodifiableSet(neverMerge); |
| this.neverPropagateValue = neverPropagateValue; |
| this.mayHaveSideEffects = mayHaveSideEffects; |
| this.noSideEffects = noSideEffects; |
| this.assumedValues = assumedValues; |
| this.dependentNoShrinking = dependentNoShrinking; |
| this.dependentKeepClassCompatRule = dependentKeepClassCompatRule; |
| this.identifierNameStrings = Collections.unmodifiableSet(identifierNameStrings); |
| this.ifRules = Collections.unmodifiableSet(ifRules); |
| this.delayedRootSetActionItems = delayedRootSetActionItems; |
| } |
| |
| public void checkAllRulesAreUsed(InternalOptions options) { |
| List<ProguardConfigurationRule> rules = options.getProguardConfiguration().getRules(); |
| if (rules != null) { |
| for (ProguardConfigurationRule rule : rules) { |
| if (!rule.isUsed()) { |
| String message = |
| "Proguard configuration rule does not match anything: `" + rule.toString() + "`"; |
| StringDiagnostic diagnostic = new StringDiagnostic(message, rule.getOrigin()); |
| if (options.testing.reportUnusedProguardConfigurationRules) { |
| options.reporter.info(diagnostic); |
| } |
| } |
| } |
| } |
| } |
| |
| void addConsequentRootSet(ConsequentRootSet consequentRootSet, boolean addNoShrinking) { |
| neverInline.addAll(consequentRootSet.neverInline); |
| neverClassInline.addAll(consequentRootSet.neverClassInline); |
| noObfuscation.addAll(consequentRootSet.noObfuscation); |
| if (addNoShrinking) { |
| consequentRootSet.noShrinking.forEach( |
| (type, rules) -> noShrinking.computeIfAbsent(type, k -> new HashSet<>()).addAll(rules)); |
| } |
| addDependentItems(consequentRootSet.dependentNoShrinking); |
| consequentRootSet.dependentKeepClassCompatRule.forEach( |
| (type, rules) -> |
| dependentKeepClassCompatRule.computeIfAbsent( |
| type, k -> new HashSet<>()).addAll(rules)); |
| delayedRootSetActionItems.addAll(consequentRootSet.delayedRootSetActionItems); |
| } |
| |
| // Add dependent items that depend on -if rules. |
| private void addDependentItems( |
| Map<DexReference, Map<DexReference, Set<ProguardKeepRuleBase>>> dependentItems) { |
| dependentItems.forEach( |
| (reference, dependence) -> |
| dependentNoShrinking |
| .computeIfAbsent(reference, x -> new IdentityHashMap<>()) |
| .putAll(dependence)); |
| } |
| |
| Set<ProguardKeepRuleBase> getDependentKeepClassCompatRule(DexType type) { |
| return dependentKeepClassCompatRule.get(type); |
| } |
| |
| Map<DexReference, Set<ProguardKeepRuleBase>> getDependentItems(DexDefinition item) { |
| return Collections.unmodifiableMap( |
| dependentNoShrinking.getOrDefault(item.toReference(), Collections.emptyMap())); |
| } |
| |
| public void forEachDependentStaticMember( |
| DexDefinition item, |
| AppView<?> appView, |
| Consumer3<DexDefinition, DexDefinition, Set<ProguardKeepRuleBase>> fn) { |
| getDependentItems(item) |
| .forEach( |
| (reference, reasons) -> { |
| DexDefinition definition = appView.definitionFor(reference); |
| if (definition != null && !definition.isDexClass() && definition.isStaticMember()) { |
| fn.accept(item, definition, reasons); |
| } |
| }); |
| } |
| |
| public void forEachDependentNonStaticMember( |
| DexDefinition item, |
| AppView<?> appView, |
| Consumer3<DexDefinition, DexDefinition, Set<ProguardKeepRuleBase>> fn) { |
| getDependentItems(item) |
| .forEach( |
| (reference, reasons) -> { |
| DexDefinition definition = appView.definitionFor(reference); |
| if (definition != null |
| && !definition.isDexClass() |
| && !definition.isStaticMember()) { |
| fn.accept(item, definition, reasons); |
| } |
| }); |
| } |
| |
| public void forEachDependentInstanceConstructor( |
| DexProgramClass clazz, |
| AppView<?> appView, |
| Consumer3<DexProgramClass, DexEncodedMethod, Set<ProguardKeepRuleBase>> fn) { |
| getDependentItems(clazz) |
| .forEach( |
| (reference, reasons) -> { |
| DexDefinition definition = appView.definitionFor(reference); |
| if (definition != null |
| && definition.isDexEncodedMethod() |
| && definition.asDexEncodedMethod().isInstanceInitializer()) { |
| fn.accept(clazz, definition.asDexEncodedMethod(), reasons); |
| } |
| }); |
| } |
| |
| public void copy(DexReference original, DexReference rewritten) { |
| if (noShrinking.containsKey(original)) { |
| noShrinking.put(rewritten, noShrinking.get(original)); |
| } |
| if (noObfuscation.contains(original)) { |
| noObfuscation.add(rewritten); |
| } |
| if (noSideEffects.containsKey(original)) { |
| noSideEffects.put(rewritten, noSideEffects.get(original)); |
| } |
| if (assumedValues.containsKey(original)) { |
| assumedValues.put(rewritten, assumedValues.get(original)); |
| } |
| } |
| |
| public void prune(DexReference reference) { |
| noShrinking.remove(reference); |
| noObfuscation.remove(reference); |
| noSideEffects.remove(reference); |
| assumedValues.remove(reference); |
| } |
| |
| public void move(DexReference original, DexReference rewritten) { |
| copy(original, rewritten); |
| prune(original); |
| } |
| |
| void shouldNotBeMinified(DexReference reference) { |
| noObfuscation.add(reference); |
| } |
| |
| public boolean mayBeMinified(DexReference reference, AppView<?> appView) { |
| return !mayNotBeMinified(reference, appView); |
| } |
| |
| public boolean mayNotBeMinified(DexReference reference, AppView<?> appView) { |
| if (reference.isDexType()) { |
| return noObfuscation.contains( |
| appView.graphLense().getOriginalType(reference.asDexType())); |
| } else if (reference.isDexMethod()) { |
| return noObfuscation.contains( |
| appView.graphLense().getOriginalMethodSignature(reference.asDexMethod())); |
| } else { |
| assert reference.isDexField(); |
| return noObfuscation.contains( |
| appView.graphLense().getOriginalFieldSignature(reference.asDexField())); |
| } |
| } |
| |
| public boolean verifyKeptFieldsAreAccessedAndLive(AppInfoWithLiveness appInfo) { |
| for (DexReference reference : noShrinking.keySet()) { |
| if (reference.isDexField()) { |
| DexField field = reference.asDexField(); |
| DexEncodedField encodedField = appInfo.definitionFor(field); |
| if (encodedField != null |
| && (encodedField.isStatic() || isKeptDirectlyOrIndirectly(field.holder, appInfo))) { |
| assert appInfo.isFieldRead(encodedField) |
| : "Expected kept field `" + field.toSourceString() + "` to be read"; |
| assert appInfo.isFieldWritten(encodedField) |
| : "Expected kept field `" + field.toSourceString() + "` to be written"; |
| } |
| } |
| } |
| return true; |
| } |
| |
| public boolean verifyKeptMethodsAreTargetedAndLive(AppInfoWithLiveness appInfo) { |
| for (DexReference reference : noShrinking.keySet()) { |
| if (reference.isDexMethod()) { |
| DexMethod method = reference.asDexMethod(); |
| assert appInfo.targetedMethods.contains(method) |
| : "Expected kept method `" + method.toSourceString() + "` to be targeted"; |
| DexEncodedMethod encodedMethod = appInfo.definitionFor(method); |
| if (!encodedMethod.accessFlags.isAbstract() |
| && isKeptDirectlyOrIndirectly(method.holder, appInfo)) { |
| assert appInfo.liveMethods.contains(method) |
| : "Expected non-abstract kept method `" |
| + method.toSourceString() |
| + "` to be live"; |
| } |
| } |
| } |
| return true; |
| } |
| |
| public boolean verifyKeptTypesAreLive(AppInfoWithLiveness appInfo) { |
| for (DexReference reference : noShrinking.keySet()) { |
| if (reference.isDexType()) { |
| DexType type = reference.asDexType(); |
| assert appInfo.isLiveProgramType(type) |
| : "Expected kept type `" + type.toSourceString() + "` to be live"; |
| } |
| } |
| return true; |
| } |
| |
| private boolean isKeptDirectlyOrIndirectly(DexType type, AppInfoWithLiveness appInfo) { |
| if (noShrinking.containsKey(type)) { |
| return true; |
| } |
| DexClass clazz = appInfo.definitionFor(type); |
| if (clazz == null) { |
| return false; |
| } |
| if (clazz.superType != null) { |
| return isKeptDirectlyOrIndirectly(clazz.superType, appInfo); |
| } |
| return false; |
| } |
| |
| public boolean verifyKeptItemsAreKept(DexApplication application, AppInfo appInfo) { |
| Set<DexReference> pinnedItems = |
| appInfo.hasLiveness() ? appInfo.withLiveness().pinnedItems : null; |
| |
| // Create a mapping from each required type to the set of required members on that type. |
| Map<DexType, Set<DexReference>> requiredReferencesPerType = new IdentityHashMap<>(); |
| for (DexReference reference : noShrinking.keySet()) { |
| // Check that `pinnedItems` is a super set of the root set. |
| assert pinnedItems == null || pinnedItems.contains(reference) |
| : "Expected reference `" + reference.toSourceString() + "` to be pinned"; |
| if (reference.isDexType()) { |
| DexType type = reference.asDexType(); |
| requiredReferencesPerType.putIfAbsent(type, Sets.newIdentityHashSet()); |
| } else { |
| assert reference.isDexField() || reference.isDexMethod(); |
| DexType holder = |
| reference.isDexField() |
| ? reference.asDexField().holder |
| : reference.asDexMethod().holder; |
| requiredReferencesPerType |
| .computeIfAbsent(holder, key -> Sets.newIdentityHashSet()) |
| .add(reference); |
| } |
| } |
| |
| // Run through each class in the program and check that it has members it must have. |
| for (DexProgramClass clazz : application.classes()) { |
| Set<DexReference> requiredReferences = |
| requiredReferencesPerType.getOrDefault(clazz.type, ImmutableSet.of()); |
| |
| Set<DexField> fields = null; |
| Set<DexMethod> methods = null; |
| |
| for (DexReference requiredReference : requiredReferences) { |
| if (requiredReference.isDexField()) { |
| DexField requiredField = requiredReference.asDexField(); |
| if (fields == null) { |
| // Create a Set of the fields to avoid quadratic behavior. |
| fields = |
| Streams.stream(clazz.fields()) |
| .map(DexEncodedField::toReference) |
| .collect(Collectors.toSet()); |
| } |
| assert fields.contains(requiredField) |
| : "Expected field `" |
| + requiredField.toSourceString() |
| + "` from the root set to be present"; |
| } else if (requiredReference.isDexMethod()) { |
| DexMethod requiredMethod = requiredReference.asDexMethod(); |
| if (methods == null) { |
| // Create a Set of the methods to avoid quadratic behavior. |
| methods = |
| Streams.stream(clazz.methods()) |
| .map(DexEncodedMethod::toReference) |
| .collect(Collectors.toSet()); |
| } |
| assert methods.contains(requiredMethod) |
| : "Expected method `" |
| + requiredMethod.toSourceString() |
| + "` from the root set to be present"; |
| } else { |
| assert false; |
| } |
| } |
| requiredReferencesPerType.remove(clazz.type); |
| } |
| |
| // If the map is non-empty, then a type in the root set was not in the application. |
| if (!requiredReferencesPerType.isEmpty()) { |
| DexType type = requiredReferencesPerType.keySet().iterator().next(); |
| DexClass clazz = application.definitionFor(type); |
| assert clazz == null || clazz.isProgramClass() |
| : "Unexpected library type in root set: `" + type + "`"; |
| assert requiredReferencesPerType.isEmpty() |
| : "Expected type `" + type.toSourceString() + "` to be present"; |
| } |
| |
| return true; |
| } |
| |
| @Override |
| public String toString() { |
| StringBuilder builder = new StringBuilder(); |
| builder.append("RootSet"); |
| |
| builder.append("\nnoShrinking: " + noShrinking.size()); |
| builder.append("\nnoObfuscation: " + noObfuscation.size()); |
| builder.append("\nreasonAsked: " + reasonAsked.size()); |
| builder.append("\ncheckDiscarded: " + checkDiscarded.size()); |
| builder.append("\nnoSideEffects: " + noSideEffects.size()); |
| builder.append("\nassumedValues: " + assumedValues.size()); |
| builder.append("\ndependentNoShrinking: " + dependentNoShrinking.size()); |
| builder.append("\nidentifierNameStrings: " + identifierNameStrings.size()); |
| builder.append("\nifRules: " + ifRules.size()); |
| |
| builder.append("\n\nNo Shrinking:"); |
| noShrinking.keySet().stream() |
| .sorted(Comparator.comparing(DexReference::toSourceString)) |
| .forEach(a -> builder |
| .append("\n").append(a.toSourceString()).append(" ").append(noShrinking.get(a))); |
| builder.append("\n"); |
| return builder.toString(); |
| } |
| } |
| |
| // A partial RootSet that becomes live due to the enabled -if rule or the addition of interface |
| // keep rules. |
| public static class ConsequentRootSet { |
| final Set<DexMethod> neverInline; |
| final Set<DexType> neverClassInline; |
| final Map<DexReference, Set<ProguardKeepRuleBase>> noShrinking; |
| final Set<DexReference> noObfuscation; |
| final Map<DexReference, Map<DexReference, Set<ProguardKeepRuleBase>>> dependentNoShrinking; |
| final Map<DexType, Set<ProguardKeepRuleBase>> dependentKeepClassCompatRule; |
| final List<DelayedRootSetActionItem> delayedRootSetActionItems; |
| |
| private ConsequentRootSet( |
| Set<DexMethod> neverInline, |
| Set<DexType> neverClassInline, |
| Map<DexReference, Set<ProguardKeepRuleBase>> noShrinking, |
| Set<DexReference> noObfuscation, |
| Map<DexReference, Map<DexReference, Set<ProguardKeepRuleBase>>> dependentNoShrinking, |
| Map<DexType, Set<ProguardKeepRuleBase>> dependentKeepClassCompatRule, |
| List<DelayedRootSetActionItem> delayedRootSetActionItems) { |
| this.neverInline = Collections.unmodifiableSet(neverInline); |
| this.neverClassInline = Collections.unmodifiableSet(neverClassInline); |
| this.noShrinking = Collections.unmodifiableMap(noShrinking); |
| this.noObfuscation = Collections.unmodifiableSet(noObfuscation); |
| this.dependentNoShrinking = Collections.unmodifiableMap(dependentNoShrinking); |
| this.dependentKeepClassCompatRule = Collections.unmodifiableMap(dependentKeepClassCompatRule); |
| this.delayedRootSetActionItems = Collections.unmodifiableList(delayedRootSetActionItems); |
| } |
| } |
| } |
