Benchmarking in AndroidX

The public documentation at d.android.com/benchmark explains how to use the library - this page focuses on specifics to writing libraries in the AndroidX repo, and our continuous testing / triage process.

This page is for MICRO benchmarks measuring CPU performance of small sections of code. If you're looking for measuring startup or jank, see the guide for MACRObenchmarks here.

Writing the benchmark

Benchmarks are just regular instrumentation tests! Just use the BenchmarkRule provided by the library:

Kotlin {.new-tab}

@RunWith(AndroidJUnit4::class)
class ViewBenchmark {
    @get:Rule
    val benchmarkRule = BenchmarkRule()

    @Test
    fun simpleViewInflate() {
        val context = InstrumentationRegistry
                .getInstrumentation().targetContext
        val inflater = LayoutInflater.from(context)
        val root = FrameLayout(context)

        benchmarkRule.measure {
            inflater.inflate(R.layout.test_simple_view, root, false)
        }
    }
}

Java {.new-tab}

@RunWith(AndroidJUnit4.class)
public class ViewBenchmark {
    @Rule
    public BenchmarkRule mBenchmarkRule = new BenchmarkRule();

    @Test
    public void simpleViewInflate() {
        Context context = InstrumentationRegistry
                .getInstrumentation().getTargetContext();
        final BenchmarkState state = mBenchmarkRule.getState();
        LayoutInflater inflater = LayoutInflater.from(context);
        FrameLayout root = new FrameLayout(context);

        while (state.keepRunning()) {
            inflater.inflate(R.layout.test_simple_view, root, false);
        }
    }
}

Project structure

As in the public documentation, benchmarks in the AndroidX repo are test-only library modules. Differences for AndroidX repo:

1. Module must live in integration-tests group directory
2. Module name must end with -benchmark in settings.gradle.

I'm lazy and want to start quickly

Start by copying one of the following non-Compose projects:

• navigation-benchmark
• recyclerview-benchmark

Many Compose libraries already have benchmark modules:

• Compose UI Benchmarks
• Compose Runtime Benchmarks
• Compose Material Benchmarks
• Wear Compose Material Benchmarks

Profiling

See the public profiling guide for more details.

Jetpack benchmark supports capturing profiling information by setting instrumentation arguments. Stack sampling and method tracing can be performed either from CLI or Studio invocation.

Set Arguments in Gradle

Args can be set in your benchmark's build.gradle, which will affect both Studio / command-line gradlew runs. Runs from Studio will link result traces that can be opened directly from the IDE.

android {
    defaultConfig {
        // must be one of: 'None', 'StackSampling', or 'MethodTracing'
        testInstrumentationRunnerArgument 'androidx.benchmark.profiling.mode', 'StackSampling'
    }
}

Set Arguments on Command Line

Args can also be passed from CLI. Here's an example which runs the androidx.compose.material.benchmark.CheckboxesInRowsBenchmark#draw method with StackSampling profiling:

./gradlew compose:material:material-benchmark:cC \
    -P android.testInstrumentationRunnerArguments.androidx.benchmark.profiling.mode=StackSampling \
    -P android.testInstrumentationRunnerArguments.class=androidx.compose.material.benchmark.CheckboxesInRowsBenchmark#draw

The command output will tell you where to look for the file on your host machine:

04:33:49 I/Benchmark: Benchmark report files generated at
/androidx-main/out/ui/ui/integration-tests/benchmark/build/outputs/connected_android_test_additional_output

To inspect the captured trace, open the appropriate *.trace file in that directory with Android Studio, using File > Open.

NOTE For stack sampling, it's recommended to profile on Android Q(API 29) or higher, as this enables the benchmark library to use Simpleperf. Simpleperf previously required a more complex setup process - this has been fixed!

For more information on the StackSampling and MethodTracing profiling modes, see the Studio Profiler configuration docs, specifically “Sample C/C++ Functions” (a confusing name for Simpleperf), and Java Method Tracing.

Advanced: Connected Studio Profiler

Profiling for allocations requires Studio to capture. This can also be used for Sampled profiling, though it is instead recommended to use instrumentation argument profiling for that, as it‘s simpler, and doesn’t require debuggable=true

Studio profiling tools currently require debuggable=true. First, temporarily override it in your benchmark's androidTest/AndroidManifest.xml.

Next choose which profiling you want to do: Allocation, or Sampled (SimplePerf)

ConnectedAllocation will help you measure the allocations in a single run of a benchmark loop, after warmup.

ConnectedSampled will help you capture sampled profiling, but with the more detailed / accurate Simpleperf sampling.

Set the profiling type in your benchmark module's build.gradle:

android {
    defaultConfig {
        // Local only, don't commit this!
        testInstrumentationRunnerArgument 'androidx.benchmark.profiling.mode', 'ConnectedAllocation'
    }
}

Run File > Sync Project with Gradle Files, or sync if Studio asks you. Now any benchmark runs in that project will permit debuggable, and pause before and after the test, to allow you to connect a profiler and start recording, and then stop recording.

Running and Profiling

After the benchmark test starts, you have about 20 seconds to connect the profiler:

1. Click the profiler tab at the bottom
2. Click the plus button in the top left, <device name>, <process name>
3. Next step depends on which you intend to capture

Allocations

Click the memory section, and right click the window, and select Record allocations. Approximately 20 seconds later, right click again and select Stop recording.