tequilaOS/platform_build_soong
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Refactor 'in_make' to mean Kati is not skipped.

Browse source 
In Nougat and before, Make wrote a marker file to indicate that
soong_build was invoked from Make to change certain behaviors of Soong
at build time.
https://cs.android.com/android/platform/superproject/+/android-7.1.2_r36:build/core/soong.mk;l=70-73;drc=ae18638b0406ad107b0882a02a13cdd8b92f2a4e

Things have changed, and now soong_build is invoked from soong_ui, which
supports a --skip-make configuration flag:
https://cs.android.com/android/platform/superproject/+/master:build/soong/ui/build/build.go;l=31-33;drc=680387bf1d3ce7cbc77f535be7c42cec411b1687

Thus, the various remnants of 'EmbeddedInMake' and 'inMake'
configuration are misleading, since soong_build is no longer invoked
from Make. This CL refactors all instances to actually mean that
Kati is enabled (not skipped with --skip-make), and will run after
soong_build finishes, so Kati-specific behavior like the AndroidMk
singleton should run.

Test: TH presubmit

Change-Id: I576ab8e54f99f5c8ddf9feaf9a828019b279e266
This commit is contained in:
Jingwen Chen 2020-11-23 00:22:30 -05:00
parent b26070efef
commit cda22c9bb9
14 changed files with 41 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
android/androidmk.go
View file

@ -417,7 +417,7 @@ func AndroidMkSingleton() Singleton {
type androidMkSingleton struct{}
func (c *androidMkSingleton) GenerateBuildActions(ctx SingletonContext) {
if !ctx.Config().EmbeddedInMake() {
if !ctx.Config().KatiEnabled() {
return
}

4
android/androidmk_test.go
View file

@ -78,7 +78,7 @@ func TestAndroidMkSingleton_PassesUpdatedAndroidMkDataToCustomCallback(t *testin
`
config := TestConfig(buildDir, nil, bp, nil)
config.inMake = true // Enable androidmk Singleton
config.katiEnabled = true // Enable androidmk Singleton
ctx := NewTestContext(config)
ctx.RegisterSingletonType("androidmk", AndroidMkSingleton)
@ -250,7 +250,7 @@ func TestGetDistForGoals(t *testing.T) {
for _, testCase := range testCases {
config := TestConfig(buildDir, nil, testCase.bp, nil)
config.inMake = true // Enable androidmk Singleton
config.katiEnabled = true // Enable androidmk Singleton
ctx := NewTestContext(config)
ctx.RegisterSingletonType("androidmk", AndroidMkSingleton)

14
android/config.go
View file

@ -112,7 +112,9 @@ type config struct {
envDeps map[string]string
envFrozen bool
inMake bool
// Changes behavior based on whether Kati runs after soong_build, or if soong_build
// runs standalone.
katiEnabled bool
captureBuild bool // true for tests, saves build parameters for each module
ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
@ -390,9 +392,9 @@ func NewConfig(srcDir, buildDir string, moduleListFile string) (Config, error) {
return Config{}, err
}
inMakeFile := filepath.Join(buildDir, ".soong.in_make")
if _, err := os.Stat(absolutePath(inMakeFile)); err == nil {
config.inMake = true
KatiEnabledMarkerFile := filepath.Join(buildDir, ".soong.kati_enabled")
if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
config.katiEnabled = true
}
targets, err := decodeTargetProductVariables(config)
@ -619,8 +621,8 @@ func (c *config) EnvDeps() map[string]string {
return c.envDeps
}
func (c *config) EmbeddedInMake() bool {
return c.inMake
func (c *config) KatiEnabled() bool {
return c.katiEnabled
}
func (c *config) BuildId() string {

2
android/makevars.go
View file

@ -213,7 +213,7 @@ type dist struct {
}
func (s *makeVarsSingleton) GenerateBuildActions(ctx SingletonContext) {
if !ctx.Config().EmbeddedInMake() {
if !ctx.Config().KatiEnabled() {
return
}

14
android/module.go
View file

@ -1440,7 +1440,7 @@ func (m *ModuleBase) generateModuleTarget(ctx ModuleContext) {
if len(deps) > 0 {
suffix := ""
if ctx.Config().EmbeddedInMake() {
if ctx.Config().KatiEnabled() {
suffix = "-soong"
}
@ -2320,7 +2320,7 @@ func (m *moduleContext) skipInstall(fullInstallPath InstallPath) bool {
}
if m.Device() {
if m.Config().EmbeddedInMake() && !m.InstallBypassMake() {
if m.Config().KatiEnabled() && !m.InstallBypassMake() {
return true
}
@ -2373,7 +2373,7 @@ func (m *moduleContext) installFile(installPath InstallPath, name string, srcPat
Input: srcPath,
Implicits: implicitDeps,
OrderOnly: orderOnlyDeps,
Default: !m.Config().EmbeddedInMake(),
Default: !m.Config().KatiEnabled(),
})
m.installFiles = append(m.installFiles, fullInstallPath)
@ -2405,7 +2405,7 @@ func (m *moduleContext) InstallSymlink(installPath InstallPath, name string, src
Description: "install symlink " + fullInstallPath.Base(),
Output: fullInstallPath,
Input: srcPath,
Default: !m.Config().EmbeddedInMake(),
Default: !m.Config().KatiEnabled(),
Args: map[string]string{
"fromPath": relPath,
},
@ -2436,7 +2436,7 @@ func (m *moduleContext) InstallAbsoluteSymlink(installPath InstallPath, name str
Rule: Symlink,
Description: "install symlink " + fullInstallPath.Base() + " -> " + absPath,
Output: fullInstallPath,
Default: !m.Config().EmbeddedInMake(),
Default: !m.Config().KatiEnabled(),
Args: map[string]string{
"fromPath": absPath,
},
@ -2665,7 +2665,7 @@ func (c *buildTargetSingleton) GenerateBuildActions(ctx SingletonContext) {
})
suffix := ""
if ctx.Config().EmbeddedInMake() {
if ctx.Config().KatiEnabled() {
suffix = "-soong"
}
@ -2673,7 +2673,7 @@ func (c *buildTargetSingleton) GenerateBuildActions(ctx SingletonContext) {
ctx.Phony("checkbuild"+suffix, checkbuildDeps...)
// Make will generate the MODULES-IN-* targets
if ctx.Config().EmbeddedInMake() {
if ctx.Config().KatiEnabled() {
return
}

2
android/paths.go
View file

@ -1312,7 +1312,7 @@ func PathForModuleInstall(ctx ModuleInstallPathContext, pathComponents ...string
ret := pathForInstall(ctx, os, arch, partition, ctx.Debug(), pathComponents...)
if ctx.InstallBypassMake() && ctx.Config().EmbeddedInMake() {
if ctx.InstallBypassMake() && ctx.Config().KatiEnabled() {
ret = ret.ToMakePath()
}

2
android/phony.go
View file

@ -53,7 +53,7 @@ func (p *phonySingleton) GenerateBuildActions(ctx SingletonContext) {
p.phonyMap[phony] = SortedUniquePaths(p.phonyMap[phony])
}
if !ctx.Config().EmbeddedInMake() {
if !ctx.Config().KatiEnabled() {
for _, phony := range p.phonyList {
ctx.Build(pctx, BuildParams{
Rule: blueprint.Phony,

4
android/testing.go
View file

@ -424,8 +424,8 @@ func CheckErrorsAgainstExpectations(t *testing.T, errs []error, expectedErrorPat
}
func SetInMakeForTests(config Config) {
config.inMake = true
func SetKatiEnabledForTests(config Config) {
config.katiEnabled = true
}
func AndroidMkEntriesForTest(t *testing.T, config Config, bpPath string, mod blueprint.Module) []AndroidMkEntries {

2
cc/prebuilt_test.go
View file

@ -32,7 +32,7 @@ func testPrebuilt(t *testing.T, bp string, fs map[string][]byte, handlers ...con
// * Configure that we are inside make
// * Add CommonOS to ensure that androidmk processing works.
android.RegisterAndroidMkBuildComponents(ctx)
android.SetInMakeForTests(config)
android.SetKatiEnabledForTests(config)
for _, handler := range handlers {
handler(config)

4
cc/strip.go
View file

@ -35,8 +35,8 @@ type Stripper struct {
}
func (stripper *Stripper) NeedsStrip(actx android.ModuleContext) bool {
// TODO(ccross): enable host stripping when embedded in make? Make never had support for stripping host binaries.
return (!actx.Config().EmbeddedInMake() || actx.Device()) && !Bool(stripper.StripProperties.Strip.None)
// TODO(ccross): enable host stripping when Kati is enabled? Make never had support for stripping host binaries.
return (!actx.Config().KatiEnabled() || actx.Device()) && !Bool(stripper.StripProperties.Strip.None)
}
func (stripper *Stripper) strip(actx android.ModuleContext, in android.Path, out android.ModuleOutPath,

2
java/lint.go
View file

@ -447,7 +447,7 @@ func (l *lintSingleton) generateLintReportZips(ctx android.SingletonContext) {
var outputs []*lintOutputs
var dirs []string
ctx.VisitAllModules(func(m android.Module) {
if ctx.Config().EmbeddedInMake() && !m.ExportedToMake() {
if ctx.Config().KatiEnabled() && !m.ExportedToMake() {
return
}

6
scripts/build-aml-prebuilts.sh
View file

@ -12,7 +12,7 @@
export OUT_DIR=${OUT_DIR:-out}
if [ -e ${OUT_DIR}/soong/.soong.in_make ]; then
if [ -e ${OUT_DIR}/soong/.soong.kati_enabled ]; then
# If ${OUT_DIR} has been created without --skip-make, Soong will create an
# ${OUT_DIR}/soong/build.ninja that leaves out many targets which are
# expected to be supplied by the .mk files, and that might cause errors in
@ -32,8 +32,8 @@ source build/envsetup.sh
my_get_build_var() {
# get_build_var will run Soong in normal in-make mode where it creates
# .soong.in_make. That would clobber our real out directory, so we need to
# run it in a different one.
# .soong.kati_enabled. That would clobber our real out directory, so we need
# to run it in a different one.
OUT_DIR=${OUT_DIR}/get_build_var get_build_var "$@"
}

2
sdk/testing.go
View file

@ -87,7 +87,7 @@ func testSdkContext(bp string, fs map[string][]byte, extraOsTypes []android.OsTy
// * Configure that we are inside make
// * Add CommonOS to ensure that androidmk processing works.
android.RegisterAndroidMkBuildComponents(ctx)
android.SetInMakeForTests(config)
android.SetKatiEnabledForTests(config)
config.Targets[android.CommonOS] = []android.Target{
{android.CommonOS, android.Arch{ArchType: android.Common}, android.NativeBridgeDisabled, "", "", true},
}

13
ui/build/build.go
View file

@ -23,13 +23,20 @@ import (
"android/soong/ui/metrics"
)
// Ensures the out directory exists, and has the proper files to prevent kati
// from recursing into it.
// SetupOutDir ensures the out directory exists, and has the proper files to
// prevent kati from recursing into it.
func SetupOutDir(ctx Context, config Config) {
ensureEmptyFileExists(ctx, filepath.Join(config.OutDir(), "Android.mk"))
ensureEmptyFileExists(ctx, filepath.Join(config.OutDir(), "CleanSpec.mk"))
if !config.SkipMake() {
ensureEmptyFileExists(ctx, filepath.Join(config.SoongOutDir(), ".soong.in_make"))
// Run soong_build with Kati for a hybrid build, e.g. running the
// AndroidMk singleton and postinstall commands. Communicate this to
// soong_build by writing an empty .soong.kati_enabled marker file in the
// soong_build output directory for the soong_build primary builder to
// know if the user wants to run Kati after.
//
// This does not preclude running Kati for *product configuration purposes*.
ensureEmptyFileExists(ctx, filepath.Join(config.SoongOutDir(), ".soong.kati_enabled"))
}
// The ninja_build file is used by our buildbots to understand that the output
// can be parsed as ninja output.