Package com.pnfsoftware.jeb.core.units.code.android.ir

Class AbstractDCollectionOptimizer

java.lang.Object
com.pnfsoftware.jeb.core.AbstractPlugin
com.pnfsoftware.jeb.core.units.code.android.ir.AbstractDCollectionOptimizer
All Implemented Interfaces:
IPlugin, IDOptimizer
public abstract class AbstractDCollectionOptimizer extends AbstractPlugin implements IDOptimizer
Base class for dexdec (DEX decompiler) IR optimizer plugins working on a collection of IR contexts. Those plugins can access and modify the intermediate representation of a group of methods being decompiled. They can be used to implement a wide range of optimizations, from trivial code clean-up to the most complex deobfuscation passes. Internally, dexdec uses IR optimizers to perform dead-code removal, variable substitutions, immediate propagation, restructuring, constant folding, arithmetic operation simplifications, deobfuscations such as control-flow unflattening, etc.

Optimizers are usually managed by master optimizers (also called orchestrators). Third-party optimizer plugins can be automatically registered when creating an orchestrator. Refer to createMasterOptimizer.

Life-cycle information:
- plugins are reused (i.e. the performOnCollection() method is called multiple times)
- thread-safety:
-- Python script plugins must be thread-safe: a plugin instance may be executed by multiple threads concurrently
-- Java plugins (including Java script plugins) are not required to be thread-safe: a plugin instance will not be executed by multiple threads concurrently

Note: Starting from JEB 5.28, collection optimizers are not enabled by default. You must set the option .parsers.dcmp_dex.EnableCollectionOptimizers to true to instruct the decompiler to execute them.

See Also:

  • Field Details

    • logger

      public static final ILogger logger
      Public logger accessible by the implementing optimizer. Writing to the logger should be favored over writing directly to stdout.

    • tf

      public IJavaTypeFactory tf
      IR/AST type factory reference (for convenience).

    • of

      public IJavaOperatorFactory of
      IR/AST operation factory reference (for convenience).

    • g

      public IDGlobalContext g
      IR global context.

    • dex

      public IDexUnit dex
      Underlying dex code.

    • decomp

      public IDexDecompilerUnit decomp
      Managing dex decompiler.

    • ctxlist

      public List<IDMethodContext> ctxlist
      The list of IR method contexts available to the optimizer. A collection is not a class. Those IR contexts may represent methods from multiple classes.

  • Constructor Details

    • AbstractDCollectionOptimizer

      public AbstractDCollectionOptimizer()
      Create a standard optimizer.

    • AbstractDCollectionOptimizer

      public AbstractDCollectionOptimizer(DOptimizerType type)
      Create an optimizer.
      Parameters:
      type - optimizer type, or null to use DOptimizerType.NORMAL

    • AbstractDCollectionOptimizer

      public AbstractDCollectionOptimizer(DOptimizerType type, String name)
      Create an optimizer.
      Parameters:
      type - optimizer type, or null to use DOptimizerType.NORMAL
      name - optional optimizer name

  • Method Details

    • checkInterrupted

      protected void checkInterrupted()
      Verify if an interruption request was made by the managing decompiler. This method may be called when potentially length computations are performed in a loop.

    • getPluginInformation

      public final EditablePluginInformation getPluginInformation()
      Description copied from interface: IPlugin
      Retrieve basic information about the plugin, such as name, version, author, and organization.
      Specified by:
      getPluginInformation in interface IPlugin
      Returns:
      the plugin information

    • setName

      protected void setName(String name)
      Set the optimizer name. To be used by the constructor.
      Parameters:
      name - if null, a name will be auto-generated

    • getName

      public final String getName()
      Description copied from interface: IDOptimizer
      Retrieve the plugin name. Should be consistent with the value returned by getPluginInformation().getName().
      Specified by:
      getName in interface IDOptimizer
      Returns:
      optimizer name

    • isCollectionOptimizer

      public final boolean isCollectionOptimizer()
      Description copied from interface: IDOptimizer
      Determine whether this optimizer performs on a single method or an a collection of methods.
      Specified by:
      isCollectionOptimizer in interface IDOptimizer
      Returns:
      true for collection optimizers, false for single-method optimizers

    • setType

      protected void setType(DOptimizerType type)
      Set the optimizer type. To be used by the constructor.
      Parameters:
      type - if null, a standard optimizer is assumed

    • getType

      public final DOptimizerType getType()
      Description copied from interface: IDOptimizer
      Get the optimizer type. Types are used by optimizer orchestrators to determine whether an optimizer should run.
      Specified by:
      getType in interface IDOptimizer
      Returns:
      optimizer type

    • addTag

      protected void addTag(String tag)
      Add an optimizer tag.
      Parameters:
      tag - tag to add

    • removeTag

      protected void removeTag(String tag)
      Remove an optimizer tag.
      Parameters:
      tag - tag to remove

    • getTags

      public final Set<String> getTags()
      Description copied from interface: IDOptimizer
      Get the optimizer tags. An optimizer may have 0, 1, or more tags. A tag is a non-null, non-empty string.
      Specified by:
      getTags in interface IDOptimizer
      Returns:
      a collection of tags; may be empty (tags are optional), but never null

    • setPriority

      protected void setPriority(double priority)
      Set the optimizer priority. To be used by the constructor.
      Parameters:
      priority - the new priority (high means higher priority). When optimizers are managed and run by an orchestrator, the optimizers with a higher priority are run before those having a lower priority. The default priority is 0.

    • getPriority

      public final double getPriority()
      Description copied from interface: IDOptimizer
      Get the optimizer priority. A higher value means a higher priority. Priorities are used by optimizer orchestrators to determine in which order optimizers should be executed.
      Specified by:
      getPriority in interface IDOptimizer
      Returns:
      the default priority

    • setEnabled

      public void setEnabled(boolean enabled)
      Enable or disable this optimizer. This flag is checked by a master optimizer.
      Parameters:
      enabled - true to enable this optimizer

    • isEnabled

      public final boolean isEnabled()
      Description copied from interface: IDOptimizer
      Determine whether the optimizer is enabled or not. This method is used by optimizer orchestrators to determine whether an optimizer can be scheduled for execution.
      Specified by:
      isEnabled in interface IDOptimizer
      Returns:
      true if this optimizer is enabled

    • performOnCollection

      public final int performOnCollection(List<IDMethodContext> ctxlist, Map<IDMethodContext,Integer> pmcntmap)
      Description copied from interface: IDOptimizer
      Run the optimizer on the provided collection of methods.

      For this method to be called by an orchestrator, IDOptimizer.isCollectionOptimizer() must return true.

      Specified by:
      performOnCollection in interface IDOptimizer
      Parameters:
      ctxlist - a collection of method contexts
      pmcntmap - optional output map that will receive the per-method optimization counts
      Returns:
      number of optimizations performed

    • perform

      public int perform(IDMethodContext ctx)
      Description copied from interface: IDOptimizer
      Run the optimizer on the provided target method.

      For this method to be called by an orchestrator, IDOptimizer.isCollectionOptimizer() must return false.

      Specified by:
      perform in interface IDOptimizer
      Parameters:
      ctx - a method context
      Returns:
      number of optimizations performed

    • recordMethodOptimization

      protected void recordMethodOptimization(IDMethodContext ctx, int cnt)
      Record optimization counts for a method context.
      Parameters:
      ctx - method context
      cnt - number of optimizations performed

    • performOnCollection

      public abstract int performOnCollection()
      An optimizer must implement this method. This method is called by a master optimizer to perform optimizations on the provided target contexts.
      Returns:
      total count of optimizations; it is also recommended to register per-method optimizations with recordMethodOptimization(IDMethodContext, int)

    • assignLocalFields

      public void assignLocalFields(List<IDMethodContext> _ctxlist)
      This convenience method can be used to assign the object's attributes from the values of the provided IR contexts.
      Parameters:
      _ctxlist - an IR context

    • resetLocalFields

      public void resetLocalFields()
      Reset this object's attributes. Same as assignLocalFields(null).

    • generatePerClassContextsMap

      public Map<String,List<IDMethodContext>> generatePerClassContextsMap()
      Generate a per-class map of method contexts.
      Returns:
      a map with key= class signature C, value= list of IR contexts for methods belonging to the class C