// 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 `android:"arch_variant"` Shared_libs []string `android:"arch_variant"` Whole_static_libs []string `android:"arch_variant"` Exclude_static_libs []string `android:"arch_variant"` } `android:"arch_variant"` Malloc_zero_contents struct { Cflags []string `android:"arch_variant"` } `android:"arch_variant"` Malloc_pattern_fill_contents struct { Cflags []string `android:"arch_variant"` } `android:"arch_variant"` Safestack struct { Cflags []string `android:"arch_variant"` } `android:"arch_variant"` Binder32bit 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 Required []string Host_required []string Target_required []string Strip struct { All *bool Keep_symbols *bool Keep_symbols_and_debug_frame *bool } } // eng is true for -eng builds, and can be used to turn on additionaly heavyweight debugging // features. Eng struct { Cflags []string Cppflags []string Lto struct { Never *bool } Sanitize struct { Address *bool } Optimize struct { Enabled *bool } } Pdk struct { Enabled *bool `android:"arch_variant"` } `android:"arch_variant"` Uml struct { Cppflags []string } Arc struct { Cflags []string `android:"arch_variant"` Exclude_srcs []string `android:"arch_variant"` Include_dirs []string `android:"arch_variant"` Shared_libs []string `android:"arch_variant"` Static_libs []string `android:"arch_variant"` Srcs []string `android:"arch_variant"` Whole_static_libs []string `android:"arch_variant"` } `android:"arch_variant"` Flatten_apex struct { Enabled *bool } Native_coverage struct { Src *string `android:"arch_variant"` Srcs []string `android:"arch_variant"` Exclude_srcs []string `android:"arch_variant"` } `android:"arch_variant"` } `android:"arch_variant"` } var defaultProductVariables interface{} = variableProperties{} type productVariables struct { // Suffix to add to generated Makefiles Make_suffix *string `json:",omitempty"` BuildId *string `json:",omitempty"` BuildNumberFile *string `json:",omitempty"` Platform_version_name *string `json:",omitempty"` Platform_sdk_version *int `json:",omitempty"` Platform_sdk_codename *string `json:",omitempty"` Platform_sdk_final *bool `json:",omitempty"` Platform_version_active_codenames []string `json:",omitempty"` Platform_vndk_version *string `json:",omitempty"` Platform_systemsdk_versions []string `json:",omitempty"` Platform_security_patch *string `json:",omitempty"` Platform_preview_sdk_version *string `json:",omitempty"` Platform_min_supported_target_sdk_version *string `json:",omitempty"` Platform_base_os *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"` DeviceCurrentApiLevelForVendorModules *string `json:",omitempty"` DeviceSystemSdkVersions []string `json:",omitempty"` RecoverySnapshotVersion *string `json:",omitempty"` DeviceSecondaryArch *string `json:",omitempty"` DeviceSecondaryArchVariant *string `json:",omitempty"` DeviceSecondaryCpuVariant *string `json:",omitempty"` DeviceSecondaryAbi []string `json:",omitempty"` NativeBridgeArch *string `json:",omitempty"` NativeBridgeArchVariant *string `json:",omitempty"` NativeBridgeCpuVariant *string `json:",omitempty"` NativeBridgeAbi []string `json:",omitempty"` NativeBridgeRelativePath *string `json:",omitempty"` NativeBridgeSecondaryArch *string `json:",omitempty"` NativeBridgeSecondaryArchVariant *string `json:",omitempty"` NativeBridgeSecondaryCpuVariant *string `json:",omitempty"` NativeBridgeSecondaryAbi []string `json:",omitempty"` NativeBridgeSecondaryRelativePath *string `json:",omitempty"` HostArch *string `json:",omitempty"` HostSecondaryArch *string `json:",omitempty"` CrossHost *string `json:",omitempty"` CrossHostArch *string `json:",omitempty"` CrossHostSecondaryArch *string `json:",omitempty"` DeviceResourceOverlays []string `json:",omitempty"` ProductResourceOverlays []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"` Unbundled_build_apps *bool `json:",omitempty"` Always_use_prebuilt_sdks *bool `json:",omitempty"` Skip_boot_jars_check *bool `json:",omitempty"` Malloc_not_svelte *bool `json:",omitempty"` Malloc_zero_contents *bool `json:",omitempty"` Malloc_pattern_fill_contents *bool `json:",omitempty"` Safestack *bool `json:",omitempty"` HostStaticBinaries *bool `json:",omitempty"` Binder32bit *bool `json:",omitempty"` UseGoma *bool `json:",omitempty"` UseRBE *bool `json:",omitempty"` UseRBEJAVAC *bool `json:",omitempty"` UseRBER8 *bool `json:",omitempty"` UseRBED8 *bool `json:",omitempty"` Debuggable *bool `json:",omitempty"` Eng *bool `json:",omitempty"` Treble_linker_namespaces *bool `json:",omitempty"` Enforce_vintf_manifest *bool `json:",omitempty"` Uml *bool `json:",omitempty"` Arc *bool `json:",omitempty"` MinimizeJavaDebugInfo *bool `json:",omitempty"` Check_elf_files *bool `json:",omitempty"` UncompressPrivAppDex *bool `json:",omitempty"` ModulesLoadedByPrivilegedModules []string `json:",omitempty"` BootJars ConfiguredJarList `json:",omitempty"` UpdatableBootJars ConfiguredJarList `json:",omitempty"` IntegerOverflowExcludePaths []string `json:",omitempty"` EnableCFI *bool `json:",omitempty"` CFIExcludePaths []string `json:",omitempty"` CFIIncludePaths []string `json:",omitempty"` DisableScudo *bool `json:",omitempty"` MemtagHeapExcludePaths []string `json:",omitempty"` MemtagHeapAsyncIncludePaths []string `json:",omitempty"` MemtagHeapSyncIncludePaths []string `json:",omitempty"` VendorPath *string `json:",omitempty"` OdmPath *string `json:",omitempty"` ProductPath *string `json:",omitempty"` SystemExtPath *string `json:",omitempty"` ClangTidy *bool `json:",omitempty"` TidyChecks *string `json:",omitempty"` SamplingPGO *bool `json:",omitempty"` JavaCoveragePaths []string `json:",omitempty"` JavaCoverageExcludePaths []string `json:",omitempty"` GcovCoverage *bool `json:",omitempty"` ClangCoverage *bool `json:",omitempty"` NativeCoveragePaths []string `json:",omitempty"` NativeCoverageExcludePaths []string `json:",omitempty"` // Set by NewConfig Native_coverage *bool 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"` Fuchsia *bool `json:",omitempty"` DeviceKernelHeaders []string `json:",omitempty"` ExtraVndkVersions []string `json:",omitempty"` NamespacesToExport []string `json:",omitempty"` PgoAdditionalProfileDirs []string `json:",omitempty"` VndkUseCoreVariant *bool `json:",omitempty"` VndkSnapshotBuildArtifacts *bool `json:",omitempty"` DirectedVendorSnapshot bool `json:",omitempty"` VendorSnapshotModules map[string]bool `json:",omitempty"` DirectedRecoverySnapshot bool `json:",omitempty"` RecoverySnapshotModules map[string]bool `json:",omitempty"` BoardVendorSepolicyDirs []string `json:",omitempty"` BoardOdmSepolicyDirs []string `json:",omitempty"` BoardReqdMaskPolicy []string `json:",omitempty"` SystemExtPublicSepolicyDirs []string `json:",omitempty"` SystemExtPrivateSepolicyDirs []string `json:",omitempty"` BoardSepolicyM4Defs []string `json:",omitempty"` BoardSepolicyVers *string `json:",omitempty"` PlatformSepolicyVersion *string `json:",omitempty"` VendorVars map[string]map[string]string `json:",omitempty"` Ndk_abis *bool `json:",omitempty"` Exclude_draft_ndk_apis *bool `json:",omitempty"` Flatten_apex *bool `json:",omitempty"` ForceApexSymlinkOptimization *bool `json:",omitempty"` CompressedApex *bool `json:",omitempty"` Aml_abis *bool `json:",omitempty"` DexpreoptGlobalConfig *string `json:",omitempty"` ManifestPackageNameOverrides []string `json:",omitempty"` CertificateOverrides []string `json:",omitempty"` PackageNameOverrides []string `json:",omitempty"` EnforceSystemCertificate *bool `json:",omitempty"` EnforceSystemCertificateAllowList []string `json:",omitempty"` ProductHiddenAPIStubs []string `json:",omitempty"` ProductHiddenAPIStubsSystem []string `json:",omitempty"` ProductHiddenAPIStubsTest []string `json:",omitempty"` ProductPublicSepolicyDirs []string `json:",omitempty"` ProductPrivateSepolicyDirs []string `json:",omitempty"` ProductVndkVersion *string `json:",omitempty"` TargetFSConfigGen []string `json:",omitempty"` MissingUsesLibraries []string `json:",omitempty"` EnforceProductPartitionInterface *bool `json:",omitempty"` EnforceInterPartitionJavaSdkLibrary *bool `json:",omitempty"` InterPartitionJavaLibraryAllowList []string `json:",omitempty"` InstallExtraFlattenedApexes *bool `json:",omitempty"` BoardUsesRecoveryAsBoot *bool `json:",omitempty"` BoardKernelBinaries []string `json:",omitempty"` BoardKernelModuleInterfaceVersions []string `json:",omitempty"` BoardMoveRecoveryResourcesToVendorBoot *bool `json:",omitempty"` PrebuiltHiddenApiDir *string `json:",omitempty"` ShippingApiLevel *string `json:",omitempty"` BuildBrokenVendorPropertyNamespace bool `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{ BuildNumberFile: stringPtr("build_number.txt"), Platform_version_name: stringPtr("S"), Platform_sdk_version: intPtr(30), Platform_sdk_codename: stringPtr("S"), Platform_sdk_final: boolPtr(false), Platform_version_active_codenames: []string{"S"}, Platform_vndk_version: stringPtr("S"), 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), Malloc_zero_contents: boolPtr(true), Malloc_pattern_fill_contents: boolPtr(false), 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() if a.variableProperties == nil { return } variableValues := reflect.ValueOf(a.variableProperties).Elem().FieldByName("Product_variables") productVariables := reflect.ValueOf(mctx.Config().productVariables) for i := 0; i < variableValues.NumField(); i++ { variableValue := variableValues.Field(i) name := variableValues.Type().Field(i).Name property := "product_variables." + proptools.PropertyNameForField(name) // Check that the variable was set for the product val := 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 variableValue.IsZero() { continue } a.setVariableProperties(mctx, property, variableValue, val.Interface()) } } func (m *ModuleBase) setVariableProperties(ctx BottomUpMutatorContext, prefix string, productVariablePropertyValue reflect.Value, variableValue interface{}) { printfIntoProperties(ctx, prefix, productVariablePropertyValue, variableValue) err := proptools.AppendMatchingProperties(m.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 } var variablePropTypeMap OncePer // sliceToTypeArray takes a slice of property structs and returns a reflection created array containing the // reflect.Types of each property struct. The result can be used as a key in a map. func sliceToTypeArray(s []interface{}) interface{} { // Create an array using reflection whose length is the length of the input slice ret := reflect.New(reflect.ArrayOf(len(s), reflect.TypeOf(reflect.TypeOf(0)))).Elem() for i, e := range s { ret.Index(i).Set(reflect.ValueOf(reflect.TypeOf(e))) } return ret.Interface() } func initProductVariableModule(m Module) { base := m.base() // Allow tests to override the default product variables if base.variableProperties == nil { base.variableProperties = defaultProductVariables } // Filter the product variables properties to the ones that exist on this module base.variableProperties = createVariableProperties(m.GetProperties(), base.variableProperties) if base.variableProperties != nil { m.AddProperties(base.variableProperties) } } // createVariableProperties takes the list of property structs for a module and returns a property struct that // contains the product variable properties that exist in the property structs, or nil if there are none. It // caches the result. func createVariableProperties(moduleTypeProps []interface{}, productVariables interface{}) interface{} { // Convert the moduleTypeProps to an array of reflect.Types that can be used as a key in the OncePer. key := sliceToTypeArray(moduleTypeProps) // Use the variablePropTypeMap OncePer to cache the result for each set of property struct types. typ, _ := variablePropTypeMap.Once(NewCustomOnceKey(key), func() interface{} { // Compute the filtered property struct type. return createVariablePropertiesType(moduleTypeProps, productVariables) }).(reflect.Type) if typ == nil { return nil } // Create a new pointer to a filtered property struct. return reflect.New(typ).Interface() } // createVariablePropertiesType creates a new type that contains only the product variable properties that exist in // a list of property structs. func createVariablePropertiesType(moduleTypeProps []interface{}, productVariables interface{}) reflect.Type { typ, _ := proptools.FilterPropertyStruct(reflect.TypeOf(productVariables), func(field reflect.StructField, prefix string) (bool, reflect.StructField) { // Filter function, returns true if the field should be in the resulting struct if prefix == "" { // Keep the top level Product_variables field return true, field } _, rest := splitPrefix(prefix) if rest == "" { // Keep the 2nd level field (i.e. Product_variables.Eng) return true, field } // Strip off the first 2 levels of the prefix _, prefix = splitPrefix(rest) for _, p := range moduleTypeProps { if fieldExistsByNameRecursive(reflect.TypeOf(p).Elem(), prefix, field.Name) { // Keep any fields that exist in one of the property structs return true, field } } return false, field }) return typ } func splitPrefix(prefix string) (first, rest string) { index := strings.IndexByte(prefix, '.') if index == -1 { return prefix, "" } return prefix[:index], prefix[index+1:] } func fieldExistsByNameRecursive(t reflect.Type, prefix, name string) bool { if t.Kind() != reflect.Struct { panic(fmt.Errorf("fieldExistsByNameRecursive can only be called on a reflect.Struct")) } if prefix != "" { split := strings.SplitN(prefix, ".", 2) firstPrefix := split[0] rest := "" if len(split) > 1 { rest = split[1] } f, exists := t.FieldByName(firstPrefix) if !exists { return false } ft := f.Type if ft.Kind() == reflect.Ptr { ft = ft.Elem() } if ft.Kind() != reflect.Struct { panic(fmt.Errorf("field %q in %q is not a struct", firstPrefix, t)) } return fieldExistsByNameRecursive(ft, rest, name) } else { _, exists := t.FieldByName(name) return exists } }