com.facebook.buck.android

Class SmartDexingStep

java.lang.Object

com.facebook.buck.android.SmartDexingStep

All Implemented Interfaces:

Step

public class SmartDexingStep
extends Object
implements Step

Optimized dx command runner which can invoke multiple dx commands in parallel and also avoid doing unnecessary dx invocations in the first place.

This is most appropriately represented as a build rule itself (which depends on individual dex rules) however this would require significant refactoring of AndroidBinaryRule that would be disruptive to other initiatives in flight (namely, ApkBuilder). It is also debatable that it is even the right course of action given that it would require dynamically modifying the DAG.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SmartDexingStep.DexInputHashesProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	SHORT_NAME

Constructor Summary

Constructors

Constructor and Description

SmartDexingStep(AndroidPlatformTarget androidPlatformTarget, BuildContext buildContext, ProjectFilesystem filesystem, Optional<Path> primaryOutputPath, Optional<java.util.function.Supplier<Set<Path>>> primaryInputsToDex, Optional<java.util.function.Supplier<List<String>>> primaryDexWeightsSupplier, Optional<Path> secondaryOutputDir, Optional<java.util.function.Supplier<com.google.common.collect.Multimap<Path,Path>>> secondaryInputsToDex, SmartDexingStep.DexInputHashesProvider dexInputHashesProvider, Path successDir, EnumSet<DxStep.Option> dxOptions, com.google.common.util.concurrent.ListeningExecutorService executorService, int xzCompressionLevel, Optional<String> dxMaxHeapSize, String dexTool, boolean desugarInterfaceMethods, boolean useDexBuckedId, Optional<Set<Path>> additonalDesugarDeps, BuildTarget buildTarget, Optional<Integer> minSdkVersion)

Method Summary

Modifier and Type	Method and Description
static int	determineOptimalThreadCount()
StepExecutionResult	execute(ExecutionContext context)
String	getDescription(ExecutionContext context)
String	getShortName()

Methods inherited from class java.lang.Object

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

Field Detail

SHORT_NAME

public static final String SHORT_NAME

See Also:

Constant Field Values

Constructor Detail

SmartDexingStep

public SmartDexingStep(AndroidPlatformTarget androidPlatformTarget,
                       BuildContext buildContext,
                       ProjectFilesystem filesystem,
                       Optional<Path> primaryOutputPath,
                       Optional<java.util.function.Supplier<Set<Path>>> primaryInputsToDex,
                       Optional<java.util.function.Supplier<List<String>>> primaryDexWeightsSupplier,
                       Optional<Path> secondaryOutputDir,
                       Optional<java.util.function.Supplier<com.google.common.collect.Multimap<Path,Path>>> secondaryInputsToDex,
                       SmartDexingStep.DexInputHashesProvider dexInputHashesProvider,
                       Path successDir,
                       EnumSet<DxStep.Option> dxOptions,
                       com.google.common.util.concurrent.ListeningExecutorService executorService,
                       int xzCompressionLevel,
                       Optional<String> dxMaxHeapSize,
                       String dexTool,
                       boolean desugarInterfaceMethods,
                       boolean useDexBuckedId,
                       Optional<Set<Path>> additonalDesugarDeps,
                       BuildTarget buildTarget,
                       Optional<Integer> minSdkVersion)

Parameters:

primaryOutputPath - Path for the primary dex artifact.

primaryInputsToDex - Set of paths to include as inputs for the primary dex artifact.

secondaryOutputDir - Directory path for the secondary dex artifacts, if there are any. Note that this directory will be pruned such that only those secondary outputs generated by this command will remain in the directory!

secondaryInputsToDex - List of paths to input jar files, to use as dx input, keyed by the corresponding output dex file. Note that for each output file (key), a separate dx invocation will be started with the corresponding jar files (value) as the input.

successDir - Directory where success artifacts are written.

executorService - The thread pool to execute the dx command on.

minSdkVersion -

Method Detail

determineOptimalThreadCount

public static int determineOptimalThreadCount()

Returns:

Optimal (in terms of both memory and performance) number of parallel threads to run dexer. The implementation uses running machine hardware characteristics to determine this.

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException,
                                   InterruptedException

Specified by:

execute in interface Step

Throws:

IOException

InterruptedException

getShortName

public String getShortName()

Specified by:

getShortName in interface Step

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

getDescription

public String getDescription(ExecutionContext context)

Specified by:

getDescription in interface Step