Fix genrule tool dependencies when a prebuilt tool is preferred.
Since the genrule tool dep mutator runs after the prebuilt mutators,
this adds a helper function android.PrebuiltGetPreferred to resolve the
source or prebuilt as appropriate.
Test: m SOONG_CONFIG_art_module_source_build=false droid
in internal
Bug: 214292395
Change-Id: I1a208fd048b998f9f19ad1f45d8389decda2cb9e
diff --git a/genrule/genrule.go b/genrule/genrule.go
index 6a91e01..c3e3ba5 100644
--- a/genrule/genrule.go
+++ b/genrule/genrule.go
@@ -106,6 +106,16 @@
android.LicenseAnnotationToolchainDependencyTag
label string
}
+
+func (t hostToolDependencyTag) AllowDisabledModuleDependency(target android.Module) bool {
+ // Allow depending on a disabled module if it's replaced by a prebuilt
+ // counterpart. We get the prebuilt through android.PrebuiltGetPreferred in
+ // GenerateAndroidBuildActions.
+ return target.IsReplacedByPrebuilt()
+}
+
+var _ android.AllowDisabledModuleDependency = (*hostToolDependencyTag)(nil)
+
type generatorProperties struct {
// The command to run on one or more input files. Cmd supports substitution of a few variables.
//
@@ -298,6 +308,12 @@
switch tag := ctx.OtherModuleDependencyTag(module).(type) {
case hostToolDependencyTag:
tool := ctx.OtherModuleName(module)
+ if m, ok := module.(android.Module); ok {
+ // Necessary to retrieve any prebuilt replacement for the tool, since
+ // toolDepsMutator runs too late for the prebuilt mutators to have
+ // replaced the dependency.
+ module = android.PrebuiltGetPreferred(ctx, m)
+ }
switch t := module.(type) {
case android.HostToolProvider:
diff --git a/genrule/genrule_test.go b/genrule/genrule_test.go
index 714d2f8..04c97fd 100644
--- a/genrule/genrule_test.go
+++ b/genrule/genrule_test.go
@@ -34,7 +34,9 @@
android.PrepareForTestWithFilegroup,
PrepareForTestWithGenRuleBuildComponents,
android.FixtureRegisterWithContext(func(ctx android.RegistrationContext) {
+ android.RegisterPrebuiltMutators(ctx)
ctx.RegisterModuleType("tool", toolFactory)
+ ctx.RegisterModuleType("prebuilt_tool", prebuiltToolFactory)
ctx.RegisterModuleType("output", outputProducerFactory)
ctx.RegisterModuleType("use_source", useSourceFactory)
}),
@@ -720,6 +722,69 @@
result.ModuleForTests("gen_all", "").Module().(*useSource).srcs)
}
+func TestPrebuiltTool(t *testing.T) {
+ testcases := []struct {
+ name string
+ bp string
+ expectedToolName string
+ }{
+ {
+ name: "source only",
+ bp: `
+ tool { name: "tool" }
+ `,
+ expectedToolName: "bin/tool",
+ },
+ {
+ name: "prebuilt only",
+ bp: `
+ prebuilt_tool { name: "tool" }
+ `,
+ expectedToolName: "prebuilt_bin/tool",
+ },
+ {
+ name: "source preferred",
+ bp: `
+ tool { name: "tool" }
+ prebuilt_tool { name: "tool" }
+ `,
+ expectedToolName: "bin/tool",
+ },
+ {
+ name: "prebuilt preferred",
+ bp: `
+ tool { name: "tool" }
+ prebuilt_tool { name: "tool", prefer: true }
+ `,
+ expectedToolName: "prebuilt_bin/prebuilt_tool",
+ },
+ {
+ name: "source disabled",
+ bp: `
+ tool { name: "tool", enabled: false }
+ prebuilt_tool { name: "tool" }
+ `,
+ expectedToolName: "prebuilt_bin/prebuilt_tool",
+ },
+ }
+
+ for _, test := range testcases {
+ t.Run(test.name, func(t *testing.T) {
+ result := prepareForGenRuleTest.RunTestWithBp(t, test.bp+`
+ genrule {
+ name: "gen",
+ tools: ["tool"],
+ out: ["foo"],
+ cmd: "$(location tool)",
+ }
+ `)
+ gen := result.Module("gen", "").(*Module)
+ expectedCmd := "__SBOX_SANDBOX_DIR__/tools/out/" + test.expectedToolName
+ android.AssertStringEquals(t, "command", expectedCmd, gen.rawCommands[0])
+ })
+ }
+}
+
func TestGenruleWithBazel(t *testing.T) {
bp := `
genrule {
@@ -764,7 +829,33 @@
return android.OptionalPathForPath(t.outputFile)
}
+type prebuiltTestTool struct {
+ android.ModuleBase
+ prebuilt android.Prebuilt
+ testTool
+}
+
+func (p *prebuiltTestTool) Name() string {
+ return p.prebuilt.Name(p.ModuleBase.Name())
+}
+
+func (p *prebuiltTestTool) Prebuilt() *android.Prebuilt {
+ return &p.prebuilt
+}
+
+func (t *prebuiltTestTool) GenerateAndroidBuildActions(ctx android.ModuleContext) {
+ t.outputFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "prebuilt_bin"), ctx.ModuleName(), android.PathForOutput(ctx, ctx.ModuleName()))
+}
+
+func prebuiltToolFactory() android.Module {
+ module := &prebuiltTestTool{}
+ android.InitPrebuiltModuleWithoutSrcs(module)
+ android.InitAndroidArchModule(module, android.HostSupported, android.MultilibFirst)
+ return module
+}
+
var _ android.HostToolProvider = (*testTool)(nil)
+var _ android.HostToolProvider = (*prebuiltTestTool)(nil)
type testOutputProducer struct {
android.ModuleBase