Propagate profile_guided requirement of imports to top-level apex

For prebuilts, the dexpreopt rules of system server jars are now
generated from the context of the top-level prebuilt apex and not in the
context of the shim java_import modules. Since
`dex_preopt.profile_guided` property is defined in java_import, this
needs to be bubbled up to the top-level apex. This will be done using
deapxerInfo. If profile_guided of a transitive java_import is true, the deapexed .prof file will be
set as dexreopter.inputProfilePathOnHost before invoking
dexpreopter.dexpreopt. This ensures that only that java_import undergoes
profile guided dexpreopt, and not every other transitive java_import

Test: go test ./apex -run TestPrebuiltStandaloneSystemserverclasspathFragmentContents
Test: lunch cf_x86_64_only_phone-next-userdebug && m
$ANDROID_PRODUCT_OUT/system/framework/oat/x86_64/apex@com.android.art@javalib@service-art.jar@classes.odex
Test: du -sh
$ANDROID_PRODUCT_OUT/system/framework/oat/x86_64/apex@com.android.art@javalib@service-art.jar@classes.odex
24K

Bug: 308790457
Change-Id: Ibf46ecb400b3f126b243fc8d27b08d9a1aa4cc97
This commit is contained in:
Spandan Das 2024-01-25 22:12:50 +00:00
parent e21a8d4dc6
commit 2ea84dd0dc
9 changed files with 69 additions and 10 deletions

View file

@ -83,6 +83,10 @@ type DeapexerInfo struct {
// name of the java libraries exported from the apex
// e.g. core-libart
exportedModuleNames []string
// name of the java libraries exported from the apex that should be dexpreopt'd with the .prof
// file embedded in the apex
dexpreoptProfileGuidedExportedModuleNames []string
}
// ApexModuleName returns the name of the APEX module that provided the info.
@ -121,6 +125,14 @@ func NewDeapexerInfo(apexModuleName string, exports map[string]WritablePath, mod
}
}
func (i *DeapexerInfo) GetDexpreoptProfileGuidedExportedModuleNames() []string {
return i.dexpreoptProfileGuidedExportedModuleNames
}
func (i *DeapexerInfo) AddDexpreoptProfileGuidedExportedModuleNames(names ...string) {
i.dexpreoptProfileGuidedExportedModuleNames = append(i.dexpreoptProfileGuidedExportedModuleNames, names...)
}
type deapexerTagStruct struct {
blueprint.BaseDependencyTag
}
@ -143,6 +155,9 @@ type RequiredFilesFromPrebuiltApex interface {
// the path to the extracted file will be stored in the DeapexerInfo using the APEX relative file
// path as the key, The path can then be retrieved using the PrebuiltExportPath(key) method.
RequiredFilesFromPrebuiltApex(ctx BaseModuleContext) []string
// Returns true if a transitive dependency of an apex should use a .prof file to guide dexpreopt
UseProfileGuidedDexpreopt() bool
}
// Marker interface that identifies dependencies on modules that may require files from a prebuilt

View file

@ -53,6 +53,10 @@ type DeapexerProperties struct {
// all architectures, e.g. java.
CommonModules []string
// List of modules that use an embedded .prof to guide optimization of the equivalent dexpreopt artifact
// This is a subset of CommonModules
DexpreoptProfileGuidedModules []string
// List of files exported from the .apex file by this module
//
// Each entry is a path from the apex root, e.g. javalib/core-libart.jar.
@ -128,6 +132,7 @@ func (p *Deapexer) GenerateAndroidBuildActions(ctx android.ModuleContext) {
if len(exports) > 0 {
// Make the information available for other modules.
di := android.NewDeapexerInfo(apexModuleName(ctx.ModuleName()), exports, p.properties.CommonModules)
di.AddDexpreoptProfileGuidedExportedModuleNames(p.properties.DexpreoptProfileGuidedModules...)
android.SetProvider(ctx, android.DeapexerProvider, di)
// Create a sorted list of the files that this exports.

View file

@ -629,6 +629,7 @@ func (p *prebuiltCommon) createDeapexerModuleIfNeeded(ctx android.TopDownMutator
// Compute the deapexer properties from the transitive dependencies of this module.
commonModules := []string{}
dexpreoptProfileGuidedModules := []string{}
exportedFiles := []string{}
ctx.WalkDeps(func(child, parent android.Module) bool {
tag := ctx.OtherModuleDependencyTag(child)
@ -642,9 +643,14 @@ func (p *prebuiltCommon) createDeapexerModuleIfNeeded(ctx android.TopDownMutator
if _, ok := tag.(android.RequiresFilesFromPrebuiltApexTag); ok {
commonModules = append(commonModules, name)
requiredFiles := child.(android.RequiredFilesFromPrebuiltApex).RequiredFilesFromPrebuiltApex(ctx)
extract := child.(android.RequiredFilesFromPrebuiltApex)
requiredFiles := extract.RequiredFilesFromPrebuiltApex(ctx)
exportedFiles = append(exportedFiles, requiredFiles...)
if extract.UseProfileGuidedDexpreopt() {
dexpreoptProfileGuidedModules = append(dexpreoptProfileGuidedModules, name)
}
// Visit the dependencies of this module just in case they also require files from the
// prebuilt apex.
return true
@ -657,7 +663,8 @@ func (p *prebuiltCommon) createDeapexerModuleIfNeeded(ctx android.TopDownMutator
deapexerProperties := &DeapexerProperties{
// Remove any duplicates from the common modules lists as a module may be included via a direct
// dependency as well as transitive ones.
CommonModules: android.SortedUniqueStrings(commonModules),
CommonModules: android.SortedUniqueStrings(commonModules),
DexpreoptProfileGuidedModules: android.SortedUniqueStrings(dexpreoptProfileGuidedModules),
}
// Populate the exported files property in a fixed order.

View file

@ -221,8 +221,6 @@ func TestSystemServerClasspathFragmentWithContentNotInMake(t *testing.T) {
}
func TestPrebuiltSystemserverclasspathFragmentContents(t *testing.T) {
// TODO(spandandas): Fix the rules for profile guided dexpreopt of deapexed prebuilt jars
t.Skip()
result := android.GroupFixturePreparers(
prepareForTestWithSystemserverclasspathFragment,
prepareForTestWithMyapex,
@ -294,8 +292,8 @@ func TestPrebuiltSystemserverclasspathFragmentContents(t *testing.T) {
"javalib/bar.jar.prof",
})
assertProfileGuided(t, ctx, "foo", "android_common_myapex", false)
assertProfileGuided(t, ctx, "bar", "android_common_myapex", true)
assertProfileGuidedPrebuilt(t, ctx, "myapex", "foo", false)
assertProfileGuidedPrebuilt(t, ctx, "myapex", "bar", true)
}
func TestSystemserverclasspathFragmentStandaloneContents(t *testing.T) {
@ -381,8 +379,6 @@ func TestSystemserverclasspathFragmentStandaloneContents(t *testing.T) {
}
func TestPrebuiltStandaloneSystemserverclasspathFragmentContents(t *testing.T) {
// TODO(spandandas): Fix the rules for profile guided dexpreopt of deapexed prebuilt jars
t.Skip()
result := android.GroupFixturePreparers(
prepareForTestWithSystemserverclasspathFragment,
prepareForTestWithMyapex,
@ -447,8 +443,8 @@ func TestPrebuiltStandaloneSystemserverclasspathFragmentContents(t *testing.T) {
"javalib/bar.jar.prof",
})
assertProfileGuided(t, ctx, "foo", "android_common_myapex", false)
assertProfileGuided(t, ctx, "bar", "android_common_myapex", true)
assertProfileGuidedPrebuilt(t, ctx, "myapex", "foo", false)
assertProfileGuidedPrebuilt(t, ctx, "myapex", "bar", true)
}
func assertProfileGuided(t *testing.T, ctx *android.TestContext, moduleName string, variant string, expected bool) {
@ -458,3 +454,11 @@ func assertProfileGuided(t *testing.T, ctx *android.TestContext, moduleName stri
t.Fatalf("Expected profile-guided to be %v, got %v", expected, actual)
}
}
func assertProfileGuidedPrebuilt(t *testing.T, ctx *android.TestContext, apexName string, moduleName string, expected bool) {
dexpreopt := ctx.ModuleForTests(apexName, "android_common_"+apexName).Rule("dexpreopt." + moduleName)
actual := strings.Contains(dexpreopt.RuleParams.Command, "--profile-file=")
if expected != actual {
t.Fatalf("Expected profile-guided to be %v, got %v", expected, actual)
}
}

View file

@ -1105,6 +1105,10 @@ func (module *PrebuiltBootclasspathFragmentModule) RequiredFilesFromPrebuiltApex
return nil
}
func (module *PrebuiltBootclasspathFragmentModule) UseProfileGuidedDexpreopt() bool {
return false
}
var _ android.RequiredFilesFromPrebuiltApex = (*PrebuiltBootclasspathFragmentModule)(nil)
func prebuiltBootclasspathFragmentFactory() android.Module {

View file

@ -282,6 +282,17 @@ func (d *Dexpreopter) DexpreoptPrebuiltApexSystemServerJars(ctx android.ModuleCo
d.installPath = android.PathForModuleInPartitionInstall(ctx, "", strings.TrimPrefix(dexpreopt.GetSystemServerDexLocation(ctx, dc, libraryName), "/"))
// generate the rules for creating the .odex and .vdex files for this system server jar
dexJarFile := di.PrebuiltExportPath(ApexRootRelativePathToJavaLib(libraryName))
d.inputProfilePathOnHost = nil // reset: TODO(spandandas): Make dexpreopter stateless
if android.InList(libraryName, di.GetDexpreoptProfileGuidedExportedModuleNames()) {
// Set the profile path to guide optimization
prof := di.PrebuiltExportPath(ApexRootRelativePathToJavaLib(libraryName) + ".prof")
if prof == nil {
ctx.ModuleErrorf("Could not find a .prof file in this prebuilt apex")
}
d.inputProfilePathOnHost = prof
}
d.dexpreopt(ctx, libraryName, dexJarFile)
}
@ -354,6 +365,7 @@ func (d *dexpreopter) dexpreopt(ctx android.ModuleContext, libName string, dexJa
var profileClassListing android.OptionalPath
var profileBootListing android.OptionalPath
profileIsTextListing := false
if d.inputProfilePathOnHost != nil {
profileClassListing = android.OptionalPathForPath(d.inputProfilePathOnHost)
} else if BoolDefault(d.dexpreoptProperties.Dex_preopt.Profile_guided, true) && !forPrebuiltApex(ctx) {

View file

@ -2453,6 +2453,10 @@ func (j *Import) RequiredFilesFromPrebuiltApex(_ android.BaseModuleContext) []st
return requiredFilesFromPrebuiltApexForImport(name, &j.dexpreopter)
}
func (j *Import) UseProfileGuidedDexpreopt() bool {
return proptools.Bool(j.importDexpreoptProperties.Dex_preopt.Profile_guided)
}
// Add compile time check for interface implementation
var _ android.IDEInfo = (*Import)(nil)
var _ android.IDECustomizedModuleName = (*Import)(nil)

View file

@ -3019,6 +3019,10 @@ func (module *SdkLibraryImport) RequiredFilesFromPrebuiltApex(ctx android.BaseMo
return requiredFilesFromPrebuiltApexForImport(name, &module.dexpreopter)
}
func (j *SdkLibraryImport) UseProfileGuidedDexpreopt() bool {
return proptools.Bool(j.importDexpreoptProperties.Dex_preopt.Profile_guided)
}
// java_sdk_library_xml
type sdkLibraryXml struct {
android.ModuleBase

View file

@ -313,6 +313,10 @@ func (module *prebuiltSystemServerClasspathModule) RequiredFilesFromPrebuiltApex
return nil
}
func (module *prebuiltSystemServerClasspathModule) UseProfileGuidedDexpreopt() bool {
return false
}
var _ android.RequiredFilesFromPrebuiltApex = (*prebuiltSystemServerClasspathModule)(nil)
func prebuiltSystemServerClasspathModuleFactory() android.Module {