Files
build_soong/android/soongconfig/modules.go
Jingwen Chen 01812020c1 Add support for writing all Soong config variables into @soong_injection.
Also remove the need to use bp2build_available on
soong_config_module_types as we want to convert every single of them
into the tree for a complete soong_injection soong_config_variables.bzl
file.

The variables are split into their bool, value and string types
respectively, as they all need to be handled differently on the Bazel
product_platform side, as well as for generating constraint values and
settings. For example, value variables need to integrate with
TemplateVariableInfo, and string variables need to include the string
value itself into the select key/constraint value.

Sample soong_config_variables.bzl file: https://gist.github.com/jin/cef700bfb20c8656a931306dd71d47e1

Test: CI
Bug: 198556411
Change-Id: I8665dd1269a507edb37de62407ed3641564bea5c
2021-11-23 08:37:30 +00:00

845 lines
24 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 soongconfig
import (
"fmt"
"io"
"reflect"
"sort"
"strings"
"github.com/google/blueprint"
"github.com/google/blueprint/parser"
"github.com/google/blueprint/proptools"
)
const conditionsDefault = "conditions_default"
var SoongConfigProperty = proptools.FieldNameForProperty("soong_config_variables")
// loadSoongConfigModuleTypeDefinition loads module types from an Android.bp file. It caches the
// result so each file is only parsed once.
func Parse(r io.Reader, from string) (*SoongConfigDefinition, []error) {
scope := parser.NewScope(nil)
file, errs := parser.ParseAndEval(from, r, scope)
if len(errs) > 0 {
return nil, errs
}
mtDef := &SoongConfigDefinition{
ModuleTypes: make(map[string]*ModuleType),
variables: make(map[string]soongConfigVariable),
}
for _, def := range file.Defs {
switch def := def.(type) {
case *parser.Module:
newErrs := processImportModuleDef(mtDef, def)
if len(newErrs) > 0 {
errs = append(errs, newErrs...)
}
case *parser.Assignment:
// Already handled via Scope object
default:
panic("unknown definition type")
}
}
if len(errs) > 0 {
return nil, errs
}
for name, moduleType := range mtDef.ModuleTypes {
for _, varName := range moduleType.variableNames {
if v, ok := mtDef.variables[varName]; ok {
moduleType.Variables = append(moduleType.Variables, v)
} else {
return nil, []error{
fmt.Errorf("unknown variable %q in module type %q", varName, name),
}
}
}
}
return mtDef, nil
}
func processImportModuleDef(v *SoongConfigDefinition, def *parser.Module) (errs []error) {
switch def.Type {
case "soong_config_module_type":
return processModuleTypeDef(v, def)
case "soong_config_string_variable":
return processStringVariableDef(v, def)
case "soong_config_bool_variable":
return processBoolVariableDef(v, def)
default:
// Unknown module types will be handled when the file is parsed as a normal
// Android.bp file.
}
return nil
}
type ModuleTypeProperties struct {
// the name of the new module type. Unlike most modules, this name does not need to be unique,
// although only one module type with any name will be importable into an Android.bp file.
Name string
// the module type that this module type will extend.
Module_type string
// the SOONG_CONFIG_NAMESPACE value from a BoardConfig.mk that this module type will read
// configuration variables from.
Config_namespace string
// the list of SOONG_CONFIG variables that this module type will read
Variables []string
// the list of boolean SOONG_CONFIG variables that this module type will read
Bool_variables []string
// the list of SOONG_CONFIG variables that this module type will read. The value will be
// inserted into the properties with %s substitution.
Value_variables []string
// the list of properties that this module type will extend.
Properties []string
}
func processModuleTypeDef(v *SoongConfigDefinition, def *parser.Module) (errs []error) {
props := &ModuleTypeProperties{}
_, errs = proptools.UnpackProperties(def.Properties, props)
if len(errs) > 0 {
return errs
}
if props.Name == "" {
errs = append(errs, fmt.Errorf("name property must be set"))
}
if props.Config_namespace == "" {
errs = append(errs, fmt.Errorf("config_namespace property must be set"))
}
if props.Module_type == "" {
errs = append(errs, fmt.Errorf("module_type property must be set"))
}
if len(errs) > 0 {
return errs
}
if mt, errs := newModuleType(props); len(errs) > 0 {
return errs
} else {
v.ModuleTypes[props.Name] = mt
}
return nil
}
type VariableProperties struct {
Name string
}
type StringVariableProperties struct {
Values []string
}
func processStringVariableDef(v *SoongConfigDefinition, def *parser.Module) (errs []error) {
stringProps := &StringVariableProperties{}
base, errs := processVariableDef(def, stringProps)
if len(errs) > 0 {
return errs
}
if len(stringProps.Values) == 0 {
return []error{fmt.Errorf("values property must be set")}
}
for _, name := range stringProps.Values {
if err := checkVariableName(name); err != nil {
return []error{fmt.Errorf("soong_config_string_variable: values property error %s", err)}
}
}
v.variables[base.variable] = &stringVariable{
baseVariable: base,
values: CanonicalizeToProperties(stringProps.Values),
}
return nil
}
func processBoolVariableDef(v *SoongConfigDefinition, def *parser.Module) (errs []error) {
base, errs := processVariableDef(def)
if len(errs) > 0 {
return errs
}
v.variables[base.variable] = &boolVariable{
baseVariable: base,
}
return nil
}
func processVariableDef(def *parser.Module,
extraProps ...interface{}) (cond baseVariable, errs []error) {
props := &VariableProperties{}
allProps := append([]interface{}{props}, extraProps...)
_, errs = proptools.UnpackProperties(def.Properties, allProps...)
if len(errs) > 0 {
return baseVariable{}, errs
}
if props.Name == "" {
return baseVariable{}, []error{fmt.Errorf("name property must be set")}
}
return baseVariable{
variable: props.Name,
}, nil
}
type SoongConfigDefinition struct {
ModuleTypes map[string]*ModuleType
variables map[string]soongConfigVariable
}
// Bp2BuildSoongConfigDefinition keeps a global record of all soong config
// string vars, bool vars and value vars created by every
// soong_config_module_type in this build.
type Bp2BuildSoongConfigDefinitions struct {
StringVars map[string]map[string]bool
BoolVars map[string]bool
ValueVars map[string]bool
}
// SoongConfigVariablesForBp2build extracts information from a
// SoongConfigDefinition that bp2build needs to generate constraint settings and
// values for, in order to migrate soong_config_module_type usages to Bazel.
func (defs *Bp2BuildSoongConfigDefinitions) AddVars(mtDef SoongConfigDefinition) {
if defs.StringVars == nil {
defs.StringVars = make(map[string]map[string]bool)
}
if defs.BoolVars == nil {
defs.BoolVars = make(map[string]bool)
}
if defs.ValueVars == nil {
defs.ValueVars = make(map[string]bool)
}
for _, moduleType := range mtDef.ModuleTypes {
for _, v := range moduleType.Variables {
key := strings.Join([]string{moduleType.ConfigNamespace, v.variableProperty()}, "__")
if strVar, ok := v.(*stringVariable); ok {
if _, ok := defs.StringVars[key]; !ok {
defs.StringVars[key] = make(map[string]bool, 0)
}
for _, value := range strVar.values {
defs.StringVars[key][value] = true
}
} else if _, ok := v.(*boolVariable); ok {
defs.BoolVars[key] = true
} else if _, ok := v.(*valueVariable); ok {
defs.ValueVars[key] = true
} else {
panic(fmt.Errorf("Unsupported variable type: %+v", v))
}
}
}
}
// This is a copy of the one available in soong/android/util.go, but depending
// on the android package causes a cyclic dependency. A refactoring here is to
// extract common utils out from android/utils.go for other packages like this.
func sortedStringKeys(m interface{}) []string {
v := reflect.ValueOf(m)
if v.Kind() != reflect.Map {
panic(fmt.Sprintf("%#v is not a map", m))
}
keys := v.MapKeys()
s := make([]string, 0, len(keys))
for _, key := range keys {
s = append(s, key.String())
}
sort.Strings(s)
return s
}
// String emits the Soong config variable definitions as Starlark dictionaries.
func (defs Bp2BuildSoongConfigDefinitions) String() string {
ret := ""
ret += "soong_config_bool_variables = {\n"
for _, boolVar := range sortedStringKeys(defs.BoolVars) {
ret += fmt.Sprintf(" \"%s\": True,\n", boolVar)
}
ret += "}\n"
ret += "\n"
ret += "soong_config_value_variables = {\n"
for _, valueVar := range sortedStringKeys(defs.ValueVars) {
ret += fmt.Sprintf(" \"%s\": True,\n", valueVar)
}
ret += "}\n"
ret += "\n"
ret += "soong_config_string_variables = {\n"
for _, stringVar := range sortedStringKeys(defs.StringVars) {
ret += fmt.Sprintf(" \"%s\": [\n", stringVar)
for _, choice := range sortedStringKeys(defs.StringVars[stringVar]) {
ret += fmt.Sprintf(" \"%s\",\n", choice)
}
ret += fmt.Sprintf(" ],\n")
}
ret += "}"
return ret
}
// CreateProperties returns a reflect.Value of a newly constructed type that contains the desired
// property layout for the Soong config variables, with each possible value an interface{} that
// contains a nil pointer to another newly constructed type that contains the affectable properties.
// The reflect.Value will be cloned for each call to the Soong config module type's factory method.
//
// For example, the acme_cc_defaults example above would
// produce a reflect.Value whose type is:
// *struct {
// Soong_config_variables struct {
// Board struct {
// Soc_a interface{}
// Soc_b interface{}
// }
// }
// }
// And whose value is:
// &{
// Soong_config_variables: {
// Board: {
// Soc_a: (*struct{ Cflags []string })(nil),
// Soc_b: (*struct{ Cflags []string })(nil),
// },
// },
// }
func CreateProperties(factory blueprint.ModuleFactory, moduleType *ModuleType) reflect.Value {
var fields []reflect.StructField
_, factoryProps := factory()
affectablePropertiesType := createAffectablePropertiesType(moduleType.affectableProperties, factoryProps)
if affectablePropertiesType == nil {
return reflect.Value{}
}
for _, c := range moduleType.Variables {
fields = append(fields, reflect.StructField{
Name: proptools.FieldNameForProperty(c.variableProperty()),
Type: c.variableValuesType(),
})
}
typ := reflect.StructOf([]reflect.StructField{{
Name: SoongConfigProperty,
Type: reflect.StructOf(fields),
}})
props := reflect.New(typ)
structConditions := props.Elem().FieldByName(SoongConfigProperty)
for i, c := range moduleType.Variables {
c.initializeProperties(structConditions.Field(i), affectablePropertiesType)
}
return props
}
// createAffectablePropertiesType creates a reflect.Type of a struct that has a field for each affectable property
// that exists in factoryProps.
func createAffectablePropertiesType(affectableProperties []string, factoryProps []interface{}) reflect.Type {
affectableProperties = append([]string(nil), affectableProperties...)
sort.Strings(affectableProperties)
var recurse func(prefix string, aps []string) ([]string, reflect.Type)
recurse = func(prefix string, aps []string) ([]string, reflect.Type) {
var fields []reflect.StructField
// Iterate while the list is non-empty so it can be modified in the loop.
for len(affectableProperties) > 0 {
p := affectableProperties[0]
if !strings.HasPrefix(affectableProperties[0], prefix) {
// The properties are sorted and recurse is always called with a prefix that matches
// the first property in the list, so if we've reached one that doesn't match the
// prefix we are done with this prefix.
break
}
nestedProperty := strings.TrimPrefix(p, prefix)
if i := strings.IndexRune(nestedProperty, '.'); i >= 0 {
var nestedType reflect.Type
nestedPrefix := nestedProperty[:i+1]
// Recurse to handle the properties with the found prefix. This will return
// an updated affectableProperties with the handled entries removed from the front
// of the list, and the type that contains the handled entries. The type may be
// nil if none of the entries matched factoryProps.
affectableProperties, nestedType = recurse(prefix+nestedPrefix, affectableProperties)
if nestedType != nil {
nestedFieldName := proptools.FieldNameForProperty(strings.TrimSuffix(nestedPrefix, "."))
fields = append(fields, reflect.StructField{
Name: nestedFieldName,
Type: nestedType,
})
}
} else {
typ := typeForPropertyFromPropertyStructs(factoryProps, p)
if typ != nil {
fields = append(fields, reflect.StructField{
Name: proptools.FieldNameForProperty(nestedProperty),
Type: typ,
})
}
// The first element in the list has been handled, remove it from the list.
affectableProperties = affectableProperties[1:]
}
}
var typ reflect.Type
if len(fields) > 0 {
typ = reflect.StructOf(fields)
}
return affectableProperties, typ
}
affectableProperties, typ := recurse("", affectableProperties)
if len(affectableProperties) > 0 {
panic(fmt.Errorf("didn't handle all affectable properties"))
}
if typ != nil {
return reflect.PtrTo(typ)
}
return nil
}
func typeForPropertyFromPropertyStructs(psList []interface{}, property string) reflect.Type {
for _, ps := range psList {
if typ := typeForPropertyFromPropertyStruct(ps, property); typ != nil {
return typ
}
}
return nil
}
func typeForPropertyFromPropertyStruct(ps interface{}, property string) reflect.Type {
v := reflect.ValueOf(ps)
for len(property) > 0 {
if !v.IsValid() {
return nil
}
if v.Kind() == reflect.Interface {
if v.IsNil() {
return nil
} else {
v = v.Elem()
}
}
if v.Kind() == reflect.Ptr {
if v.IsNil() {
v = reflect.Zero(v.Type().Elem())
} else {
v = v.Elem()
}
}
if v.Kind() != reflect.Struct {
return nil
}
if index := strings.IndexRune(property, '.'); index >= 0 {
prefix := property[:index]
property = property[index+1:]
v = v.FieldByName(proptools.FieldNameForProperty(prefix))
} else {
f := v.FieldByName(proptools.FieldNameForProperty(property))
if !f.IsValid() {
return nil
}
return f.Type()
}
}
return nil
}
// PropertiesToApply returns the applicable properties from a ModuleType that should be applied
// based on SoongConfig values.
// Expects that props contains a struct field with name soong_config_variables. The fields within
// soong_config_variables are expected to be in the same order as moduleType.Variables.
func PropertiesToApply(moduleType *ModuleType, props reflect.Value, config SoongConfig) ([]interface{}, error) {
var ret []interface{}
props = props.Elem().FieldByName(SoongConfigProperty)
for i, c := range moduleType.Variables {
if ps, err := c.PropertiesToApply(config, props.Field(i)); err != nil {
return nil, err
} else if ps != nil {
ret = append(ret, ps)
}
}
return ret, nil
}
type ModuleType struct {
BaseModuleType string
ConfigNamespace string
Variables []soongConfigVariable
affectableProperties []string
variableNames []string
}
func newModuleType(props *ModuleTypeProperties) (*ModuleType, []error) {
mt := &ModuleType{
affectableProperties: props.Properties,
ConfigNamespace: props.Config_namespace,
BaseModuleType: props.Module_type,
variableNames: props.Variables,
}
for _, name := range props.Bool_variables {
if err := checkVariableName(name); err != nil {
return nil, []error{fmt.Errorf("bool_variables %s", err)}
}
mt.Variables = append(mt.Variables, newBoolVariable(name))
}
for _, name := range props.Value_variables {
if err := checkVariableName(name); err != nil {
return nil, []error{fmt.Errorf("value_variables %s", err)}
}
mt.Variables = append(mt.Variables, &valueVariable{
baseVariable: baseVariable{
variable: name,
},
})
}
return mt, nil
}
func checkVariableName(name string) error {
if name == "" {
return fmt.Errorf("name must not be blank")
} else if name == conditionsDefault {
return fmt.Errorf("%q is reserved", conditionsDefault)
}
return nil
}
type soongConfigVariable interface {
// variableProperty returns the name of the variable.
variableProperty() string
// conditionalValuesType returns a reflect.Type that contains an interface{} for each possible value.
variableValuesType() reflect.Type
// initializeProperties is passed a reflect.Value of the reflect.Type returned by conditionalValuesType and a
// reflect.Type of the affectable properties, and should initialize each interface{} in the reflect.Value with
// the zero value of the affectable properties type.
initializeProperties(v reflect.Value, typ reflect.Type)
// PropertiesToApply should return one of the interface{} values set by initializeProperties to be applied
// to the module.
PropertiesToApply(config SoongConfig, values reflect.Value) (interface{}, error)
}
type baseVariable struct {
variable string
}
func (c *baseVariable) variableProperty() string {
return CanonicalizeToProperty(c.variable)
}
type stringVariable struct {
baseVariable
values []string
}
func (s *stringVariable) variableValuesType() reflect.Type {
var fields []reflect.StructField
var values []string
values = append(values, s.values...)
values = append(values, conditionsDefault)
for _, v := range values {
fields = append(fields, reflect.StructField{
Name: proptools.FieldNameForProperty(v),
Type: emptyInterfaceType,
})
}
return reflect.StructOf(fields)
}
// initializeProperties initializes properties to zero value of typ for supported values and a final
// conditions default field.
func (s *stringVariable) initializeProperties(v reflect.Value, typ reflect.Type) {
for i := range s.values {
v.Field(i).Set(reflect.Zero(typ))
}
v.Field(len(s.values)).Set(reflect.Zero(typ)) // conditions default is the final value
}
// Extracts an interface from values containing the properties to apply based on config.
// If config does not match a value with a non-nil property set, the default value will be returned.
func (s *stringVariable) PropertiesToApply(config SoongConfig, values reflect.Value) (interface{}, error) {
for j, v := range s.values {
f := values.Field(j)
if config.String(s.variable) == v && !f.Elem().IsNil() {
return f.Interface(), nil
}
}
// if we have reached this point, we have checked all valid values of string and either:
// * the value was not set
// * the value was set but that value was not specified in the Android.bp file
return values.Field(len(s.values)).Interface(), nil
}
// Struct to allow conditions set based on a boolean variable
type boolVariable struct {
baseVariable
}
// newBoolVariable constructs a boolVariable with the given name
func newBoolVariable(name string) *boolVariable {
return &boolVariable{
baseVariable{
variable: name,
},
}
}
func (b boolVariable) variableValuesType() reflect.Type {
return emptyInterfaceType
}
// initializeProperties initializes a property to zero value of typ with an additional conditions
// default field.
func (b boolVariable) initializeProperties(v reflect.Value, typ reflect.Type) {
initializePropertiesWithDefault(v, typ)
}
// initializePropertiesWithDefault, initialize with zero value, v to contain a field for each field
// in typ, with an additional field for defaults of type typ. This should be used to initialize
// boolVariable, valueVariable, or any future implementations of soongConfigVariable which support
// one variable and a default.
func initializePropertiesWithDefault(v reflect.Value, typ reflect.Type) {
sTyp := typ.Elem()
var fields []reflect.StructField
for i := 0; i < sTyp.NumField(); i++ {
fields = append(fields, sTyp.Field(i))
}
// create conditions_default field
nestedFieldName := proptools.FieldNameForProperty(conditionsDefault)
fields = append(fields, reflect.StructField{
Name: nestedFieldName,
Type: typ,
})
newTyp := reflect.PtrTo(reflect.StructOf(fields))
v.Set(reflect.Zero(newTyp))
}
// conditionsDefaultField extracts the conditions_default field from v. This is always the final
// field if initialized with initializePropertiesWithDefault.
func conditionsDefaultField(v reflect.Value) reflect.Value {
return v.Field(v.NumField() - 1)
}
// removeDefault removes the conditions_default field from values while retaining values from all
// other fields. This allows
func removeDefault(values reflect.Value) reflect.Value {
v := values.Elem().Elem()
s := conditionsDefaultField(v)
// if conditions_default field was not set, there will be no issues extending properties.
if !s.IsValid() {
return v
}
// If conditions_default field was set, it has the correct type for our property. Create a new
// reflect.Value of the conditions_default type and copy all fields (except for
// conditions_default) based on values to the result.
res := reflect.New(s.Type().Elem())
for i := 0; i < res.Type().Elem().NumField(); i++ {
val := v.Field(i)
res.Elem().Field(i).Set(val)
}
return res
}
// PropertiesToApply returns an interface{} value based on initializeProperties to be applied to
// the module. If the value was not set, conditions_default interface will be returned; otherwise,
// the interface in values, without conditions_default will be returned.
func (b boolVariable) PropertiesToApply(config SoongConfig, values reflect.Value) (interface{}, error) {
// If this variable was not referenced in the module, there are no properties to apply.
if values.Elem().IsZero() {
return nil, nil
}
if config.Bool(b.variable) {
values = removeDefault(values)
return values.Interface(), nil
}
v := values.Elem().Elem()
if f := conditionsDefaultField(v); f.IsValid() {
return f.Interface(), nil
}
return nil, nil
}
// Struct to allow conditions set based on a value variable, supporting string substitution.
type valueVariable struct {
baseVariable
}
func (s *valueVariable) variableValuesType() reflect.Type {
return emptyInterfaceType
}
// initializeProperties initializes a property to zero value of typ with an additional conditions
// default field.
func (s *valueVariable) initializeProperties(v reflect.Value, typ reflect.Type) {
initializePropertiesWithDefault(v, typ)
}
// PropertiesToApply returns an interface{} value based on initializeProperties to be applied to
// the module. If the variable was not set, conditions_default interface will be returned;
// otherwise, the interface in values, without conditions_default will be returned with all
// appropriate string substitutions based on variable being set.
func (s *valueVariable) PropertiesToApply(config SoongConfig, values reflect.Value) (interface{}, error) {
// If this variable was not referenced in the module, there are no properties to apply.
if !values.IsValid() || values.Elem().IsZero() {
return nil, nil
}
if !config.IsSet(s.variable) {
return conditionsDefaultField(values.Elem().Elem()).Interface(), nil
}
configValue := config.String(s.variable)
values = removeDefault(values)
propStruct := values.Elem()
if !propStruct.IsValid() {
return nil, nil
}
for i := 0; i < propStruct.NumField(); i++ {
field := propStruct.Field(i)
kind := field.Kind()
if kind == reflect.Ptr {
if field.IsNil() {
continue
}
field = field.Elem()
}
switch kind {
case reflect.String:
err := printfIntoProperty(field, configValue)
if err != nil {
return nil, fmt.Errorf("soong_config_variables.%s.%s: %s", s.variable, propStruct.Type().Field(i).Name, err)
}
case reflect.Slice:
for j := 0; j < field.Len(); j++ {
err := printfIntoProperty(field.Index(j), configValue)
if err != nil {
return nil, fmt.Errorf("soong_config_variables.%s.%s: %s", s.variable, propStruct.Type().Field(i).Name, err)
}
}
case reflect.Bool:
// Nothing to do
default:
return nil, fmt.Errorf("soong_config_variables.%s.%s: unsupported property type %q", s.variable, propStruct.Type().Field(i).Name, kind)
}
}
return values.Interface(), nil
}
func printfIntoProperty(propertyValue reflect.Value, configValue string) error {
s := propertyValue.String()
count := strings.Count(s, "%")
if count == 0 {
return nil
}
if count > 1 {
return fmt.Errorf("value variable properties only support a single '%%'")
}
if !strings.Contains(s, "%s") {
return fmt.Errorf("unsupported %% in value variable property")
}
propertyValue.Set(reflect.ValueOf(fmt.Sprintf(s, configValue)))
return nil
}
func CanonicalizeToProperty(v string) string {
return strings.Map(func(r rune) rune {
switch {
case r >= 'A' && r <= 'Z',
r >= 'a' && r <= 'z',
r >= '0' && r <= '9',
r == '_':
return r
default:
return '_'
}
}, v)
}
func CanonicalizeToProperties(values []string) []string {
ret := make([]string, len(values))
for i, v := range values {
ret[i] = CanonicalizeToProperty(v)
}
return ret
}
type emptyInterfaceStruct struct {
i interface{}
}
var emptyInterfaceType = reflect.TypeOf(emptyInterfaceStruct{}).Field(0).Type