0fe7866897
This allows Soong (Go) plugins to get custom configurations set in the
current product's BoardConfig.mk.
I'll have some more comprehensive documentation later, but the general
concept is that you'd have one namespace per plugin, defined in the
BoardConfig.mk (though they would work in the product.mk files too):
SOONG_CONFIG_NAMESPACES += myPlugin
Within that namespace you can set key-value pairs:
SOONG_CONFIG_myPlugin := key1 key2 ...
...
SOONG_CONFIG_myPlugin_key1 := value
...
SOONG_CONFIG_myPlugin_key2 := true
Then in your plugin, you can ask for your namespace:
vars := ctx.Config().VendorConfig("myPlugin")
And then use them:
str := vars.String("key1")
if vars.Bool("key2") { ... }
if vars.IsSet("key3") { ... }
Warning: It's not a good idea to fail on missing inputs, since an
android tree may contain plugins from multiple owners, and we may
configure your modules (but not build/install them) even if they're not
meant for the currently configured product.
Bug: 76168832
Test: define some variables, use them
Test: m blueprint_tools
Change-Id: I4c38f5a4344022c6f332de279d9bbef24502e741
397 lines
12 KiB
Go
397 lines
12 KiB
Go
// Copyright 2015 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"
|
|
"reflect"
|
|
"runtime"
|
|
"strings"
|
|
|
|
"github.com/google/blueprint/proptools"
|
|
)
|
|
|
|
func init() {
|
|
PreDepsMutators(func(ctx RegisterMutatorsContext) {
|
|
ctx.BottomUp("variable", variableMutator).Parallel()
|
|
})
|
|
}
|
|
|
|
type variableProperties struct {
|
|
Product_variables struct {
|
|
Platform_sdk_version struct {
|
|
Asflags []string
|
|
Cflags []string
|
|
}
|
|
|
|
// unbundled_build is a catch-all property to annotate modules that don't build in one or
|
|
// more unbundled branches, usually due to dependencies missing from the manifest.
|
|
Unbundled_build struct {
|
|
Enabled *bool `android:"arch_variant"`
|
|
} `android:"arch_variant"`
|
|
|
|
Malloc_not_svelte struct {
|
|
Cflags []string
|
|
}
|
|
|
|
Safestack struct {
|
|
Cflags []string `android:"arch_variant"`
|
|
} `android:"arch_variant"`
|
|
|
|
Binder32bit struct {
|
|
Cflags []string
|
|
}
|
|
|
|
Device_uses_hwc2 struct {
|
|
Cflags []string
|
|
}
|
|
|
|
Override_rs_driver struct {
|
|
Cflags []string
|
|
}
|
|
|
|
// treble_linker_namespaces is true when the system/vendor linker namespace separation is
|
|
// enabled.
|
|
Treble_linker_namespaces struct {
|
|
Cflags []string
|
|
}
|
|
// enforce_vintf_manifest is true when a device is required to have a vintf manifest.
|
|
Enforce_vintf_manifest struct {
|
|
Cflags []string
|
|
}
|
|
|
|
// debuggable is true for eng and userdebug builds, and can be used to turn on additional
|
|
// debugging features that don't significantly impact runtime behavior. userdebug builds
|
|
// are used for dogfooding and performance testing, and should be as similar to user builds
|
|
// as possible.
|
|
Debuggable struct {
|
|
Cflags []string
|
|
Cppflags []string
|
|
Init_rc []string
|
|
}
|
|
|
|
// eng is true for -eng builds, and can be used to turn on additionaly heavyweight debugging
|
|
// features.
|
|
Eng struct {
|
|
Cflags []string
|
|
Cppflags []string
|
|
}
|
|
|
|
Pdk struct {
|
|
Enabled *bool `android:"arch_variant"`
|
|
} `android:"arch_variant"`
|
|
|
|
Uml struct {
|
|
Cppflags []string
|
|
}
|
|
} `android:"arch_variant"`
|
|
}
|
|
|
|
var zeroProductVariables variableProperties
|
|
|
|
type productVariables struct {
|
|
// Suffix to add to generated Makefiles
|
|
Make_suffix *string `json:",omitempty"`
|
|
|
|
BuildId *string `json:",omitempty"`
|
|
BuildNumberFromFile *string `json:",omitempty"`
|
|
DateFromFile *string `json:",omitempty"`
|
|
|
|
Platform_sdk_version *int `json:",omitempty"`
|
|
Platform_sdk_final *bool `json:",omitempty"`
|
|
Platform_version_active_codenames []string `json:",omitempty"`
|
|
Platform_version_future_codenames []string `json:",omitempty"`
|
|
Platform_vndk_version *string `json:",omitempty"`
|
|
Platform_systemsdk_versions []string `json:",omitempty"`
|
|
|
|
DeviceName *string `json:",omitempty"`
|
|
DeviceArch *string `json:",omitempty"`
|
|
DeviceArchVariant *string `json:",omitempty"`
|
|
DeviceCpuVariant *string `json:",omitempty"`
|
|
DeviceAbi *[]string `json:",omitempty"`
|
|
DeviceVndkVersion *string `json:",omitempty"`
|
|
DeviceSystemSdkVersions *[]string `json:",omitempty"`
|
|
|
|
DeviceSecondaryArch *string `json:",omitempty"`
|
|
DeviceSecondaryArchVariant *string `json:",omitempty"`
|
|
DeviceSecondaryCpuVariant *string `json:",omitempty"`
|
|
DeviceSecondaryAbi *[]string `json:",omitempty"`
|
|
|
|
HostArch *string `json:",omitempty"`
|
|
HostSecondaryArch *string `json:",omitempty"`
|
|
|
|
CrossHost *string `json:",omitempty"`
|
|
CrossHostArch *string `json:",omitempty"`
|
|
CrossHostSecondaryArch *string `json:",omitempty"`
|
|
|
|
ResourceOverlays *[]string `json:",omitempty"`
|
|
EnforceRROTargets *[]string `json:",omitempty"`
|
|
EnforceRROExcludedOverlays *[]string `json:",omitempty"`
|
|
|
|
AAPTCharacteristics *string `json:",omitempty"`
|
|
AAPTConfig *[]string `json:",omitempty"`
|
|
AAPTPreferredConfig *string `json:",omitempty"`
|
|
AAPTPrebuiltDPI *[]string `json:",omitempty"`
|
|
|
|
DefaultAppCertificate *string `json:",omitempty"`
|
|
|
|
AppsDefaultVersionName *string `json:",omitempty"`
|
|
|
|
Allow_missing_dependencies *bool `json:",omitempty"`
|
|
Unbundled_build *bool `json:",omitempty"`
|
|
Malloc_not_svelte *bool `json:",omitempty"`
|
|
Safestack *bool `json:",omitempty"`
|
|
HostStaticBinaries *bool `json:",omitempty"`
|
|
Binder32bit *bool `json:",omitempty"`
|
|
UseGoma *bool `json:",omitempty"`
|
|
Debuggable *bool `json:",omitempty"`
|
|
Eng *bool `json:",omitempty"`
|
|
Device_uses_hwc2 *bool `json:",omitempty"`
|
|
Treble_linker_namespaces *bool `json:",omitempty"`
|
|
Sepolicy_split *bool `json:",omitempty"`
|
|
Enforce_vintf_manifest *bool `json:",omitempty"`
|
|
Pdk *bool `json:",omitempty"`
|
|
Uml *bool `json:",omitempty"`
|
|
MinimizeJavaDebugInfo *bool `json:",omitempty"`
|
|
|
|
IntegerOverflowExcludePaths *[]string `json:",omitempty"`
|
|
|
|
EnableCFI *bool `json:",omitempty"`
|
|
CFIExcludePaths *[]string `json:",omitempty"`
|
|
CFIIncludePaths *[]string `json:",omitempty"`
|
|
|
|
VendorPath *string `json:",omitempty"`
|
|
OdmPath *string `json:",omitempty"`
|
|
ProductPath *string `json:",omitempty"`
|
|
|
|
ClangTidy *bool `json:",omitempty"`
|
|
TidyChecks *string `json:",omitempty"`
|
|
|
|
NativeCoverage *bool `json:",omitempty"`
|
|
CoveragePaths *[]string `json:",omitempty"`
|
|
CoverageExcludePaths *[]string `json:",omitempty"`
|
|
|
|
DevicePrefer32BitExecutables *bool `json:",omitempty"`
|
|
HostPrefer32BitExecutables *bool `json:",omitempty"`
|
|
|
|
SanitizeHost []string `json:",omitempty"`
|
|
SanitizeDevice []string `json:",omitempty"`
|
|
SanitizeDeviceDiag []string `json:",omitempty"`
|
|
SanitizeDeviceArch []string `json:",omitempty"`
|
|
|
|
ArtUseReadBarrier *bool `json:",omitempty"`
|
|
|
|
BtConfigIncludeDir *string `json:",omitempty"`
|
|
|
|
Override_rs_driver *string `json:",omitempty"`
|
|
|
|
DeviceKernelHeaders []string `json:",omitempty"`
|
|
DistDir *string `json:",omitempty"`
|
|
|
|
ExtraVndkVersions []string `json:",omitempty"`
|
|
|
|
NamespacesToExport []string `json:",omitempty"`
|
|
|
|
PgoAdditionalProfileDirs []string `json:",omitempty"`
|
|
|
|
VendorVars map[string]map[string]string `json:",omitempty"`
|
|
}
|
|
|
|
func boolPtr(v bool) *bool {
|
|
return &v
|
|
}
|
|
|
|
func intPtr(v int) *int {
|
|
return &v
|
|
}
|
|
|
|
func stringPtr(v string) *string {
|
|
return &v
|
|
}
|
|
|
|
func (v *productVariables) SetDefaultConfig() {
|
|
*v = productVariables{
|
|
Platform_sdk_version: intPtr(26),
|
|
Platform_version_active_codenames: []string{"P"},
|
|
Platform_version_future_codenames: []string{"P"},
|
|
|
|
HostArch: stringPtr("x86_64"),
|
|
HostSecondaryArch: stringPtr("x86"),
|
|
DeviceName: stringPtr("generic_arm64"),
|
|
DeviceArch: stringPtr("arm64"),
|
|
DeviceArchVariant: stringPtr("armv8-a"),
|
|
DeviceCpuVariant: stringPtr("generic"),
|
|
DeviceAbi: &[]string{"arm64-v8a"},
|
|
DeviceSecondaryArch: stringPtr("arm"),
|
|
DeviceSecondaryArchVariant: stringPtr("armv8-a"),
|
|
DeviceSecondaryCpuVariant: stringPtr("generic"),
|
|
DeviceSecondaryAbi: &[]string{"armeabi-v7a", "armeabi"},
|
|
|
|
AAPTConfig: &[]string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
|
|
AAPTPreferredConfig: stringPtr("xhdpi"),
|
|
AAPTCharacteristics: stringPtr("nosdcard"),
|
|
AAPTPrebuiltDPI: &[]string{"xhdpi", "xxhdpi"},
|
|
|
|
Malloc_not_svelte: boolPtr(true),
|
|
Safestack: boolPtr(false),
|
|
}
|
|
|
|
if runtime.GOOS == "linux" {
|
|
v.CrossHost = stringPtr("windows")
|
|
v.CrossHostArch = stringPtr("x86")
|
|
v.CrossHostSecondaryArch = stringPtr("x86_64")
|
|
}
|
|
}
|
|
|
|
func variableMutator(mctx BottomUpMutatorContext) {
|
|
var module Module
|
|
var ok bool
|
|
if module, ok = mctx.Module().(Module); !ok {
|
|
return
|
|
}
|
|
|
|
// TODO: depend on config variable, create variants, propagate variants up tree
|
|
a := module.base()
|
|
variableValues := reflect.ValueOf(&a.variableProperties.Product_variables).Elem()
|
|
zeroValues := reflect.ValueOf(zeroProductVariables.Product_variables)
|
|
|
|
for i := 0; i < variableValues.NumField(); i++ {
|
|
variableValue := variableValues.Field(i)
|
|
zeroValue := zeroValues.Field(i)
|
|
name := variableValues.Type().Field(i).Name
|
|
property := "product_variables." + proptools.PropertyNameForField(name)
|
|
|
|
// Check that the variable was set for the product
|
|
val := reflect.ValueOf(mctx.Config().productVariables).FieldByName(name)
|
|
if !val.IsValid() || val.Kind() != reflect.Ptr || val.IsNil() {
|
|
continue
|
|
}
|
|
|
|
val = val.Elem()
|
|
|
|
// For bools, check that the value is true
|
|
if val.Kind() == reflect.Bool && val.Bool() == false {
|
|
continue
|
|
}
|
|
|
|
// Check if any properties were set for the module
|
|
if reflect.DeepEqual(variableValue.Interface(), zeroValue.Interface()) {
|
|
continue
|
|
}
|
|
|
|
a.setVariableProperties(mctx, property, variableValue, val.Interface())
|
|
}
|
|
}
|
|
|
|
func (a *ModuleBase) setVariableProperties(ctx BottomUpMutatorContext,
|
|
prefix string, productVariablePropertyValue reflect.Value, variableValue interface{}) {
|
|
|
|
printfIntoProperties(ctx, prefix, productVariablePropertyValue, variableValue)
|
|
|
|
err := proptools.AppendMatchingProperties(a.generalProperties,
|
|
productVariablePropertyValue.Addr().Interface(), nil)
|
|
if err != nil {
|
|
if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
|
|
ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
|
|
} else {
|
|
panic(err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func printfIntoPropertiesError(ctx BottomUpMutatorContext, prefix string,
|
|
productVariablePropertyValue reflect.Value, i int, err error) {
|
|
|
|
field := productVariablePropertyValue.Type().Field(i).Name
|
|
property := prefix + "." + proptools.PropertyNameForField(field)
|
|
ctx.PropertyErrorf(property, "%s", err)
|
|
}
|
|
|
|
func printfIntoProperties(ctx BottomUpMutatorContext, prefix string,
|
|
productVariablePropertyValue reflect.Value, variableValue interface{}) {
|
|
|
|
for i := 0; i < productVariablePropertyValue.NumField(); i++ {
|
|
propertyValue := productVariablePropertyValue.Field(i)
|
|
kind := propertyValue.Kind()
|
|
if kind == reflect.Ptr {
|
|
if propertyValue.IsNil() {
|
|
continue
|
|
}
|
|
propertyValue = propertyValue.Elem()
|
|
}
|
|
switch propertyValue.Kind() {
|
|
case reflect.String:
|
|
err := printfIntoProperty(propertyValue, variableValue)
|
|
if err != nil {
|
|
printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
|
|
}
|
|
case reflect.Slice:
|
|
for j := 0; j < propertyValue.Len(); j++ {
|
|
err := printfIntoProperty(propertyValue.Index(j), variableValue)
|
|
if err != nil {
|
|
printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
|
|
}
|
|
}
|
|
case reflect.Bool:
|
|
// Nothing
|
|
case reflect.Struct:
|
|
printfIntoProperties(ctx, prefix, propertyValue, variableValue)
|
|
default:
|
|
panic(fmt.Errorf("unsupported field kind %q", propertyValue.Kind()))
|
|
}
|
|
}
|
|
}
|
|
|
|
func printfIntoProperty(propertyValue reflect.Value, variableValue interface{}) error {
|
|
s := propertyValue.String()
|
|
|
|
count := strings.Count(s, "%")
|
|
if count == 0 {
|
|
return nil
|
|
}
|
|
|
|
if count > 1 {
|
|
return fmt.Errorf("product variable properties only support a single '%%'")
|
|
}
|
|
|
|
if strings.Contains(s, "%d") {
|
|
switch v := variableValue.(type) {
|
|
case int:
|
|
// Nothing
|
|
case bool:
|
|
if v {
|
|
variableValue = 1
|
|
} else {
|
|
variableValue = 0
|
|
}
|
|
default:
|
|
return fmt.Errorf("unsupported type %T for %%d", variableValue)
|
|
}
|
|
} else if strings.Contains(s, "%s") {
|
|
switch variableValue.(type) {
|
|
case string:
|
|
// Nothing
|
|
default:
|
|
return fmt.Errorf("unsupported type %T for %%s", variableValue)
|
|
}
|
|
} else {
|
|
return fmt.Errorf("unsupported %% in product variable property")
|
|
}
|
|
|
|
propertyValue.Set(reflect.ValueOf(fmt.Sprintf(s, variableValue)))
|
|
|
|
return nil
|
|
}
|