Merge changes from topic "sbox_tools"

* changes:
  Sandbox genrule tools
  Call ctx.InstallFile for uninstallable cc modules
  Don't copy uninstallable variants of NDK libraries to sysroot
This commit is contained in:
Colin Cross 2020-12-17 22:01:06 +00:00 committed by Gerrit Code Review
commit 97a1be6e7b
19 changed files with 292 additions and 79 deletions

View File

@ -820,7 +820,7 @@ func shouldSkipAndroidMkProcessing(module *ModuleBase) bool {
} }
return !module.Enabled() || return !module.Enabled() ||
module.commonProperties.SkipInstall || module.commonProperties.HideFromMake ||
// Make does not understand LinuxBionic // Make does not understand LinuxBionic
module.Os() == LinuxBionic module.Os() == LinuxBionic
} }

View File

@ -452,8 +452,8 @@ type Module interface {
InstallInRoot() bool InstallInRoot() bool
InstallBypassMake() bool InstallBypassMake() bool
InstallForceOS() (*OsType, *ArchType) InstallForceOS() (*OsType, *ArchType)
SkipInstall() HideFromMake()
IsSkipInstall() bool IsHideFromMake() bool
MakeUninstallable() MakeUninstallable()
ReplacedByPrebuilt() ReplacedByPrebuilt()
IsReplacedByPrebuilt() bool IsReplacedByPrebuilt() bool
@ -751,6 +751,13 @@ type commonProperties struct {
// Set by osMutator. // Set by osMutator.
CommonOSVariant bool `blueprint:"mutated"` CommonOSVariant bool `blueprint:"mutated"`
// When HideFromMake is set to true, no entry for this variant will be emitted in the
// generated Android.mk file.
HideFromMake bool `blueprint:"mutated"`
// When SkipInstall is set to true, calls to ctx.InstallFile, ctx.InstallExecutable,
// ctx.InstallSymlink and ctx.InstallAbsoluteSymlink act like calls to ctx.PackageFile
// and don't create a rule to install the file.
SkipInstall bool `blueprint:"mutated"` SkipInstall bool `blueprint:"mutated"`
// Whether the module has been replaced by a prebuilt // Whether the module has been replaced by a prebuilt
@ -1355,26 +1362,33 @@ func (m *ModuleBase) Disable() {
m.commonProperties.ForcedDisabled = true m.commonProperties.ForcedDisabled = true
} }
// HideFromMake marks this variant so that it is not emitted in the generated Android.mk file.
func (m *ModuleBase) HideFromMake() {
m.commonProperties.HideFromMake = true
}
// IsHideFromMake returns true if HideFromMake was previously called.
func (m *ModuleBase) IsHideFromMake() bool {
return m.commonProperties.HideFromMake == true
}
// SkipInstall marks this variant to not create install rules when ctx.Install* are called.
func (m *ModuleBase) SkipInstall() { func (m *ModuleBase) SkipInstall() {
m.commonProperties.SkipInstall = true m.commonProperties.SkipInstall = true
} }
func (m *ModuleBase) IsSkipInstall() bool { // Similar to HideFromMake, but if the AndroidMk entry would set
return m.commonProperties.SkipInstall == true
}
// Similar to SkipInstall, but if the AndroidMk entry would set
// LOCAL_UNINSTALLABLE_MODULE then this variant may still output that entry // LOCAL_UNINSTALLABLE_MODULE then this variant may still output that entry
// rather than leaving it out altogether. That happens in cases where it would // rather than leaving it out altogether. That happens in cases where it would
// have other side effects, in particular when it adds a NOTICE file target, // have other side effects, in particular when it adds a NOTICE file target,
// which other install targets might depend on. // which other install targets might depend on.
func (m *ModuleBase) MakeUninstallable() { func (m *ModuleBase) MakeUninstallable() {
m.SkipInstall() m.HideFromMake()
} }
func (m *ModuleBase) ReplacedByPrebuilt() { func (m *ModuleBase) ReplacedByPrebuilt() {
m.commonProperties.ReplacedByPrebuilt = true m.commonProperties.ReplacedByPrebuilt = true
m.SkipInstall() m.HideFromMake()
} }
func (m *ModuleBase) IsReplacedByPrebuilt() bool { func (m *ModuleBase) IsReplacedByPrebuilt() bool {
@ -2440,11 +2454,15 @@ func (m *moduleContext) InstallForceOS() (*OsType, *ArchType) {
return m.module.InstallForceOS() return m.module.InstallForceOS()
} }
func (m *moduleContext) skipInstall(fullInstallPath InstallPath) bool { func (m *moduleContext) skipInstall() bool {
if m.module.base().commonProperties.SkipInstall { if m.module.base().commonProperties.SkipInstall {
return true return true
} }
if m.module.base().commonProperties.HideFromMake {
return true
}
// We'll need a solution for choosing which of modules with the same name in different // We'll need a solution for choosing which of modules with the same name in different
// namespaces to install. For now, reuse the list of namespaces exported to Make as the // namespaces to install. For now, reuse the list of namespaces exported to Make as the
// list of namespaces to install in a Soong-only build. // list of namespaces to install in a Soong-only build.
@ -2492,7 +2510,7 @@ func (m *moduleContext) installFile(installPath InstallPath, name string, srcPat
fullInstallPath := installPath.Join(m, name) fullInstallPath := installPath.Join(m, name)
m.module.base().hooks.runInstallHooks(m, srcPath, fullInstallPath, false) m.module.base().hooks.runInstallHooks(m, srcPath, fullInstallPath, false)
if !m.skipInstall(fullInstallPath) { if !m.skipInstall() {
deps = append(deps, m.module.base().installFilesDepSet.ToList().Paths()...) deps = append(deps, m.module.base().installFilesDepSet.ToList().Paths()...)
var implicitDeps, orderOnlyDeps Paths var implicitDeps, orderOnlyDeps Paths
@ -2526,6 +2544,7 @@ func (m *moduleContext) installFile(installPath InstallPath, name string, srcPat
m.packageFile(fullInstallPath, srcPath, executable) m.packageFile(fullInstallPath, srcPath, executable)
m.checkbuildFiles = append(m.checkbuildFiles, srcPath) m.checkbuildFiles = append(m.checkbuildFiles, srcPath)
return fullInstallPath return fullInstallPath
} }
@ -2537,7 +2556,7 @@ func (m *moduleContext) InstallSymlink(installPath InstallPath, name string, src
if err != nil { if err != nil {
panic(fmt.Sprintf("Unable to generate symlink between %q and %q: %s", fullInstallPath.Base(), srcPath.Base(), err)) panic(fmt.Sprintf("Unable to generate symlink between %q and %q: %s", fullInstallPath.Base(), srcPath.Base(), err))
} }
if !m.skipInstall(fullInstallPath) { if !m.skipInstall() {
m.Build(pctx, BuildParams{ m.Build(pctx, BuildParams{
Rule: Symlink, Rule: Symlink,
@ -2570,7 +2589,7 @@ func (m *moduleContext) InstallAbsoluteSymlink(installPath InstallPath, name str
fullInstallPath := installPath.Join(m, name) fullInstallPath := installPath.Join(m, name)
m.module.base().hooks.runInstallHooks(m, nil, fullInstallPath, true) m.module.base().hooks.runInstallHooks(m, nil, fullInstallPath, true)
if !m.skipInstall(fullInstallPath) { if !m.skipInstall() {
m.Build(pctx, BuildParams{ m.Build(pctx, BuildParams{
Rule: Symlink, Rule: Symlink,
Description: "install symlink " + fullInstallPath.Base() + " -> " + absPath, Description: "install symlink " + fullInstallPath.Base() + " -> " + absPath,
@ -2738,6 +2757,7 @@ func outputFilesForModule(ctx PathContext, module blueprint.Module, tag string)
// Modules can implement HostToolProvider and return a valid OptionalPath from HostToolPath() to // Modules can implement HostToolProvider and return a valid OptionalPath from HostToolPath() to
// specify that they can be used as a tool by a genrule module. // specify that they can be used as a tool by a genrule module.
type HostToolProvider interface { type HostToolProvider interface {
Module
// HostToolPath returns the path to the host tool for the module if it is one, or an invalid // HostToolPath returns the path to the host tool for the module if it is one, or an invalid
// OptionalPath. // OptionalPath.
HostToolPath() OptionalPath HostToolPath() OptionalPath

View File

@ -235,7 +235,7 @@ func overrideModuleDepsMutator(ctx BottomUpMutatorContext) {
return return
} }
// See if there's a prebuilt module that overrides this override module with prefer flag, // See if there's a prebuilt module that overrides this override module with prefer flag,
// in which case we call SkipInstall on the corresponding variant later. // in which case we call HideFromMake on the corresponding variant later.
ctx.VisitDirectDepsWithTag(PrebuiltDepTag, func(dep Module) { ctx.VisitDirectDepsWithTag(PrebuiltDepTag, func(dep Module) {
prebuilt, ok := dep.(PrebuiltInterface) prebuilt, ok := dep.(PrebuiltInterface)
if !ok { if !ok {
@ -284,7 +284,7 @@ func performOverrideMutator(ctx BottomUpMutatorContext) {
mods[i+1].(OverridableModule).override(ctx, o) mods[i+1].(OverridableModule).override(ctx, o)
if o.getOverriddenByPrebuilt() { if o.getOverriddenByPrebuilt() {
// The overriding module itself, too, is overridden by a prebuilt. Skip its installation. // The overriding module itself, too, is overridden by a prebuilt. Skip its installation.
mods[i+1].SkipInstall() mods[i+1].HideFromMake()
} }
} }
} else if o, ok := ctx.Module().(OverrideModule); ok { } else if o, ok := ctx.Module().(OverrideModule); ok {

View File

@ -289,7 +289,7 @@ func PrebuiltPostDepsMutator(ctx BottomUpMutatorContext) {
}) })
} }
} else { } else {
m.SkipInstall() m.HideFromMake()
} }
} }
} }

View File

@ -32,6 +32,7 @@ import (
const sboxSandboxBaseDir = "__SBOX_SANDBOX_DIR__" const sboxSandboxBaseDir = "__SBOX_SANDBOX_DIR__"
const sboxOutSubDir = "out" const sboxOutSubDir = "out"
const sboxToolsSubDir = "tools"
const sboxOutDir = sboxSandboxBaseDir + "/" + sboxOutSubDir const sboxOutDir = sboxSandboxBaseDir + "/" + sboxOutSubDir
// RuleBuilder provides an alternative to ModuleContext.Rule and ModuleContext.Build to add a command line to the build // RuleBuilder provides an alternative to ModuleContext.Rule and ModuleContext.Build to add a command line to the build
@ -48,6 +49,7 @@ type RuleBuilder struct {
highmem bool highmem bool
remoteable RemoteRuleSupports remoteable RemoteRuleSupports
outDir WritablePath outDir WritablePath
sboxTools bool
sboxManifestPath WritablePath sboxManifestPath WritablePath
missingDeps []string missingDeps []string
} }
@ -140,6 +142,19 @@ func (r *RuleBuilder) Sbox(outputDir WritablePath, manifestPath WritablePath) *R
return r return r
} }
// SandboxTools enables tool sandboxing for the rule by copying any referenced tools into the
// sandbox.
func (r *RuleBuilder) SandboxTools() *RuleBuilder {
if !r.sbox {
panic("SandboxTools() must be called after Sbox()")
}
if len(r.commands) > 0 {
panic("SandboxTools() may not be called after Command()")
}
r.sboxTools = true
return r
}
// Install associates an output of the rule with an install location, which can be retrieved later using // Install associates an output of the rule with an install location, which can be retrieved later using
// RuleBuilder.Installs. // RuleBuilder.Installs.
func (r *RuleBuilder) Install(from Path, to string) { func (r *RuleBuilder) Install(from Path, to string) {
@ -468,8 +483,29 @@ func (r *RuleBuilder) Build(name string, desc string) {
manifest.OutputDepfile = proto.String(depFile.String()) manifest.OutputDepfile = proto.String(depFile.String())
} }
// If sandboxing tools is enabled, add copy rules to the manifest to copy each tool
// into the sbox directory.
if r.sboxTools {
for _, tool := range tools {
command.CopyBefore = append(command.CopyBefore, &sbox_proto.Copy{
From: proto.String(tool.String()),
To: proto.String(sboxPathForToolRel(r.ctx, tool)),
})
}
for _, c := range r.commands {
for _, tool := range c.packagedTools {
command.CopyBefore = append(command.CopyBefore, &sbox_proto.Copy{
From: proto.String(tool.srcPath.String()),
To: proto.String(sboxPathForPackagedToolRel(tool)),
Executable: proto.Bool(tool.executable),
})
tools = append(tools, tool.srcPath)
}
}
}
// Add copy rules to the manifest to copy each output file from the sbox directory. // Add copy rules to the manifest to copy each output file from the sbox directory.
// to the output directory. // to the output directory after running the commands.
sboxOutputs := make([]string, len(outputs)) sboxOutputs := make([]string, len(outputs))
for i, output := range outputs { for i, output := range outputs {
rel := Rel(r.ctx, r.outDir.String(), output.String()) rel := Rel(r.ctx, r.outDir.String(), output.String())
@ -582,6 +618,7 @@ type RuleBuilderCommand struct {
symlinkOutputs WritablePaths symlinkOutputs WritablePaths
depFiles WritablePaths depFiles WritablePaths
tools Paths tools Paths
packagedTools []PackagingSpec
rspFileInputs Paths rspFileInputs Paths
// spans [start,end) of the command that should not be ninja escaped // spans [start,end) of the command that should not be ninja escaped
@ -625,6 +662,79 @@ func (c *RuleBuilderCommand) PathForOutput(path WritablePath) string {
return path.String() return path.String()
} }
// SboxPathForTool takes a path to a tool, which may be an output file or a source file, and returns
// the corresponding path for the tool in the sbox sandbox. It assumes that sandboxing and tool
// sandboxing are enabled.
func SboxPathForTool(ctx BuilderContext, path Path) string {
return filepath.Join(sboxSandboxBaseDir, sboxPathForToolRel(ctx, path))
}
func sboxPathForToolRel(ctx BuilderContext, path Path) string {
// Errors will be handled in RuleBuilder.Build where we have a context to report them
relOut, isRelOut, _ := maybeRelErr(PathForOutput(ctx, "host", ctx.Config().PrebuiltOS()).String(), path.String())
if isRelOut {
// The tool is in the output directory, it will be copied to __SBOX_OUT_DIR__/tools/out
return filepath.Join(sboxToolsSubDir, "out", relOut)
}
// The tool is in the source directory, it will be copied to __SBOX_OUT_DIR__/tools/src
return filepath.Join(sboxToolsSubDir, "src", path.String())
}
// SboxPathForPackagedTool takes a PackageSpec for a tool and returns the corresponding path for the
// tool after copying it into the sandbox. This can be used on the RuleBuilder command line to
// reference the tool.
func SboxPathForPackagedTool(spec PackagingSpec) string {
return filepath.Join(sboxSandboxBaseDir, sboxPathForPackagedToolRel(spec))
}
func sboxPathForPackagedToolRel(spec PackagingSpec) string {
return filepath.Join(sboxToolsSubDir, "out", spec.relPathInPackage)
}
// PathForTool takes a path to a tool, which may be an output file or a source file, and returns
// the corresponding path for the tool in the sbox sandbox if sbox is enabled, or the original path
// if it is not. This can be used on the RuleBuilder command line to reference the tool.
func (c *RuleBuilderCommand) PathForTool(path Path) string {
if c.rule.sbox && c.rule.sboxTools {
return filepath.Join(sboxSandboxBaseDir, sboxPathForToolRel(c.rule.ctx, path))
}
return path.String()
}
// PackagedTool adds the specified tool path to the command line. It can only be used with tool
// sandboxing enabled by SandboxTools(), and will copy the tool into the sandbox.
func (c *RuleBuilderCommand) PackagedTool(spec PackagingSpec) *RuleBuilderCommand {
if !c.rule.sboxTools {
panic("PackagedTool() requires SandboxTools()")
}
c.packagedTools = append(c.packagedTools, spec)
c.Text(sboxPathForPackagedToolRel(spec))
return c
}
// ImplicitPackagedTool copies the specified tool into the sandbox without modifying the command
// line. It can only be used with tool sandboxing enabled by SandboxTools().
func (c *RuleBuilderCommand) ImplicitPackagedTool(spec PackagingSpec) *RuleBuilderCommand {
if !c.rule.sboxTools {
panic("ImplicitPackagedTool() requires SandboxTools()")
}
c.packagedTools = append(c.packagedTools, spec)
return c
}
// ImplicitPackagedTools copies the specified tools into the sandbox without modifying the command
// line. It can only be used with tool sandboxing enabled by SandboxTools().
func (c *RuleBuilderCommand) ImplicitPackagedTools(specs []PackagingSpec) *RuleBuilderCommand {
if !c.rule.sboxTools {
panic("ImplicitPackagedTools() requires SandboxTools()")
}
c.packagedTools = append(c.packagedTools, specs...)
return c
}
// Text adds the specified raw text to the command line. The text should not contain input or output paths or the // Text adds the specified raw text to the command line. The text should not contain input or output paths or the
// rule will not have them listed in its dependencies or outputs. // rule will not have them listed in its dependencies or outputs.
func (c *RuleBuilderCommand) Text(text string) *RuleBuilderCommand { func (c *RuleBuilderCommand) Text(text string) *RuleBuilderCommand {
@ -693,7 +803,19 @@ func (c *RuleBuilderCommand) FlagWithList(flag string, list []string, sep string
// RuleBuilder.Tools. // RuleBuilder.Tools.
func (c *RuleBuilderCommand) Tool(path Path) *RuleBuilderCommand { func (c *RuleBuilderCommand) Tool(path Path) *RuleBuilderCommand {
c.tools = append(c.tools, path) c.tools = append(c.tools, path)
return c.Text(path.String()) return c.Text(c.PathForTool(path))
}
// Tool adds the specified tool path to the dependencies returned by RuleBuilder.Tools.
func (c *RuleBuilderCommand) ImplicitTool(path Path) *RuleBuilderCommand {
c.tools = append(c.tools, path)
return c
}
// Tool adds the specified tool path to the dependencies returned by RuleBuilder.Tools.
func (c *RuleBuilderCommand) ImplicitTools(paths Paths) *RuleBuilderCommand {
c.tools = append(c.tools, paths...)
return c
} }
// BuiltTool adds the specified tool path that was built using a host Soong module to the command line. The path will // BuiltTool adds the specified tool path that was built using a host Soong module to the command line. The path will

View File

@ -436,6 +436,44 @@ func TestRuleBuilder(t *testing.T) {
t.Errorf("\nwant rule.depFileMergerCmd() = %#v\n got %#v", w, g) t.Errorf("\nwant rule.depFileMergerCmd() = %#v\n got %#v", w, g)
} }
}) })
t.Run("sbox tools", func(t *testing.T) {
rule := NewRuleBuilder(pctx, ctx).Sbox(PathForOutput(ctx, ""),
PathForOutput(ctx, "sbox.textproto")).SandboxTools()
addCommands(rule)
wantCommands := []string{
"__SBOX_SANDBOX_DIR__/out/DepFile Flag FlagWithArg=arg FlagWithDepFile=__SBOX_SANDBOX_DIR__/out/depfile FlagWithInput=input FlagWithOutput=__SBOX_SANDBOX_DIR__/out/output Input __SBOX_SANDBOX_DIR__/out/Output __SBOX_SANDBOX_DIR__/out/SymlinkOutput Text __SBOX_SANDBOX_DIR__/tools/src/Tool after command2 old cmd",
"command2 __SBOX_SANDBOX_DIR__/out/depfile2 input2 __SBOX_SANDBOX_DIR__/out/output2 __SBOX_SANDBOX_DIR__/tools/src/tool2",
"command3 input3 __SBOX_SANDBOX_DIR__/out/output2 __SBOX_SANDBOX_DIR__/out/output3",
}
wantDepMergerCommand := "__SBOX_SANDBOX_DIR__/tools/out/bin/dep_fixer __SBOX_SANDBOX_DIR__/out/DepFile __SBOX_SANDBOX_DIR__/out/depfile __SBOX_SANDBOX_DIR__/out/ImplicitDepFile __SBOX_SANDBOX_DIR__/out/depfile2"
if g, w := rule.Commands(), wantCommands; !reflect.DeepEqual(g, w) {
t.Errorf("\nwant rule.Commands() = %#v\n got %#v", w, g)
}
if g, w := rule.Inputs(), wantInputs; !reflect.DeepEqual(w, g) {
t.Errorf("\nwant rule.Inputs() = %#v\n got %#v", w, g)
}
if g, w := rule.Outputs(), wantOutputs; !reflect.DeepEqual(w, g) {
t.Errorf("\nwant rule.Outputs() = %#v\n got %#v", w, g)
}
if g, w := rule.DepFiles(), wantDepFiles; !reflect.DeepEqual(w, g) {
t.Errorf("\nwant rule.DepFiles() = %#v\n got %#v", w, g)
}
if g, w := rule.Tools(), wantTools; !reflect.DeepEqual(w, g) {
t.Errorf("\nwant rule.Tools() = %#v\n got %#v", w, g)
}
if g, w := rule.OrderOnlys(), wantOrderOnlys; !reflect.DeepEqual(w, g) {
t.Errorf("\nwant rule.OrderOnlys() = %#v\n got %#v", w, g)
}
if g, w := rule.depFileMergerCmd(rule.DepFiles()).String(), wantDepMergerCommand; g != w {
t.Errorf("\nwant rule.depFileMergerCmd() = %#v\n got %#v", w, g)
}
})
} }
func testRuleBuilderFactory() Module { func testRuleBuilderFactory() Module {

View File

@ -6578,7 +6578,7 @@ func TestPrebuiltStubLibDep(t *testing.T) {
continue continue
} }
mod := ctx.ModuleForTests(modName, variant).Module().(*cc.Module) mod := ctx.ModuleForTests(modName, variant).Module().(*cc.Module)
if !mod.Enabled() || mod.IsSkipInstall() { if !mod.Enabled() || mod.IsHideFromMake() {
continue continue
} }
for _, ent := range android.AndroidMkEntriesForTest(t, config, "", mod) { for _, ent := range android.AndroidMkEntriesForTest(t, config, "", mod) {

View File

@ -218,7 +218,7 @@ func (p *Prebuilt) GenerateAndroidBuildActions(ctx android.ModuleContext) {
}) })
if p.prebuiltCommon.checkForceDisable(ctx) { if p.prebuiltCommon.checkForceDisable(ctx) {
p.SkipInstall() p.HideFromMake()
return return
} }
@ -392,7 +392,7 @@ func (a *ApexSet) GenerateAndroidBuildActions(ctx android.ModuleContext) {
}) })
if a.prebuiltCommon.checkForceDisable(ctx) { if a.prebuiltCommon.checkForceDisable(ctx) {
a.SkipInstall() a.HideFromMake()
return return
} }

View File

@ -273,7 +273,7 @@ func (library *libraryDecorator) AndroidMkEntries(ctx AndroidMkContext, entries
entries.SubName = "." + library.stubsVersion() entries.SubName = "." + library.stubsVersion()
} }
entries.ExtraEntries = append(entries.ExtraEntries, func(entries *android.AndroidMkEntries) { entries.ExtraEntries = append(entries.ExtraEntries, func(entries *android.AndroidMkEntries) {
// library.makeUninstallable() depends on this to bypass SkipInstall() for // library.makeUninstallable() depends on this to bypass HideFromMake() for
// static libraries. // static libraries.
entries.SetBool("LOCAL_UNINSTALLABLE_MODULE", true) entries.SetBool("LOCAL_UNINSTALLABLE_MODULE", true)
if library.buildStubs() { if library.buildStubs() {

View File

@ -432,6 +432,7 @@ type ModuleContextIntf interface {
mustUseVendorVariant() bool mustUseVendorVariant() bool
nativeCoverage() bool nativeCoverage() bool
directlyInAnyApex() bool directlyInAnyApex() bool
isPreventInstall() bool
} }
type ModuleContext interface { type ModuleContext interface {
@ -1325,6 +1326,10 @@ func (ctx *moduleContextImpl) directlyInAnyApex() bool {
return ctx.mod.DirectlyInAnyApex() return ctx.mod.DirectlyInAnyApex()
} }
func (ctx *moduleContextImpl) isPreventInstall() bool {
return ctx.mod.Properties.PreventInstall
}
func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module { func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
return &Module{ return &Module{
hod: hod, hod: hod,
@ -1575,18 +1580,24 @@ func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
} }
} }
if c.installable(apexInfo) { if !proptools.BoolDefault(c.Properties.Installable, true) {
// If the module has been specifically configure to not be installed then
// hide from make as otherwise it will break when running inside make
// as the output path to install will not be specified. Not all uninstallable
// modules can be hidden from make as some are needed for resolving make side
// dependencies.
c.HideFromMake()
} else if !c.installable(apexInfo) {
c.SkipInstall()
}
// Still call c.installer.install though, the installs will be stored as PackageSpecs
// to allow using the outputs in a genrule.
if c.installer != nil && c.outputFile.Valid() {
c.installer.install(ctx, c.outputFile.Path()) c.installer.install(ctx, c.outputFile.Path())
if ctx.Failed() { if ctx.Failed() {
return return
} }
} else if !proptools.BoolDefault(c.Properties.Installable, true) {
// If the module has been specifically configure to not be installed then
// skip the installation as otherwise it will break when running inside make
// as the output path to install will not be specified. Not all uninstallable
// modules can skip installation as some are needed for resolving make side
// dependencies.
c.SkipInstall()
} }
} }

View File

@ -454,7 +454,7 @@ func (c *Module) SetImageVariation(ctx android.BaseModuleContext, variant string
vndkVersion := ctx.DeviceConfig().VndkVersion() vndkVersion := ctx.DeviceConfig().VndkVersion()
if vndkVersion != "current" && vndkVersion != "" && vndkVersion != m.Properties.VndkVersion { if vndkVersion != "current" && vndkVersion != "" && vndkVersion != m.Properties.VndkVersion {
m.Properties.HideFromMake = true m.Properties.HideFromMake = true
m.SkipInstall() m.HideFromMake()
} }
} else if strings.HasPrefix(variant, ProductVariationPrefix) { } else if strings.HasPrefix(variant, ProductVariationPrefix) {
m.Properties.ImageVariationPrefix = ProductVariationPrefix m.Properties.ImageVariationPrefix = ProductVariationPrefix

View File

@ -1336,7 +1336,7 @@ func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
} }
} else if ctx.directlyInAnyApex() && ctx.isLlndk(ctx.Config()) && !isBionic(ctx.baseModuleName()) { } else if ctx.directlyInAnyApex() && ctx.isLlndk(ctx.Config()) && !isBionic(ctx.baseModuleName()) {
// Skip installing LLNDK (non-bionic) libraries moved to APEX. // Skip installing LLNDK (non-bionic) libraries moved to APEX.
ctx.Module().SkipInstall() ctx.Module().HideFromMake()
} }
library.baseInstaller.install(ctx, file) library.baseInstaller.install(ctx, file)
@ -1345,7 +1345,7 @@ func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
if Bool(library.Properties.Static_ndk_lib) && library.static() && if Bool(library.Properties.Static_ndk_lib) && library.static() &&
!ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() && !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
library.baseLinker.sanitize.isUnsanitizedVariant() && library.baseLinker.sanitize.isUnsanitizedVariant() &&
!library.buildStubs() && ctx.sdkVersion() == "" { ctx.isForPlatform() && !ctx.isPreventInstall() {
installPath := getNdkSysrootBase(ctx).Join( installPath := getNdkSysrootBase(ctx).Join(
ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base()) ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())

View File

@ -131,7 +131,7 @@ func shouldCreateSourceAbiDumpForLibrary(ctx android.BaseModuleContext) bool {
// Module is shared library type. // Module is shared library type.
// Don't check uninstallable modules. // Don't check uninstallable modules.
if m.IsSkipInstall() { if m.IsHideFromMake() {
return false return false
} }

View File

@ -836,7 +836,7 @@ func VendorSnapshotSourceMutator(ctx android.BottomUpMutatorContext) {
// Disables source modules if corresponding snapshot exists. // Disables source modules if corresponding snapshot exists.
if lib, ok := module.linker.(libraryInterface); ok && lib.buildStatic() && lib.buildShared() { if lib, ok := module.linker.(libraryInterface); ok && lib.buildStatic() && lib.buildShared() {
// But do not disable because the shared variant depends on the static variant. // But do not disable because the shared variant depends on the static variant.
module.SkipInstall() module.HideFromMake()
module.Properties.HideFromMake = true module.Properties.HideFromMake = true
} else { } else {
module.Disable() module.Disable()

View File

@ -181,8 +181,8 @@ func isSnapshotAware(m *Module, inProprietaryPath bool, apexInfo android.ApexInf
return false return false
} }
// When android/prebuilt.go selects between source and prebuilt, it sets // When android/prebuilt.go selects between source and prebuilt, it sets
// SkipInstall on the other one to avoid duplicate install rules in make. // HideFromMake on the other one to avoid duplicate install rules in make.
if m.IsSkipInstall() { if m.IsHideFromMake() {
return false return false
} }
// skip proprietary modules, but (for the vendor snapshot only) // skip proprietary modules, but (for the vendor snapshot only)

View File

@ -130,7 +130,7 @@ func (p *vndkPrebuiltLibraryDecorator) link(ctx ModuleContext,
flags Flags, deps PathDeps, objs Objects) android.Path { flags Flags, deps PathDeps, objs Objects) android.Path {
if !p.matchesWithDevice(ctx.DeviceConfig()) { if !p.matchesWithDevice(ctx.DeviceConfig()) {
ctx.Module().SkipInstall() ctx.Module().HideFromMake()
return nil return nil
} }
@ -175,7 +175,7 @@ func (p *vndkPrebuiltLibraryDecorator) link(ctx ModuleContext,
return in return in
} }
ctx.Module().SkipInstall() ctx.Module().HideFromMake()
return nil return nil
} }

View File

@ -139,7 +139,6 @@ type Module struct {
// number of shards the input files are sharded into. // number of shards the input files are sharded into.
taskGenerator taskFunc taskGenerator taskFunc
deps android.Paths
rule blueprint.Rule rule blueprint.Rule
rawCommands []string rawCommands []string
@ -244,6 +243,8 @@ func (g *Module) GenerateAndroidBuildActions(ctx android.ModuleContext) {
} }
} }
var tools android.Paths
var packagedTools []android.PackagingSpec
if len(g.properties.Tools) > 0 { if len(g.properties.Tools) > 0 {
seenTools := make(map[string]bool) seenTools := make(map[string]bool)
@ -251,37 +252,52 @@ func (g *Module) GenerateAndroidBuildActions(ctx android.ModuleContext) {
switch tag := ctx.OtherModuleDependencyTag(module).(type) { switch tag := ctx.OtherModuleDependencyTag(module).(type) {
case hostToolDependencyTag: case hostToolDependencyTag:
tool := ctx.OtherModuleName(module) tool := ctx.OtherModuleName(module)
var path android.OptionalPath
if t, ok := module.(android.HostToolProvider); ok { switch t := module.(type) {
case android.HostToolProvider:
// A HostToolProvider provides the path to a tool, which will be copied
// into the sandbox.
if !t.(android.Module).Enabled() { if !t.(android.Module).Enabled() {
if ctx.Config().AllowMissingDependencies() { if ctx.Config().AllowMissingDependencies() {
ctx.AddMissingDependencies([]string{tool}) ctx.AddMissingDependencies([]string{tool})
} else { } else {
ctx.ModuleErrorf("depends on disabled module %q", tool) ctx.ModuleErrorf("depends on disabled module %q", tool)
} }
break return
} }
path = t.HostToolPath() path := t.HostToolPath()
} else if t, ok := module.(bootstrap.GoBinaryTool); ok { if !path.Valid() {
ctx.ModuleErrorf("host tool %q missing output file", tool)
return
}
if specs := t.TransitivePackagingSpecs(); specs != nil {
// If the HostToolProvider has PackgingSpecs, which are definitions of the
// required relative locations of the tool and its dependencies, use those
// instead. They will be copied to those relative locations in the sbox
// sandbox.
packagedTools = append(packagedTools, specs...)
// Assume that the first PackagingSpec of the module is the tool.
addLocationLabel(tag.label, []string{android.SboxPathForPackagedTool(specs[0])})
} else {
tools = append(tools, path.Path())
addLocationLabel(tag.label, []string{android.SboxPathForTool(ctx, path.Path())})
}
case bootstrap.GoBinaryTool:
// A GoBinaryTool provides the install path to a tool, which will be copied.
if s, err := filepath.Rel(android.PathForOutput(ctx).String(), t.InstallPath()); err == nil { if s, err := filepath.Rel(android.PathForOutput(ctx).String(), t.InstallPath()); err == nil {
path = android.OptionalPathForPath(android.PathForOutput(ctx, s)) toolPath := android.PathForOutput(ctx, s)
tools = append(tools, toolPath)
addLocationLabel(tag.label, []string{android.SboxPathForTool(ctx, toolPath)})
} else { } else {
ctx.ModuleErrorf("cannot find path for %q: %v", tool, err) ctx.ModuleErrorf("cannot find path for %q: %v", tool, err)
break return
} }
} else { default:
ctx.ModuleErrorf("%q is not a host tool provider", tool) ctx.ModuleErrorf("%q is not a host tool provider", tool)
break return
} }
if path.Valid() {
g.deps = append(g.deps, path.Path())
addLocationLabel(tag.label, []string{path.Path().String()})
seenTools[tag.label] = true seenTools[tag.label] = true
} else {
ctx.ModuleErrorf("host tool %q missing output file", tool)
}
} }
}) })
@ -305,8 +321,12 @@ func (g *Module) GenerateAndroidBuildActions(ctx android.ModuleContext) {
for _, toolFile := range g.properties.Tool_files { for _, toolFile := range g.properties.Tool_files {
paths := android.PathsForModuleSrc(ctx, []string{toolFile}) paths := android.PathsForModuleSrc(ctx, []string{toolFile})
g.deps = append(g.deps, paths...) tools = append(tools, paths...)
addLocationLabel(toolFile, paths.Strings()) var sandboxPaths []string
for _, path := range paths {
sandboxPaths = append(sandboxPaths, android.SboxPathForTool(ctx, path))
}
addLocationLabel(toolFile, sandboxPaths)
} }
var srcFiles android.Paths var srcFiles android.Paths
@ -358,7 +378,7 @@ func (g *Module) GenerateAndroidBuildActions(ctx android.ModuleContext) {
manifestPath := android.PathForModuleOut(ctx, manifestName) manifestPath := android.PathForModuleOut(ctx, manifestName)
// Use a RuleBuilder to create a rule that runs the command inside an sbox sandbox. // Use a RuleBuilder to create a rule that runs the command inside an sbox sandbox.
rule := android.NewRuleBuilder(pctx, ctx).Sbox(task.genDir, manifestPath) rule := android.NewRuleBuilder(pctx, ctx).Sbox(task.genDir, manifestPath).SandboxTools()
cmd := rule.Command() cmd := rule.Command()
for _, out := range task.out { for _, out := range task.out {
@ -448,8 +468,9 @@ func (g *Module) GenerateAndroidBuildActions(ctx android.ModuleContext) {
cmd.Text(rawCommand) cmd.Text(rawCommand)
cmd.ImplicitOutputs(task.out) cmd.ImplicitOutputs(task.out)
cmd.Implicits(task.in) cmd.Implicits(task.in)
cmd.Implicits(g.deps) cmd.ImplicitTools(tools)
cmd.Implicits(task.extraTools) cmd.ImplicitTools(task.extraTools)
cmd.ImplicitPackagedTools(packagedTools)
if Bool(g.properties.Depfile) { if Bool(g.properties.Depfile) {
cmd.ImplicitDepFile(task.depFile) cmd.ImplicitDepFile(task.depFile)
} }
@ -619,7 +640,7 @@ func NewGenSrcs() *Module {
// TODO(ccross): this RuleBuilder is a hack to be able to call // TODO(ccross): this RuleBuilder is a hack to be able to call
// rule.Command().PathForOutput. Replace this with passing the rule into the // rule.Command().PathForOutput. Replace this with passing the rule into the
// generator. // generator.
rule := android.NewRuleBuilder(pctx, ctx).Sbox(genDir, nil) rule := android.NewRuleBuilder(pctx, ctx).Sbox(genDir, nil).SandboxTools()
for _, in := range shard { for _, in := range shard {
outFile := android.GenPathWithExt(ctx, finalSubDir, in, String(properties.Output_extension)) outFile := android.GenPathWithExt(ctx, finalSubDir, in, String(properties.Output_extension))
@ -672,7 +693,8 @@ func NewGenSrcs() *Module {
outputDepfile = android.PathForModuleGen(ctx, genSubDir, "gensrcs.d") outputDepfile = android.PathForModuleGen(ctx, genSubDir, "gensrcs.d")
depFixerTool := ctx.Config().HostToolPath(ctx, "dep_fixer") depFixerTool := ctx.Config().HostToolPath(ctx, "dep_fixer")
fullCommand += fmt.Sprintf(" && %s -o $(depfile) %s", fullCommand += fmt.Sprintf(" && %s -o $(depfile) %s",
depFixerTool.String(), strings.Join(commandDepFiles, " ")) android.SboxPathForTool(ctx, depFixerTool),
strings.Join(commandDepFiles, " "))
extraTools = append(extraTools, depFixerTool) extraTools = append(extraTools, depFixerTool)
} }

View File

@ -141,7 +141,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(location) > $(out)", cmd: "$(location) > $(out)",
`, `,
expect: "out/tool > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/out/bin/tool > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "empty location tool2", name: "empty location tool2",
@ -150,7 +150,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(location) > $(out)", cmd: "$(location) > $(out)",
`, `,
expect: "out/tool > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/out/bin/tool > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "empty location tool file", name: "empty location tool file",
@ -159,7 +159,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(location) > $(out)", cmd: "$(location) > $(out)",
`, `,
expect: "tool_file1 > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/src/tool_file1 > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "empty location tool file fg", name: "empty location tool file fg",
@ -168,7 +168,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(location) > $(out)", cmd: "$(location) > $(out)",
`, `,
expect: "tool_file1 > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/src/tool_file1 > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "empty location tool and tool file", name: "empty location tool and tool file",
@ -178,7 +178,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(location) > $(out)", cmd: "$(location) > $(out)",
`, `,
expect: "out/tool > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/out/bin/tool > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "tool", name: "tool",
@ -187,7 +187,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(location tool) > $(out)", cmd: "$(location tool) > $(out)",
`, `,
expect: "out/tool > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/out/bin/tool > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "tool2", name: "tool2",
@ -196,7 +196,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(location :tool) > $(out)", cmd: "$(location :tool) > $(out)",
`, `,
expect: "out/tool > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/out/bin/tool > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "tool file", name: "tool file",
@ -205,7 +205,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(location tool_file1) > $(out)", cmd: "$(location tool_file1) > $(out)",
`, `,
expect: "tool_file1 > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/src/tool_file1 > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "tool file fg", name: "tool file fg",
@ -214,7 +214,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(location :1tool_file) > $(out)", cmd: "$(location :1tool_file) > $(out)",
`, `,
expect: "tool_file1 > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/src/tool_file1 > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "tool files", name: "tool files",
@ -223,7 +223,7 @@ func TestGenruleCmd(t *testing.T) {
out: ["out"], out: ["out"],
cmd: "$(locations :tool_files) > $(out)", cmd: "$(locations :tool_files) > $(out)",
`, `,
expect: "tool_file1 tool_file2 > __SBOX_SANDBOX_DIR__/out/out", expect: "__SBOX_SANDBOX_DIR__/tools/src/tool_file1 __SBOX_SANDBOX_DIR__/tools/src/tool_file2 > __SBOX_SANDBOX_DIR__/out/out",
}, },
{ {
name: "in1", name: "in1",
@ -600,7 +600,7 @@ func TestGenSrcs(t *testing.T) {
cmd: "$(location) $(in) > $(out)", cmd: "$(location) $(in) > $(out)",
`, `,
cmds: []string{ cmds: []string{
"bash -c 'out/tool in1.txt > __SBOX_SANDBOX_DIR__/out/in1.h' && bash -c 'out/tool in2.txt > __SBOX_SANDBOX_DIR__/out/in2.h'", "bash -c '__SBOX_SANDBOX_DIR__/tools/out/bin/tool in1.txt > __SBOX_SANDBOX_DIR__/out/in1.h' && bash -c '__SBOX_SANDBOX_DIR__/tools/out/bin/tool in2.txt > __SBOX_SANDBOX_DIR__/out/in2.h'",
}, },
deps: []string{buildDir + "/.intermediates/gen/gen/gensrcs/in1.h", buildDir + "/.intermediates/gen/gen/gensrcs/in2.h"}, deps: []string{buildDir + "/.intermediates/gen/gen/gensrcs/in1.h", buildDir + "/.intermediates/gen/gen/gensrcs/in2.h"},
files: []string{buildDir + "/.intermediates/gen/gen/gensrcs/in1.h", buildDir + "/.intermediates/gen/gen/gensrcs/in2.h"}, files: []string{buildDir + "/.intermediates/gen/gen/gensrcs/in1.h", buildDir + "/.intermediates/gen/gen/gensrcs/in2.h"},
@ -614,8 +614,8 @@ func TestGenSrcs(t *testing.T) {
shard_size: 2, shard_size: 2,
`, `,
cmds: []string{ cmds: []string{
"bash -c 'out/tool in1.txt > __SBOX_SANDBOX_DIR__/out/in1.h' && bash -c 'out/tool in2.txt > __SBOX_SANDBOX_DIR__/out/in2.h'", "bash -c '__SBOX_SANDBOX_DIR__/tools/out/bin/tool in1.txt > __SBOX_SANDBOX_DIR__/out/in1.h' && bash -c '__SBOX_SANDBOX_DIR__/tools/out/bin/tool in2.txt > __SBOX_SANDBOX_DIR__/out/in2.h'",
"bash -c 'out/tool in3.txt > __SBOX_SANDBOX_DIR__/out/in3.h'", "bash -c '__SBOX_SANDBOX_DIR__/tools/out/bin/tool in3.txt > __SBOX_SANDBOX_DIR__/out/in3.h'",
}, },
deps: []string{buildDir + "/.intermediates/gen/gen/gensrcs/in1.h", buildDir + "/.intermediates/gen/gen/gensrcs/in2.h", buildDir + "/.intermediates/gen/gen/gensrcs/in3.h"}, deps: []string{buildDir + "/.intermediates/gen/gen/gensrcs/in1.h", buildDir + "/.intermediates/gen/gen/gensrcs/in2.h", buildDir + "/.intermediates/gen/gen/gensrcs/in3.h"},
files: []string{buildDir + "/.intermediates/gen/gen/gensrcs/in1.h", buildDir + "/.intermediates/gen/gen/gensrcs/in2.h", buildDir + "/.intermediates/gen/gen/gensrcs/in3.h"}, files: []string{buildDir + "/.intermediates/gen/gen/gensrcs/in1.h", buildDir + "/.intermediates/gen/gen/gensrcs/in2.h", buildDir + "/.intermediates/gen/gen/gensrcs/in3.h"},
@ -758,7 +758,7 @@ func toolFactory() android.Module {
} }
func (t *testTool) GenerateAndroidBuildActions(ctx android.ModuleContext) { func (t *testTool) GenerateAndroidBuildActions(ctx android.ModuleContext) {
t.outputFile = android.PathForTesting("out", ctx.ModuleName()) t.outputFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "bin"), ctx.ModuleName(), android.PathForOutput(ctx, ctx.ModuleName()))
} }
func (t *testTool) HostToolPath() android.OptionalPath { func (t *testTool) HostToolPath() android.OptionalPath {

View File

@ -90,7 +90,7 @@ func (mod *Module) SetImageVariation(ctx android.BaseModuleContext, variant stri
vndkVersion := ctx.DeviceConfig().VndkVersion() vndkVersion := ctx.DeviceConfig().VndkVersion()
if vndkVersion != "current" && vndkVersion != "" && vndkVersion != m.Properties.VndkVersion { if vndkVersion != "current" && vndkVersion != "" && vndkVersion != m.Properties.VndkVersion {
m.Properties.HideFromMake = true m.Properties.HideFromMake = true
m.SkipInstall() m.HideFromMake()
} }
} }
} }