2018-04-10 12:07:10 +08:00
|
|
|
// 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
|
|
|
|
|
2019-04-04 06:47:29 +08:00
|
|
|
import "strconv"
|
2018-04-10 12:07:10 +08:00
|
|
|
|
2019-02-13 21:50:33 +08:00
|
|
|
// TODO(jungw): Now that it handles more than the ones in etc/, consider renaming this file.
|
2018-04-10 12:07:10 +08:00
|
|
|
|
|
|
|
func init() {
|
|
|
|
RegisterModuleType("prebuilt_etc", PrebuiltEtcFactory)
|
2019-02-08 00:28:03 +08:00
|
|
|
RegisterModuleType("prebuilt_etc_host", PrebuiltEtcHostFactory)
|
2019-02-13 21:50:33 +08:00
|
|
|
RegisterModuleType("prebuilt_usr_share", PrebuiltUserShareFactory)
|
2019-02-23 07:47:57 +08:00
|
|
|
RegisterModuleType("prebuilt_usr_share_host", PrebuiltUserShareHostFactory)
|
2019-05-14 23:20:45 +08:00
|
|
|
RegisterModuleType("prebuilt_font", PrebuiltFontFactory)
|
2019-06-04 06:29:27 +08:00
|
|
|
RegisterModuleType("prebuilt_firmware", PrebuiltFirmwareFactory)
|
2018-04-10 12:07:10 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
type prebuiltEtcProperties struct {
|
|
|
|
// Source file of this prebuilt.
|
2019-03-05 14:35:41 +08:00
|
|
|
Src *string `android:"path,arch_variant"`
|
2018-04-10 12:07:10 +08:00
|
|
|
|
|
|
|
// optional subdirectory under which this file is installed into
|
|
|
|
Sub_dir *string `android:"arch_variant"`
|
2018-08-15 13:20:22 +08:00
|
|
|
|
2018-10-26 20:49:39 +08:00
|
|
|
// optional name for the installed file. If unspecified, name of the module is used as the file name
|
|
|
|
Filename *string `android:"arch_variant"`
|
|
|
|
|
2018-11-13 10:59:12 +08:00
|
|
|
// 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"`
|
|
|
|
|
2020-01-22 07:53:22 +08:00
|
|
|
// Make this module available when building for ramdisk.
|
|
|
|
Ramdisk_available *bool
|
|
|
|
|
2018-08-15 13:20:22 +08:00
|
|
|
// Make this module available when building for recovery.
|
|
|
|
Recovery_available *bool
|
|
|
|
|
2018-10-31 21:49:57 +08:00
|
|
|
// Whether this module is directly installable to one of the partitions. Default: true.
|
|
|
|
Installable *bool
|
2018-04-10 12:07:10 +08:00
|
|
|
}
|
|
|
|
|
2019-11-06 15:53:07 +08:00
|
|
|
type PrebuiltEtcModule interface {
|
|
|
|
Module
|
|
|
|
SubDir() string
|
|
|
|
OutputFile() OutputPath
|
|
|
|
}
|
|
|
|
|
2018-04-25 21:57:34 +08:00
|
|
|
type PrebuiltEtc struct {
|
2018-04-10 12:07:10 +08:00
|
|
|
ModuleBase
|
|
|
|
|
|
|
|
properties prebuiltEtcProperties
|
|
|
|
|
2019-02-13 21:50:33 +08:00
|
|
|
sourceFilePath Path
|
|
|
|
outputFilePath OutputPath
|
|
|
|
// The base install location, e.g. "etc" for prebuilt_etc, "usr/share" for prebuilt_usr_share.
|
2019-06-04 06:29:27 +08:00
|
|
|
installDirBase string
|
|
|
|
// The base install location when soc_specific property is set to true, e.g. "firmware" for prebuilt_firmware.
|
|
|
|
socInstallDirBase string
|
2019-10-02 13:05:35 +08:00
|
|
|
installDirPath InstallPath
|
2018-04-25 21:57:34 +08:00
|
|
|
additionalDependencies *Paths
|
2018-04-10 12:07:10 +08:00
|
|
|
}
|
|
|
|
|
2020-01-22 07:53:22 +08:00
|
|
|
func (p *PrebuiltEtc) inRamdisk() bool {
|
|
|
|
return p.ModuleBase.InRamdisk() || p.ModuleBase.InstallInRamdisk()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) onlyInRamdisk() bool {
|
|
|
|
return p.ModuleBase.InstallInRamdisk()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) InstallInRamdisk() bool {
|
|
|
|
return p.inRamdisk()
|
|
|
|
}
|
|
|
|
|
2018-08-15 13:20:22 +08:00
|
|
|
func (p *PrebuiltEtc) inRecovery() bool {
|
2019-11-19 08:00:16 +08:00
|
|
|
return p.ModuleBase.InRecovery() || p.ModuleBase.InstallInRecovery()
|
2018-08-15 13:20:22 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) onlyInRecovery() bool {
|
|
|
|
return p.ModuleBase.InstallInRecovery()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) InstallInRecovery() bool {
|
|
|
|
return p.inRecovery()
|
|
|
|
}
|
|
|
|
|
2019-11-19 08:00:16 +08:00
|
|
|
var _ ImageInterface = (*PrebuiltEtc)(nil)
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) ImageMutatorBegin(ctx BaseModuleContext) {}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) CoreVariantNeeded(ctx BaseModuleContext) bool {
|
2020-01-22 07:53:22 +08:00
|
|
|
return !p.ModuleBase.InstallInRecovery() && !p.ModuleBase.InstallInRamdisk()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) RamdiskVariantNeeded(ctx BaseModuleContext) bool {
|
|
|
|
return Bool(p.properties.Ramdisk_available) || p.ModuleBase.InstallInRamdisk()
|
2019-11-19 08:00:16 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) RecoveryVariantNeeded(ctx BaseModuleContext) bool {
|
|
|
|
return Bool(p.properties.Recovery_available) || p.ModuleBase.InstallInRecovery()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) ExtraImageVariations(ctx BaseModuleContext) []string {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) SetImageVariation(ctx BaseModuleContext, variation string, module Module) {
|
|
|
|
}
|
|
|
|
|
2018-04-25 21:57:34 +08:00
|
|
|
func (p *PrebuiltEtc) DepsMutator(ctx BottomUpMutatorContext) {
|
|
|
|
if p.properties.Src == nil {
|
|
|
|
ctx.PropertyErrorf("src", "missing prebuilt source file")
|
2018-04-10 12:07:10 +08:00
|
|
|
}
|
2018-04-25 21:57:34 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) SourceFilePath(ctx ModuleContext) Path {
|
2019-03-06 14:25:09 +08:00
|
|
|
return PathForModuleSrc(ctx, String(p.properties.Src))
|
2018-04-10 12:07:10 +08:00
|
|
|
}
|
|
|
|
|
2019-10-02 13:05:35 +08:00
|
|
|
func (p *PrebuiltEtc) InstallDirPath() InstallPath {
|
2019-07-22 14:48:36 +08:00
|
|
|
return p.installDirPath
|
|
|
|
}
|
|
|
|
|
2018-04-25 21:57:34 +08:00
|
|
|
// 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
|
|
|
|
}
|
|
|
|
|
2018-10-04 19:27:15 +08:00
|
|
|
func (p *PrebuiltEtc) OutputFile() OutputPath {
|
|
|
|
return p.outputFilePath
|
|
|
|
}
|
|
|
|
|
|
|
|
func (p *PrebuiltEtc) SubDir() string {
|
|
|
|
return String(p.properties.Sub_dir)
|
|
|
|
}
|
|
|
|
|
2018-10-31 21:49:57 +08:00
|
|
|
func (p *PrebuiltEtc) Installable() bool {
|
|
|
|
return p.properties.Installable == nil || Bool(p.properties.Installable)
|
|
|
|
}
|
|
|
|
|
2018-04-25 21:57:34 +08:00
|
|
|
func (p *PrebuiltEtc) GenerateAndroidBuildActions(ctx ModuleContext) {
|
2019-03-06 14:25:09 +08:00
|
|
|
p.sourceFilePath = PathForModuleSrc(ctx, String(p.properties.Src))
|
2018-10-26 20:49:39 +08:00
|
|
|
filename := String(p.properties.Filename)
|
2018-11-13 10:59:12 +08:00
|
|
|
filename_from_src := Bool(p.properties.Filename_from_src)
|
2018-10-26 20:49:39 +08:00
|
|
|
if filename == "" {
|
2018-11-13 10:59:12 +08:00
|
|
|
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
|
2018-10-26 20:49:39 +08:00
|
|
|
}
|
|
|
|
p.outputFilePath = PathForModuleOut(ctx, filename).OutputPath
|
2019-06-04 06:29:27 +08:00
|
|
|
|
|
|
|
// If soc install dir was specified and SOC specific is set, set the installDirPath to the specified
|
|
|
|
// socInstallDirBase.
|
|
|
|
installBaseDir := p.installDirBase
|
|
|
|
if ctx.SocSpecific() && p.socInstallDirBase != "" {
|
|
|
|
installBaseDir = p.socInstallDirBase
|
|
|
|
}
|
|
|
|
p.installDirPath = PathForModuleInstall(ctx, installBaseDir, String(p.properties.Sub_dir))
|
2018-10-04 19:27:15 +08:00
|
|
|
|
2019-01-26 08:04:11 +08:00
|
|
|
// This ensures that outputFilePath has the correct name for others to
|
|
|
|
// use, as the source file may have a different name.
|
2018-10-04 19:27:15 +08:00
|
|
|
ctx.Build(pctx, BuildParams{
|
|
|
|
Rule: Cp,
|
|
|
|
Output: p.outputFilePath,
|
|
|
|
Input: p.sourceFilePath,
|
|
|
|
})
|
2018-04-10 12:07:10 +08:00
|
|
|
}
|
|
|
|
|
2019-12-03 12:24:29 +08:00
|
|
|
func (p *PrebuiltEtc) AndroidMkEntries() []AndroidMkEntries {
|
2019-04-04 06:47:29 +08:00
|
|
|
nameSuffix := ""
|
2020-01-22 07:53:22 +08:00
|
|
|
if p.inRamdisk() && !p.onlyInRamdisk() {
|
|
|
|
nameSuffix = ".ramdisk"
|
|
|
|
}
|
2019-04-04 06:47:29 +08:00
|
|
|
if p.inRecovery() && !p.onlyInRecovery() {
|
|
|
|
nameSuffix = ".recovery"
|
|
|
|
}
|
2019-12-03 12:24:29 +08:00
|
|
|
return []AndroidMkEntries{AndroidMkEntries{
|
2019-04-04 06:47:29 +08:00
|
|
|
Class: "ETC",
|
|
|
|
SubName: nameSuffix,
|
|
|
|
OutputFile: OptionalPathForPath(p.outputFilePath),
|
2019-08-28 08:33:16 +08:00
|
|
|
ExtraEntries: []AndroidMkExtraEntriesFunc{
|
|
|
|
func(entries *AndroidMkEntries) {
|
|
|
|
entries.SetString("LOCAL_MODULE_TAGS", "optional")
|
2019-10-03 07:01:35 +08:00
|
|
|
entries.SetString("LOCAL_MODULE_PATH", p.installDirPath.ToMakePath().String())
|
2019-08-28 08:33:16 +08:00
|
|
|
entries.SetString("LOCAL_INSTALLED_MODULE_STEM", p.outputFilePath.Base())
|
|
|
|
entries.SetString("LOCAL_UNINSTALLABLE_MODULE", strconv.FormatBool(!p.Installable()))
|
|
|
|
if p.additionalDependencies != nil {
|
|
|
|
for _, path := range *p.additionalDependencies {
|
|
|
|
entries.SetString("LOCAL_ADDITIONAL_DEPENDENCIES", path.String())
|
|
|
|
}
|
2018-04-25 21:57:34 +08:00
|
|
|
}
|
2019-08-28 08:33:16 +08:00
|
|
|
},
|
2018-04-10 12:07:10 +08:00
|
|
|
},
|
2019-12-03 12:24:29 +08:00
|
|
|
}}
|
2018-04-10 12:07:10 +08:00
|
|
|
}
|
|
|
|
|
2019-07-22 14:48:36 +08:00
|
|
|
func InitPrebuiltEtcModule(p *PrebuiltEtc, dirBase string) {
|
|
|
|
p.installDirBase = dirBase
|
2018-04-25 21:57:34 +08:00
|
|
|
p.AddProperties(&p.properties)
|
|
|
|
}
|
2018-04-10 12:07:10 +08:00
|
|
|
|
2019-03-12 06:58:50 +08:00
|
|
|
// prebuilt_etc is for a prebuilt artifact that is installed in
|
|
|
|
// <partition>/etc/<sub_dir> directory.
|
2018-04-25 21:57:34 +08:00
|
|
|
func PrebuiltEtcFactory() Module {
|
2019-07-22 14:48:36 +08:00
|
|
|
module := &PrebuiltEtc{}
|
|
|
|
InitPrebuiltEtcModule(module, "etc")
|
2018-04-25 21:57:34 +08:00
|
|
|
// This module is device-only
|
2019-01-16 02:47:05 +08:00
|
|
|
InitAndroidArchModule(module, DeviceSupported, MultilibFirst)
|
2018-04-10 12:07:10 +08:00
|
|
|
return module
|
|
|
|
}
|
2018-08-15 13:20:22 +08:00
|
|
|
|
2019-03-12 06:58:50 +08:00
|
|
|
// prebuilt_etc_host is for a host prebuilt artifact that is installed in
|
|
|
|
// $(HOST_OUT)/etc/<sub_dir> directory.
|
2019-02-08 00:28:03 +08:00
|
|
|
func PrebuiltEtcHostFactory() Module {
|
2019-07-22 14:48:36 +08:00
|
|
|
module := &PrebuiltEtc{}
|
|
|
|
InitPrebuiltEtcModule(module, "etc")
|
2019-02-05 06:34:10 +08:00
|
|
|
// This module is host-only
|
|
|
|
InitAndroidArchModule(module, HostSupported, MultilibCommon)
|
|
|
|
return module
|
2019-02-13 21:50:33 +08:00
|
|
|
}
|
|
|
|
|
2019-03-12 06:58:50 +08:00
|
|
|
// prebuilt_usr_share is for a prebuilt artifact that is installed in
|
|
|
|
// <partition>/usr/share/<sub_dir> directory.
|
2019-02-13 21:50:33 +08:00
|
|
|
func PrebuiltUserShareFactory() Module {
|
2019-07-22 14:48:36 +08:00
|
|
|
module := &PrebuiltEtc{}
|
|
|
|
InitPrebuiltEtcModule(module, "usr/share")
|
2019-02-13 21:50:33 +08:00
|
|
|
// This module is device-only
|
|
|
|
InitAndroidArchModule(module, DeviceSupported, MultilibFirst)
|
|
|
|
return module
|
2019-02-23 07:47:57 +08:00
|
|
|
}
|
|
|
|
|
2019-03-12 06:58:50 +08:00
|
|
|
// prebuild_usr_share_host is for a host prebuilt artifact that is installed in
|
|
|
|
// $(HOST_OUT)/usr/share/<sub_dir> directory.
|
2019-02-23 07:47:57 +08:00
|
|
|
func PrebuiltUserShareHostFactory() Module {
|
2019-07-22 14:48:36 +08:00
|
|
|
module := &PrebuiltEtc{}
|
|
|
|
InitPrebuiltEtcModule(module, "usr/share")
|
2019-02-23 07:47:57 +08:00
|
|
|
// This module is host-only
|
|
|
|
InitAndroidArchModule(module, HostSupported, MultilibCommon)
|
|
|
|
return module
|
2019-02-05 06:34:10 +08:00
|
|
|
}
|
|
|
|
|
2019-05-14 23:20:45 +08:00
|
|
|
// prebuilt_font installs a font in <partition>/fonts directory.
|
|
|
|
func PrebuiltFontFactory() Module {
|
2019-07-22 14:48:36 +08:00
|
|
|
module := &PrebuiltEtc{}
|
|
|
|
InitPrebuiltEtcModule(module, "fonts")
|
2019-05-14 23:20:45 +08:00
|
|
|
// This module is device-only
|
|
|
|
InitAndroidArchModule(module, DeviceSupported, MultilibFirst)
|
|
|
|
return module
|
|
|
|
}
|
2019-06-04 06:29:27 +08:00
|
|
|
|
|
|
|
// prebuilt_firmware installs a firmware file to <partition>/etc/firmware directory for system image.
|
|
|
|
// If soc_specific property is set to true, the firmware file is installed to the vendor <partition>/firmware
|
|
|
|
// directory for vendor image.
|
|
|
|
func PrebuiltFirmwareFactory() Module {
|
2019-07-22 14:48:36 +08:00
|
|
|
module := &PrebuiltEtc{}
|
|
|
|
module.socInstallDirBase = "firmware"
|
|
|
|
InitPrebuiltEtcModule(module, "etc/firmware")
|
2019-06-04 06:29:27 +08:00
|
|
|
// This module is device-only
|
|
|
|
InitAndroidArchModule(module, DeviceSupported, MultilibFirst)
|
|
|
|
return module
|
|
|
|
}
|