platform_build_soong/android/prebuilt_build_tool.go
Dan Willemsen 751ae87ed2 Reland "Add prebuilt_build_tool to allow genrules to use prebuilt tools"
Includes fixes for out dirs at absolute paths, and symlinks to absolute
paths. Also squashes support for exporting make vars, which previously
happened in a later patch (which got moved first, since it's mostly
infrastructure changes).

Original message:

cc_prebuilt_binary doesn't work well for host tools because they'll
often be using their own versions of shared libraries that may not be
compatible with what we build.

So add a module type that allows genrules to use one of these prebuilts
as a tool. Like other prebuilts, we'll use the source module if we have
it, or the prebuilt otherwise.

It supports adding extra dependencies for shared libraries or other data
files that are necessary to run the tool. Any genrules using the tool
will be rerun if any of the dependencies change.

Bug: 128690776
Test: treehugger
Test: build one-true-awk using genrule with bison
Test: with OUT_DIR=$PWD/out
Test: with OUT_DIR pointing to an absolute symlink
Change-Id: I662296cb55503b6a10ec5e5465b138e9edeb71f3
2020-08-06 15:56:38 -07:00

94 lines
2.8 KiB
Go

// Copyright 2020 Google Inc. All rights reserved.
//
// 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
//
// http://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 android
func init() {
RegisterModuleType("prebuilt_build_tool", prebuiltBuildToolFactory)
}
type prebuiltBuildToolProperties struct {
// Source file to be executed for this build tool
Src *string `android:"path,arch_variant"`
// Extra files that should trigger rules using this tool to rebuild
Deps []string `android:"path,arch_variant"`
// Create a make variable with the specified name that contains the path to
// this prebuilt built tool, relative to the root of the source tree.
Export_to_make_var *string
}
type prebuiltBuildTool struct {
ModuleBase
prebuilt Prebuilt
properties prebuiltBuildToolProperties
toolPath OptionalPath
}
func (t *prebuiltBuildTool) Name() string {
return t.prebuilt.Name(t.ModuleBase.Name())
}
func (t *prebuiltBuildTool) Prebuilt() *Prebuilt {
return &t.prebuilt
}
func (t *prebuiltBuildTool) DepsMutator(ctx BottomUpMutatorContext) {
if t.properties.Src == nil {
ctx.PropertyErrorf("src", "missing prebuilt source file")
}
}
func (t *prebuiltBuildTool) GenerateAndroidBuildActions(ctx ModuleContext) {
sourcePath := t.prebuilt.SingleSourcePath(ctx)
installedPath := PathForModuleOut(ctx, t.ModuleBase.Name())
deps := PathsForModuleSrc(ctx, t.properties.Deps)
ctx.Build(pctx, BuildParams{
Rule: Symlink,
Output: installedPath,
Input: sourcePath,
Implicits: deps,
Args: map[string]string{
"fromPath": "$$PWD/" + sourcePath.String(),
},
})
t.toolPath = OptionalPathForPath(installedPath)
}
func (t *prebuiltBuildTool) MakeVars(ctx MakeVarsModuleContext) {
if makeVar := String(t.properties.Export_to_make_var); makeVar != "" {
ctx.StrictRaw(makeVar, t.toolPath.String())
}
}
func (t *prebuiltBuildTool) HostToolPath() OptionalPath {
return t.toolPath
}
var _ HostToolProvider = &prebuiltBuildTool{}
// prebuilt_build_tool is to declare prebuilts to be used during the build, particularly for use
// in genrules with the "tools" property.
func prebuiltBuildToolFactory() Module {
module := &prebuiltBuildTool{}
module.AddProperties(&module.properties)
InitSingleSourcePrebuiltModule(module, &module.properties, "Src")
InitAndroidArchModule(module, HostSupportedNoCross, MultilibFirst)
return module
}