com.android.build.gradle.shrinker

Class JavaSerializationShrinkerGraph

java.lang.Object

com.android.build.gradle.shrinker.JavaSerializationShrinkerGraph

All Implemented Interfaces:

ShrinkerGraph<java.lang.String>

public class JavaSerializationShrinkerGraph
extends java.lang.Object
implements ShrinkerGraph<java.lang.String>

Simple ShrinkerGraph implementation that uses strings, maps and Java serialization.

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(java.lang.String node, java.lang.String annotationName) Adds an annotation to the given node.
java.lang.String	addClass(java.lang.String name, java.lang.String superName, java.lang.String[] interfaces, int modifiers, java.io.File classFile) Creates a new node representing the given class, and adds it to the graph.
void	addDependency(java.lang.String source, java.lang.String target, DependencyType type) Adds a new dependency (edge) to the graph.
java.lang.String	addMember(java.lang.String owner, java.lang.String name, java.lang.String desc, int modifiers) Creates a new node representing the given class member (method or field), and adds it to the graph.
void	addRoots(java.util.Map<java.lang.String,DependencyType> symbolsToKeep, AbstractShrinker.CounterSet counterSet) Adds the given roots to the graph, for the given AbstractShrinker.CounterSet.
void	addTypeFromGenericSignature(java.lang.String klass, java.lang.String type) Records a type referenced in the generic signatures by the given class.
void	checkDependencies(ShrinkerLogger shrinkerLogger) Checks that all edges in the graph point to fully known nodes.
void	clearCounters(com.android.ide.common.internal.WaitableExecutor executor) Clears all the counters, for all nodes.
static JavaSerializationShrinkerGraph	empty(java.io.File stateDir)
java.lang.String	findMatchingMethod(java.lang.String klass, java.lang.String method) Searches the given class for a method with the same name and descriptor as the provided method.
java.lang.Iterable<java.lang.String>	getAllProgramClasses() Returns all nodes that represent program classes.
java.lang.Iterable<java.lang.String>	getAnnotations(java.lang.String node) Returns all annotations present on the given node.
java.lang.String	getClassName(java.lang.String klass) Returns the internal class name for the given class node.
java.lang.String	getClassReference(java.lang.String className) Returns the node representing the given class.
java.util.Set<Dependency<java.lang.String>>	getDependencies(java.lang.String node) Returns all dependencies of the given node, i.e.
java.util.Set<java.lang.String>	getFields(java.lang.String klass) Returns all fields of the given class.
java.lang.String	getFullMemberName(java.lang.String member) Returns the full name of a given method or field, e.g.
java.lang.String[]	getInterfaces(java.lang.String klass) Gets the interfaces of a given class.
java.lang.String	getMemberDescriptor(java.lang.String member) Returns the name of a given method or field.
java.lang.String	getMemberName(java.lang.String member) Returns the name of a given method or field.
java.lang.String	getMemberReference(java.lang.String className, java.lang.String memberName, java.lang.String desc) Returns the node representing a given class member (method or field).
java.util.Set<java.lang.String>	getMethods(java.lang.String klass) Returns all methods of the given class.
int	getModifiers(java.lang.String node) Returns the modifiers for the given node, as used by ClassVisitor.
java.lang.String	getOwnerClass(java.lang.String member) Returns the owner class of a given method or field.
java.util.Set<java.lang.String>	getReachableClasses(AbstractShrinker.CounterSet counterSet) Returns all classes that are reachable in a given AbstractShrinker.CounterSet.
java.util.Set<java.lang.String>	getReachableMembersLocalNames(java.lang.String klass, AbstractShrinker.CounterSet counterSet) Returns all the reachable members of the given class, in the name:desc format, without the class name at the front.
java.util.Map<java.lang.String,DependencyType>	getRoots(AbstractShrinker.CounterSet counterSet) Returns the roots.
java.io.File	getSourceFile(java.lang.String klass) Returns the source file that this class was read from.
java.lang.String	getSuperclass(java.lang.String klass) Returns the superclass of the given class.
java.util.Set<java.lang.String>	getTypesFromGenericSignatures(java.lang.String klass) Gets all types referenced from generic signatures of a given class.
boolean	incrementAndCheck(java.lang.String node, DependencyType type, AbstractShrinker.CounterSet counterSet) Increments the counter of the given type (DependencyType) and checks if this operation made the node reachable, atomically.
boolean	isClassKnown(java.lang.String klass) Checks if the given given (representing a class) was added to the graph.
boolean	isProgramClass(java.lang.String klass) Checks if the given class comes from the program or the platform (and we don't control it).
boolean	isReachable(java.lang.String node, AbstractShrinker.CounterSet counterSet) Checks if the given node is reachable, using the given AbstractShrinker.CounterSet.
static JavaSerializationShrinkerGraph	readFromDir(java.io.File dir, java.lang.ClassLoader classLoader) Constructs a graph by deserializing saved state.
void	removeAllCodeDependencies(java.lang.String node) Removes all DependencyType.REQUIRED_CODE_REFERENCE and DependencyType.REQUIRED_CODE_REFERENCE_REFLECTION edges that start from the given node.
void	saveState() Serializes the graph to disk, in a location that will be known when building incrementally.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

empty

public static JavaSerializationShrinkerGraph empty(java.io.File stateDir)

readFromDir

public static JavaSerializationShrinkerGraph readFromDir(@NonNull
                                                         java.io.File dir,
                                                         @NonNull
                                                         java.lang.ClassLoader classLoader)
                                                  throws java.io.IOException

Constructs a graph by deserializing saved state.

Parameters:

dir - directory where the state was saved

classLoader - class loader used to resolve class names

Throws:

java.io.IOException

addMember

@NonNull
public java.lang.String addMember(@NonNull
                                           java.lang.String owner,
                                           @NonNull
                                           java.lang.String name,
                                           @NonNull
                                           java.lang.String desc,
                                           int modifiers)

Description copied from interface: ShrinkerGraph

Creates a new node representing the given class member (method or field), and adds it to the graph.

Specified by:

addMember in interface ShrinkerGraph<java.lang.String>

Parameters:

owner - internal name of the owner class

name - class member name

desc - class member descriptor

modifiers - modifiers bit set, as used by ClassVisitor

Returns:

the newly created node

getMemberReference

@NonNull
public java.lang.String getMemberReference(@NonNull
                                                    java.lang.String className,
                                                    @NonNull
                                                    java.lang.String memberName,
                                                    @NonNull
                                                    java.lang.String desc)

Description copied from interface: ShrinkerGraph

Returns the node representing a given class member (method or field). It may not be fully initialized yet, if the class file for the owner class has not been read yet.

Specified by:

getMemberReference in interface ShrinkerGraph<java.lang.String>

Parameters:

className - internal name of the owner class

memberName - member name

desc - member descriptor

Returns:

node representing the class member

addDependency

public void addDependency(@NonNull
                          java.lang.String source,
                          @NonNull
                          java.lang.String target,
                          @NonNull
                          DependencyType type)

Description copied from interface: ShrinkerGraph

Adds a new dependency (edge) to the graph.

Specified by:

addDependency in interface ShrinkerGraph<java.lang.String>

Parameters:

source - source node

target - target node

type - edge type

getDependencies

@NonNull
public java.util.Set<Dependency<java.lang.String>> getDependencies(@NonNull
                                                                            java.lang.String node)

Description copied from interface: ShrinkerGraph

Returns all dependencies of the given node, i.e. outgoing graph edges.

Specified by:

getDependencies in interface ShrinkerGraph<java.lang.String>

getMethods

@NonNull
public java.util.Set<java.lang.String> getMethods(@NonNull
                                                           java.lang.String klass)

Description copied from interface: ShrinkerGraph

Returns all methods of the given class.

Specified by:

getMethods in interface ShrinkerGraph<java.lang.String>

getFields

@NonNull
public java.util.Set<java.lang.String> getFields(@NonNull
                                                          java.lang.String klass)

Description copied from interface: ShrinkerGraph

Returns all fields of the given class.

Specified by:

getFields in interface ShrinkerGraph<java.lang.String>

incrementAndCheck

public boolean incrementAndCheck(@NonNull
                                 java.lang.String node,
                                 @NonNull
                                 DependencyType type,
                                 @NonNull
                                 AbstractShrinker.CounterSet counterSet)

Description copied from interface: ShrinkerGraph

Increments the counter of the given type (DependencyType) and checks if this operation made the node reachable, atomically.

Specified by:

incrementAndCheck in interface ShrinkerGraph<java.lang.String>

Parameters:

node - graph node

type - type of counter

counterSet - the AbstractShrinker.CounterSet to use

Returns:

true if this operation made the node reachable, false otherwise

saveState

public void saveState()
               throws java.io.IOException

Description copied from interface: ShrinkerGraph

Serializes the graph to disk, in a location that will be known when building incrementally.

Specified by:

saveState in interface ShrinkerGraph<java.lang.String>

Throws:

java.io.IOException

isReachable

public boolean isReachable(@NonNull
                           java.lang.String node,
                           @NonNull
                           AbstractShrinker.CounterSet counterSet)

Description copied from interface: ShrinkerGraph

Checks if the given node is reachable, using the given AbstractShrinker.CounterSet.

Specified by:

isReachable in interface ShrinkerGraph<java.lang.String>

removeAllCodeDependencies

public void removeAllCodeDependencies(@NonNull
                                      java.lang.String node)

Description copied from interface: ShrinkerGraph

Removes all DependencyType.REQUIRED_CODE_REFERENCE and DependencyType.REQUIRED_CODE_REFERENCE_REFLECTION edges that start from the given node.

Specified by:

removeAllCodeDependencies in interface ShrinkerGraph<java.lang.String>

getSuperclass

@Nullable
public java.lang.String getSuperclass(@NonNull
                                                java.lang.String klass)
                                         throws ClassLookupException

Description copied from interface: ShrinkerGraph

Returns the superclass of the given class.

Specified by:

getSuperclass in interface ShrinkerGraph<java.lang.String>

Throws:

ClassLookupException - if the node for the superclass has not been created (yet?).

findMatchingMethod

@Nullable
public java.lang.String findMatchingMethod(@NonNull
                                                     java.lang.String klass,
                                                     @NonNull
                                                     java.lang.String method)

Description copied from interface: ShrinkerGraph

Searches the given class for a method with the same name and descriptor as the provided method. This can be used to look for overrides.

Specified by:

findMatchingMethod in interface ShrinkerGraph<java.lang.String>

Parameters:

klass - class to search

method - method to match

Returns:

a node representing the matching method if found, null otherwise

isProgramClass

public boolean isProgramClass(@NonNull
                              java.lang.String klass)

Description copied from interface: ShrinkerGraph

Checks if the given class comes from the program or the platform (and we don't control it).

Program classes are written to the output and can be changed in the process. Library classes come from the SDK and we don't control them.

Specified by:

isProgramClass in interface ShrinkerGraph<java.lang.String>

getInterfaces

@NonNull
public java.lang.String[] getInterfaces(java.lang.String klass)
                                          throws ClassLookupException

Description copied from interface: ShrinkerGraph

Gets the interfaces of a given class.

Specified by:

getInterfaces in interface ShrinkerGraph<java.lang.String>

Throws:

ClassLookupException - if the node for one of the interfaces has not been created (yet)

checkDependencies

public void checkDependencies(ShrinkerLogger shrinkerLogger)

Description copied from interface: ShrinkerGraph

Checks that all edges in the graph point to fully known nodes.

If it's not the case, warnings are emitted using the given ShrinkerLogger and these edges are removed from the graph.

Specified by:

checkDependencies in interface ShrinkerGraph<java.lang.String>

addTypeFromGenericSignature

public void addTypeFromGenericSignature(@NonNull
                                        java.lang.String klass,
                                        @NonNull
                                        java.lang.String type)

Description copied from interface: ShrinkerGraph

Records a type referenced in the generic signatures by the given class.

Specified by:

addTypeFromGenericSignature in interface ShrinkerGraph<java.lang.String>

getTypesFromGenericSignatures

@NonNull
public java.util.Set<java.lang.String> getTypesFromGenericSignatures(@NonNull
                                                                              java.lang.String klass)

Description copied from interface: ShrinkerGraph

Gets all types referenced from generic signatures of a given class.

Specified by:

getTypesFromGenericSignatures in interface ShrinkerGraph<java.lang.String>

getReachableClasses

@NonNull
public java.util.Set<java.lang.String> getReachableClasses(@NonNull
                                                                    AbstractShrinker.CounterSet counterSet)

Description copied from interface: ShrinkerGraph

Returns all classes that are reachable in a given AbstractShrinker.CounterSet.

Specified by:

getReachableClasses in interface ShrinkerGraph<java.lang.String>

getSourceFile

public java.io.File getSourceFile(@NonNull
                                  java.lang.String klass)

Description copied from interface: ShrinkerGraph

Returns the source file that this class was read from. Return null for library classes.

Specified by:

getSourceFile in interface ShrinkerGraph<java.lang.String>

getReachableMembersLocalNames

@NonNull
public java.util.Set<java.lang.String> getReachableMembersLocalNames(@NonNull
                                                                              java.lang.String klass,
                                                                              @NonNull
                                                                              AbstractShrinker.CounterSet counterSet)

Description copied from interface: ShrinkerGraph

Returns all the reachable members of the given class, in the name:desc format, without the class name at the front.

Specified by:

getReachableMembersLocalNames in interface ShrinkerGraph<java.lang.String>

getOwnerClass

@NonNull
public java.lang.String getOwnerClass(@NonNull
                                               java.lang.String member)

Description copied from interface: ShrinkerGraph

Returns the owner class of a given method or field.

Specified by:

getOwnerClass in interface ShrinkerGraph<java.lang.String>

Parameters:

member - node representing a given class member

Returns:

node representing the owner class

getClassReference

@NonNull
public java.lang.String getClassReference(@NonNull
                                                   java.lang.String className)

Description copied from interface: ShrinkerGraph

Returns the node representing the given class. It may not be fully initialized yet, if the class file for the class in question has not been read yet.

Specified by:

getClassReference in interface ShrinkerGraph<java.lang.String>

Parameters:

className - internal name of the class

Returns:

node representing the class

addClass

@NonNull
public java.lang.String addClass(@NonNull
                                          java.lang.String name,
                                          @Nullable
                                          java.lang.String superName,
                                          @Nullable
                                          java.lang.String[] interfaces,
                                          int modifiers,
                                          @Nullable
                                          java.io.File classFile)

Description copied from interface: ShrinkerGraph

Creates a new node representing the given class, and adds it to the graph.

Specified by:

addClass in interface ShrinkerGraph<java.lang.String>

Parameters:

name - internal name of the class

superName - internal name of the superclass

interfaces - internal names of the interfaces

modifiers - modifiers bit set, as used by ClassVisitor

classFile - class file that contains the given class

Returns:

the newly created node

getAllProgramClasses

@NonNull
public java.lang.Iterable<java.lang.String> getAllProgramClasses()

Description copied from interface: ShrinkerGraph

Returns all nodes that represent program classes.

Specified by:

getAllProgramClasses in interface ShrinkerGraph<java.lang.String>

See Also:

ShrinkerGraph.isProgramClass(Object)

getClassName

@NonNull
public java.lang.String getClassName(@NonNull
                                              java.lang.String klass)

Description copied from interface: ShrinkerGraph

Returns the internal class name for the given class node.

Specified by:

getClassName in interface ShrinkerGraph<java.lang.String>

getModifiers

public int getModifiers(@NonNull
                        java.lang.String node)

Description copied from interface: ShrinkerGraph

Returns the modifiers for the given node, as used by ClassVisitor.

Specified by:

getModifiers in interface ShrinkerGraph<java.lang.String>

addAnnotation

public void addAnnotation(@NonNull
                          java.lang.String node,
                          @NonNull
                          java.lang.String annotationName)

Description copied from interface: ShrinkerGraph

Adds an annotation to the given node.

Specified by:

addAnnotation in interface ShrinkerGraph<java.lang.String>

Parameters:

node - node to store the data for

annotationName - internal name of the annotation

getAnnotations

@NonNull
public java.lang.Iterable<java.lang.String> getAnnotations(@NonNull
                                                                    java.lang.String node)

Description copied from interface: ShrinkerGraph

Returns all annotations present on the given node.

Specified by:

getAnnotations in interface ShrinkerGraph<java.lang.String>

addRoots

public void addRoots(@NonNull
                     java.util.Map<java.lang.String,DependencyType> symbolsToKeep,
                     @NonNull
                     AbstractShrinker.CounterSet counterSet)

Description copied from interface: ShrinkerGraph

Adds the given roots to the graph, for the given AbstractShrinker.CounterSet.

Roots are the sources from which graph walking starts. When we walk the graph looking for reachable nodes, keys in the map will get their counters incremented, using the DependencyType from the matching map value. They can be considered as nodes with incoming edges that don't have a start node.

Specified by:

addRoots in interface ShrinkerGraph<java.lang.String>

getRoots

@NonNull
public java.util.Map<java.lang.String,DependencyType> getRoots(@NonNull
                                                                        AbstractShrinker.CounterSet counterSet)

Description copied from interface: ShrinkerGraph

Returns the roots.

Specified by:

getRoots in interface ShrinkerGraph<java.lang.String>

See Also:

#addRoots(Map, CounterSet)

clearCounters

public void clearCounters(@NonNull
                          com.android.ide.common.internal.WaitableExecutor executor)

Description copied from interface: ShrinkerGraph

Clears all the counters, for all nodes.

Specified by:

clearCounters in interface ShrinkerGraph<java.lang.String>

getMemberName

public java.lang.String getMemberName(@NonNull
                                      java.lang.String member)

Description copied from interface: ShrinkerGraph

Returns the name of a given method or field.

Specified by:

getMemberName in interface ShrinkerGraph<java.lang.String>

getFullMemberName

public java.lang.String getFullMemberName(@NonNull
                                          java.lang.String member)

Description copied from interface: ShrinkerGraph

Returns the full name of a given method or field, e.g. com/example/Class.method:()V

Specified by:

getFullMemberName in interface ShrinkerGraph<java.lang.String>

getMemberDescriptor

public java.lang.String getMemberDescriptor(@NonNull
                                            java.lang.String member)

Description copied from interface: ShrinkerGraph

Returns the name of a given method or field.

Specified by:

getMemberDescriptor in interface ShrinkerGraph<java.lang.String>

isClassKnown

public boolean isClassKnown(@NonNull
                            java.lang.String klass)

Description copied from interface: ShrinkerGraph

Checks if the given given (representing a class) was added to the graph.

When project dependencies are setup incorrectly, unknown classes may be referenced from program classes. In this case nodes for the unknown classes are created "by name" when analyzing program classes, but at a later stage we need to make sure the references are actually valid (otherwise we emit a warning).

Specified by:

isClassKnown in interface ShrinkerGraph<java.lang.String>