// Copyright 2016 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
|
|
import (
|
"fmt"
|
"io"
|
"strings"
|
)
|
|
// TODO(jungw): Now that it handles more than the ones in etc/, consider renaming this file.
|
|
func init() {
|
RegisterModuleType("prebuilt_etc", PrebuiltEtcFactory)
|
RegisterModuleType("prebuilt_etc_host", PrebuiltEtcHostFactory)
|
RegisterModuleType("prebuilt_usr_share", PrebuiltUserShareFactory)
|
RegisterModuleType("prebuilt_usr_share_host", PrebuiltUserShareHostFactory)
|
|
PreDepsMutators(func(ctx RegisterMutatorsContext) {
|
ctx.BottomUp("prebuilt_etc", prebuiltEtcMutator).Parallel()
|
})
|
}
|
|
type prebuiltEtcProperties struct {
|
// Source file of this prebuilt.
|
Src *string `android:"path,arch_variant"`
|
|
// optional subdirectory under which this file is installed into
|
Sub_dir *string `android:"arch_variant"`
|
|
// optional name for the installed file. If unspecified, name of the module is used as the file name
|
Filename *string `android:"arch_variant"`
|
|
// when set to true, and filename property is not set, the name for the installed file
|
// is the same as the file name of the source file.
|
Filename_from_src *bool `android:"arch_variant"`
|
|
// Make this module available when building for recovery.
|
Recovery_available *bool
|
|
InRecovery bool `blueprint:"mutated"`
|
|
// Whether this module is directly installable to one of the partitions. Default: true.
|
Installable *bool
|
}
|
|
type PrebuiltEtc struct {
|
ModuleBase
|
|
properties prebuiltEtcProperties
|
|
sourceFilePath Path
|
outputFilePath OutputPath
|
// The base install location, e.g. "etc" for prebuilt_etc, "usr/share" for prebuilt_usr_share.
|
installDirBase string
|
installDirPath OutputPath
|
additionalDependencies *Paths
|
}
|
|
func (p *PrebuiltEtc) inRecovery() bool {
|
return p.properties.InRecovery || p.ModuleBase.InstallInRecovery()
|
}
|
|
func (p *PrebuiltEtc) onlyInRecovery() bool {
|
return p.ModuleBase.InstallInRecovery()
|
}
|
|
func (p *PrebuiltEtc) InstallInRecovery() bool {
|
return p.inRecovery()
|
}
|
|
func (p *PrebuiltEtc) DepsMutator(ctx BottomUpMutatorContext) {
|
if p.properties.Src == nil {
|
ctx.PropertyErrorf("src", "missing prebuilt source file")
|
}
|
}
|
|
func (p *PrebuiltEtc) SourceFilePath(ctx ModuleContext) Path {
|
return PathForModuleSrc(ctx, String(p.properties.Src))
|
}
|
|
// This allows other derivative modules (e.g. prebuilt_etc_xml) to perform
|
// additional steps (like validating the src) before the file is installed.
|
func (p *PrebuiltEtc) SetAdditionalDependencies(paths Paths) {
|
p.additionalDependencies = &paths
|
}
|
|
func (p *PrebuiltEtc) OutputFile() OutputPath {
|
return p.outputFilePath
|
}
|
|
func (p *PrebuiltEtc) SubDir() string {
|
return String(p.properties.Sub_dir)
|
}
|
|
func (p *PrebuiltEtc) Installable() bool {
|
return p.properties.Installable == nil || Bool(p.properties.Installable)
|
}
|
|
func (p *PrebuiltEtc) GenerateAndroidBuildActions(ctx ModuleContext) {
|
p.sourceFilePath = PathForModuleSrc(ctx, String(p.properties.Src))
|
filename := String(p.properties.Filename)
|
filename_from_src := Bool(p.properties.Filename_from_src)
|
if filename == "" {
|
if filename_from_src {
|
filename = p.sourceFilePath.Base()
|
} else {
|
filename = ctx.ModuleName()
|
}
|
} else if filename_from_src {
|
ctx.PropertyErrorf("filename_from_src", "filename is set. filename_from_src can't be true")
|
return
|
}
|
p.outputFilePath = PathForModuleOut(ctx, filename).OutputPath
|
p.installDirPath = PathForModuleInstall(ctx, p.installDirBase, String(p.properties.Sub_dir))
|
|
// This ensures that outputFilePath has the correct name for others to
|
// use, as the source file may have a different name.
|
ctx.Build(pctx, BuildParams{
|
Rule: Cp,
|
Output: p.outputFilePath,
|
Input: p.sourceFilePath,
|
})
|
}
|
|
func (p *PrebuiltEtc) AndroidMk() AndroidMkData {
|
return AndroidMkData{
|
Custom: func(w io.Writer, name, prefix, moduleDir string, data AndroidMkData) {
|
nameSuffix := ""
|
if p.inRecovery() && !p.onlyInRecovery() {
|
nameSuffix = ".recovery"
|
}
|
fmt.Fprintln(w, "\ninclude $(CLEAR_VARS)")
|
fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir)
|
fmt.Fprintln(w, "LOCAL_MODULE :=", name+nameSuffix)
|
fmt.Fprintln(w, "LOCAL_MODULE_CLASS := ETC")
|
if p.commonProperties.Owner != nil {
|
fmt.Fprintln(w, "LOCAL_MODULE_OWNER :=", *p.commonProperties.Owner)
|
}
|
fmt.Fprintln(w, "LOCAL_MODULE_TAGS := optional")
|
if p.Host() {
|
fmt.Fprintln(w, "LOCAL_IS_HOST_MODULE := true")
|
}
|
fmt.Fprintln(w, "LOCAL_PREBUILT_MODULE_FILE :=", p.outputFilePath.String())
|
fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", "$(OUT_DIR)/"+p.installDirPath.RelPathString())
|
fmt.Fprintln(w, "LOCAL_INSTALLED_MODULE_STEM :=", p.outputFilePath.Base())
|
fmt.Fprintln(w, "LOCAL_UNINSTALLABLE_MODULE :=", !p.Installable())
|
fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES :=", strings.Join(data.Required, " "))
|
fmt.Fprintln(w, "LOCAL_MODULE_TARGET_ARCH :=", p.Arch().ArchType.String())
|
if p.additionalDependencies != nil {
|
fmt.Fprint(w, "LOCAL_ADDITIONAL_DEPENDENCIES :=")
|
for _, path := range *p.additionalDependencies {
|
fmt.Fprint(w, " "+path.String())
|
}
|
fmt.Fprintln(w, "")
|
}
|
fmt.Fprintln(w, "include $(BUILD_PREBUILT)")
|
},
|
}
|
}
|
|
func InitPrebuiltEtcModule(p *PrebuiltEtc) {
|
p.AddProperties(&p.properties)
|
}
|
|
// prebuilt_etc is for a prebuilt artifact that is installed in
|
// <partition>/etc/<sub_dir> directory.
|
func PrebuiltEtcFactory() Module {
|
module := &PrebuiltEtc{installDirBase: "etc"}
|
InitPrebuiltEtcModule(module)
|
// This module is device-only
|
InitAndroidArchModule(module, DeviceSupported, MultilibFirst)
|
return module
|
}
|
|
// prebuilt_etc_host is for a host prebuilt artifact that is installed in
|
// $(HOST_OUT)/etc/<sub_dir> directory.
|
func PrebuiltEtcHostFactory() Module {
|
module := &PrebuiltEtc{installDirBase: "etc"}
|
InitPrebuiltEtcModule(module)
|
// This module is host-only
|
InitAndroidArchModule(module, HostSupported, MultilibCommon)
|
return module
|
}
|
|
// prebuilt_usr_share is for a prebuilt artifact that is installed in
|
// <partition>/usr/share/<sub_dir> directory.
|
func PrebuiltUserShareFactory() Module {
|
module := &PrebuiltEtc{installDirBase: "usr/share"}
|
InitPrebuiltEtcModule(module)
|
// This module is device-only
|
InitAndroidArchModule(module, DeviceSupported, MultilibFirst)
|
return module
|
}
|
|
// prebuild_usr_share_host is for a host prebuilt artifact that is installed in
|
// $(HOST_OUT)/usr/share/<sub_dir> directory.
|
func PrebuiltUserShareHostFactory() Module {
|
module := &PrebuiltEtc{installDirBase: "usr/share"}
|
InitPrebuiltEtcModule(module)
|
// This module is host-only
|
InitAndroidArchModule(module, HostSupported, MultilibCommon)
|
return module
|
}
|
|
const (
|
// coreMode is the variant for modules to be installed to system.
|
coreMode = "core"
|
|
// recoveryMode means a module to be installed to recovery image.
|
recoveryMode = "recovery"
|
)
|
|
// prebuiltEtcMutator creates the needed variants to install the module to
|
// system or recovery.
|
func prebuiltEtcMutator(mctx BottomUpMutatorContext) {
|
m, ok := mctx.Module().(*PrebuiltEtc)
|
if !ok || m.Host() {
|
return
|
}
|
|
var coreVariantNeeded bool = true
|
var recoveryVariantNeeded bool = false
|
if Bool(m.properties.Recovery_available) {
|
recoveryVariantNeeded = true
|
}
|
|
if m.ModuleBase.InstallInRecovery() {
|
recoveryVariantNeeded = true
|
coreVariantNeeded = false
|
}
|
|
var variants []string
|
if coreVariantNeeded {
|
variants = append(variants, coreMode)
|
}
|
if recoveryVariantNeeded {
|
variants = append(variants, recoveryMode)
|
}
|
mod := mctx.CreateVariations(variants...)
|
for i, v := range variants {
|
if v == recoveryMode {
|
m := mod[i].(*PrebuiltEtc)
|
m.properties.InRecovery = true
|
}
|
}
|
}
|
