Setup Baseline Profile (#8135)
* Setup Baseline Profile Adds Baseline Profile generator and startup time test. Readme included in macrobenchmark module to run the generator. * changespull/8150/head
parent
bbe1608006
commit
3b62396442
File diff suppressed because it is too large
Load Diff
@ -0,0 +1 @@
|
|||||||
|
/build
|
@ -0,0 +1,11 @@
|
|||||||
|
# Baseline profiles
|
||||||
|
|
||||||
|
The baseline profile for this app is located at [`app/src/main/baseline-prof.txt`](../app/src/main/baseline-prof.txt).
|
||||||
|
It contains rules that enable AOT compilation of the critical user path taken during app launch.
|
||||||
|
For more information on baseline profiles, read [this document](https://developer.android.com/studio/profile/baselineprofiles).
|
||||||
|
|
||||||
|
> Note: The baseline profile needs to be re-generated for release builds that touch code which changes app startup.
|
||||||
|
|
||||||
|
To generate the baseline profile, select the `devBenchmark` build variant and run the
|
||||||
|
`BaselineProfileGenerator` benchmark test on an AOSP Android Emulator.
|
||||||
|
Then copy the resulting baseline profile from the emulator to [`app/src/main/baseline-prof.txt`](../app/src/main/baseline-prof.txt).
|
@ -0,0 +1,52 @@
|
|||||||
|
plugins {
|
||||||
|
id("com.android.test")
|
||||||
|
kotlin("android")
|
||||||
|
}
|
||||||
|
|
||||||
|
android {
|
||||||
|
namespace = "tachiyomi.macrobenchmark"
|
||||||
|
compileSdk = AndroidConfig.compileSdk
|
||||||
|
|
||||||
|
compileOptions {
|
||||||
|
sourceCompatibility = JavaVersion.VERSION_1_8
|
||||||
|
targetCompatibility = JavaVersion.VERSION_1_8
|
||||||
|
}
|
||||||
|
|
||||||
|
kotlinOptions {
|
||||||
|
jvmTarget = JavaVersion.VERSION_1_8.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
defaultConfig {
|
||||||
|
minSdk = AndroidConfig.minSdk
|
||||||
|
targetSdk = AndroidConfig.targetSdk
|
||||||
|
|
||||||
|
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
|
||||||
|
}
|
||||||
|
|
||||||
|
buildTypes {
|
||||||
|
// This benchmark buildType is used for benchmarking, and should function like your
|
||||||
|
// release build (for example, with minification on). It's signed with a debug key
|
||||||
|
// for easy local/CI testing.
|
||||||
|
create("benchmark") {
|
||||||
|
isDebuggable = true
|
||||||
|
signingConfig = getByName("debug").signingConfig
|
||||||
|
matchingFallbacks += listOf("release")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
targetProjectPath = ":app"
|
||||||
|
experimentalProperties["android.experimental.self-instrumenting"] = true
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation(androidx.test.ext)
|
||||||
|
implementation(androidx.test.espresso.core)
|
||||||
|
implementation(androidx.test.uiautomator)
|
||||||
|
implementation(androidx.benchmark.macro)
|
||||||
|
}
|
||||||
|
|
||||||
|
androidComponents {
|
||||||
|
beforeVariants(selector().all()) {
|
||||||
|
it.enable = it.buildType == "benchmark"
|
||||||
|
}
|
||||||
|
}
|
@ -0,0 +1,2 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<manifest xmlns:android="http://schemas.android.com/apk/res/android" />
|
@ -0,0 +1,24 @@
|
|||||||
|
package tachiyomi.macrobenchmark
|
||||||
|
|
||||||
|
import androidx.benchmark.macro.ExperimentalBaselineProfilesApi
|
||||||
|
import androidx.benchmark.macro.junit4.BaselineProfileRule
|
||||||
|
import org.junit.Rule
|
||||||
|
import org.junit.Test
|
||||||
|
|
||||||
|
@OptIn(ExperimentalBaselineProfilesApi::class)
|
||||||
|
class BaselineProfileGenerator {
|
||||||
|
@get:Rule
|
||||||
|
val baselineProfileRule = BaselineProfileRule()
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun generate() = baselineProfileRule.collectBaselineProfile(
|
||||||
|
packageName = "eu.kanade.tachiyomi.benchmark",
|
||||||
|
profileBlock = {
|
||||||
|
pressHome()
|
||||||
|
startActivityAndWait()
|
||||||
|
|
||||||
|
// TODO: Navigate to browse-extensions screen when storage permission
|
||||||
|
// in sources screen moved. Possibly open manga details screen too?
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
@ -0,0 +1,84 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2022 The Android Open Source Project
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package tachiyomi.macrobenchmark
|
||||||
|
|
||||||
|
import androidx.benchmark.macro.BaselineProfileMode
|
||||||
|
import androidx.benchmark.macro.CompilationMode
|
||||||
|
import androidx.benchmark.macro.StartupMode
|
||||||
|
import androidx.benchmark.macro.StartupTimingMetric
|
||||||
|
import androidx.benchmark.macro.junit4.MacrobenchmarkRule
|
||||||
|
import androidx.test.internal.runner.junit4.AndroidJUnit4ClassRunner
|
||||||
|
import org.junit.Rule
|
||||||
|
import org.junit.Test
|
||||||
|
import org.junit.runner.RunWith
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run this benchmark from Studio to see startup measurements, and captured system traces
|
||||||
|
* for investigating your app's performance from a cold state.
|
||||||
|
*/
|
||||||
|
@RunWith(AndroidJUnit4ClassRunner::class)
|
||||||
|
class ColdStartupBenchmark : AbstractStartupBenchmark(StartupMode.COLD)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run this benchmark from Studio to see startup measurements, and captured system traces
|
||||||
|
* for investigating your app's performance from a warm state.
|
||||||
|
*/
|
||||||
|
@RunWith(AndroidJUnit4ClassRunner::class)
|
||||||
|
class WarmStartupBenchmark : AbstractStartupBenchmark(StartupMode.WARM)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run this benchmark from Studio to see startup measurements, and captured system traces
|
||||||
|
* for investigating your app's performance from a hot state.
|
||||||
|
*/
|
||||||
|
@RunWith(AndroidJUnit4ClassRunner::class)
|
||||||
|
class HotStartupBenchmark : AbstractStartupBenchmark(StartupMode.HOT)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Base class for benchmarks with different startup modes.
|
||||||
|
* Enables app startups from various states of baseline profile or [CompilationMode]s.
|
||||||
|
*/
|
||||||
|
abstract class AbstractStartupBenchmark(private val startupMode: StartupMode) {
|
||||||
|
@get:Rule
|
||||||
|
val benchmarkRule = MacrobenchmarkRule()
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun startupNoCompilation() = startup(CompilationMode.None())
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun startupBaselineProfileDisabled() = startup(
|
||||||
|
CompilationMode.Partial(baselineProfileMode = BaselineProfileMode.Disable, warmupIterations = 1)
|
||||||
|
)
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun startupBaselineProfile() = startup(CompilationMode.Partial(baselineProfileMode = BaselineProfileMode.Require))
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun startupFullCompilation() = startup(CompilationMode.Full())
|
||||||
|
|
||||||
|
private fun startup(compilationMode: CompilationMode) = benchmarkRule.measureRepeated(
|
||||||
|
packageName = "eu.kanade.tachiyomi.benchmark",
|
||||||
|
metrics = listOf(StartupTimingMetric()),
|
||||||
|
compilationMode = compilationMode,
|
||||||
|
iterations = 10,
|
||||||
|
startupMode = startupMode,
|
||||||
|
setupBlock = {
|
||||||
|
pressHome()
|
||||||
|
}
|
||||||
|
) {
|
||||||
|
startActivityAndWait()
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in new issue