// 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() {
 registerVariableBuildComponents(InitRegistrationContext)
}

func registerVariableBuildComponents(ctx RegistrationContext) {
 ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
  ctx.BottomUp("variable", VariableMutator)
 })
}

var PrepareForTestWithVariables = FixtureRegisterWithContext(registerVariableBuildComponents)

type variableProperties struct {
 Product_variables struct {
  Platform_sdk_version struct {
   Asflags []string
   Cflags  []string
   Cmd     *string
  }

  Platform_sdk_version_or_codename struct {
   Java_resource_dirs []string
  }

  Platform_sdk_extension_version struct {
   Cmd *string
  }

  Platform_version_name struct {
   Base_dir *string
  }

  Shipping_api_level struct {
   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 proptools.Configurable[bool] `android:"arch_variant,replace_instead_of_append"`
  } `android:"arch_variant"`

  Malloc_low_memory struct {
   Cflags              []string `android:"arch_variant"`
   Shared_libs         []string `android:"arch_variant"`
   Whole_static_libs   []string `android:"arch_variant"`
   Static_libs         []string `android:"arch_variant"`
   Exclude_static_libs []string `android:"arch_variant"`
   Srcs                []string `android:"arch_variant"`
   Header_libs         []string `android:"arch_variant"`
  } `android:"arch_variant"`

  Malloc_scudo_tsds_max struct {
   Cflags []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
  }

  Build_from_text_stub struct {
   Static_libs         []string
   Exclude_static_libs []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 {
   Apk             *string
   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
   }
   Static_libs         []string
   Exclude_static_libs []string
   Whole_static_libs   []string
   Shared_libs         []string
   Jni_libs            []string

   Cmdline []string

   Srcs         []string
   Exclude_srcs []string
   Cmd          *string

   Deps []string
  }

  // eng is true for -eng builds, and can be used to turn on additional heavyweight debugging
  // features.
  Eng struct {
   Cflags   []string
   Cppflags []string
   Flags    []string
   Lto      struct {
    Never *bool
   }
   Sanitize struct {
    Address *bool
   }
   Optimize struct {
    Enabled *bool
   }
   Aaptflags []string
  }

  Uml struct {
   Cppflags []string
  }

  Arc struct {
   Cflags            []string `android:"arch_variant"`
   Exclude_srcs      []string `android:"arch_variant"`
   Header_libs       []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"`

  Native_coverage struct {
   Src          *string  `android:"arch_variant"`
   Srcs         []string `android:"arch_variant"`
   Exclude_srcs []string `android:"arch_variant"`
  } `android:"arch_variant"`

  // release_aidl_use_unfrozen is "true" when a device can
  // use the unfrozen versions of AIDL interfaces.
  Release_aidl_use_unfrozen struct {
   Cflags                 []string
   Cmd                    *string
   Required               []string
   Vintf_fragment_modules []string
  }
  SelinuxIgnoreNeverallows struct {
   Required []string
  }
 } `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"`
 BuildFingerprintFile       *string `json:",omitempty"`
 BuildNumberFile            *string `json:",omitempty"`
 BuildUUIDFile              *string `json:",omitempty"`
 BuildHostnameFile          *string `json:",omitempty"`
 BuildSystemFingerprintFile *string `json:",omitempty"`
 BuildThumbprintFile        *string `json:",omitempty"`
 DisplayBuildNumber         *bool   `json:",omitempty"`

 Platform_base_os                       *string  `json:",omitempty"`
 Platform_base_sdk_extension_version    *int     `json:",omitempty"`
 Platform_display_version_name          *string  `json:",omitempty"`
 Platform_preview_sdk_version           *string  `json:",omitempty"`
 Platform_prospective_sdk_version_full  *string  `json:",omitempty"`
 Platform_sdk_codename                  *string  `json:",omitempty"`
 Platform_sdk_extension_version         *int     `json:",omitempty"`
 Platform_sdk_final                     *bool    `json:",omitempty"`
 Platform_sdk_version                   *int     `json:",omitempty"`
 Platform_sdk_version_full              *string  `json:",omitempty"`
 Platform_sdk_version_or_codename       *string  `json:",omitempty"`
 Platform_security_patch                *string  `json:",omitempty"`
 Platform_systemsdk_versions            []string `json:",omitempty"`
 Platform_version_active_codenames      []string `json:",omitempty"`
 Platform_version_all_preview_codenames []string `json:",omitempty"`
 Platform_version_known_codenames       *string  `json:",omitempty"`
 Platform_version_last_stable           *string  `json:",omitempty"`
 Platform_version_name                  *string  `json:",omitempty"`

 DeviceName                            *string  `json:",omitempty" generic:"generic"`
 DeviceProduct                         *string  `json:",omitempty" generic:"generic"`
 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"`
 DeviceMaxPageSizeSupported            *string  `json:",omitempty"`
 DeviceCheckPrebuiltMaxPageSize        *bool    `json:",omitempty"`
 DeviceNoBionicPageSizeMacro           *bool    `json:",omitempty"`

 VendorApiLevel             *string `json:",omitempty"`
 VendorApiLevelPropOverride *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"`
 HostMusl          *bool   `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"`
 DefaultSystemDevCertificate              *string  `json:",omitempty"`
 ExtraOtaKeys                             []string `json:",omitempty"`
 ExtraOtaRecoveryKeys                     []string `json:",omitempty"`
 MainlineSepolicyDevCertificates          *string  `json:",omitempty"`
 MainlineBluetoothSepolicyDevCertificates *string  `json:",omitempty"`
 MainlineNfcSepolicyDevCertificates       *string  `json:",omitempty"`

 AppsDefaultVersionName *string `json:",omitempty"`

 Allow_missing_dependencies   *bool    `json:",omitempty"`
 Unbundled_build              *bool    `json:",omitempty"`
 Unbundled_build_apps         []string `json:",omitempty"`
 Unbundled_build_image        *bool    `json:",omitempty"`
 Always_use_prebuilt_sdks     *bool    `json:",omitempty"`
 Skip_boot_jars_check         *bool    `json:",omitempty"`
 Malloc_low_memory            *bool    `json:",omitempty"`
 Malloc_scudo_tsds_max        *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"`
 UseABFS                      *bool    `json:",omitempty"`
 UseRBE                       *bool    `json:",omitempty"`
 UseREWrapper                 *bool    `json:",omitempty"`
 RBEContainerImage            *string  `json:",omitempty"`
 Debuggable                   *bool    `json:",omitempty"`
 Eng                          *bool    `json:",omitempty"`
 Uml                          *bool    `json:",omitempty"`
 Arc                          *bool    `json:",omitempty"`
 MinimizeJavaDebugInfo        *bool    `json:",omitempty"`
 Build_from_text_stub         *bool    `json:",omitempty"`

 BuildType *string `json:",omitempty"`

 Check_elf_files *bool `json:",omitempty"`

 UncompressPrivAppDex             *bool    `json:",omitempty"`
 ModulesLoadedByPrivilegedModules []string `json:",omitempty"`

 BootJars     ConfiguredJarList `json:",omitempty"`
 ApexBootJars ConfiguredJarList `json:",omitempty"`

 IntegerOverflowExcludePaths []string `json:",omitempty"`

 EnableCFI       *bool    `json:",omitempty"`
 CFIExcludePaths []string `json:",omitempty"`
 CFIIncludePaths []string `json:",omitempty"`

 EnableXOM       *bool    `json:",omitempty"`
 XOMExcludePaths []string `json:",omitempty"`

 DisableScudo *bool `json:",omitempty"`

 MemtagHeapExcludePaths      []string `json:",omitempty"`
 MemtagHeapAsyncIncludePaths []string `json:",omitempty"`
 MemtagHeapSyncIncludePaths  []string `json:",omitempty"`

 HWASanIncludePaths []string `json:",omitempty"`
 HWASanExcludePaths []string `json:",omitempty"`

 VendorPath            *string `json:",omitempty"`
 VendorDlkmPath        *string `json:",omitempty"`
 BuildingVendorImage   *bool   `json:",omitempty"`
 OdmPath               *string `json:",omitempty"`
 BuildingOdmImage      *bool   `json:",omitempty"`
 OdmDlkmPath           *string `json:",omitempty"`
 ProductPath           *string `json:",omitempty"`
 BuildingProductImage  *bool   `json:",omitempty"`
 SystemExtPath         *string `json:",omitempty"`
 SystemDlkmPath        *string `json:",omitempty"`
 OemPath               *string `json:",omitempty"`
 UserdataPath          *string `json:",omitempty"`
 BuildingUserdataImage *bool   `json:",omitempty"`
 RecoveryPath          *string `json:",omitempty"`
 BuildingRecoveryImage *bool   `json:",omitempty"`

 ClangTidy  *bool   `json:",omitempty"`
 TidyChecks *string `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"`
 ClangCoverageContinuousMode *bool    `json:",omitempty"`

 // Set by NewConfig
 Native_coverage *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"`

 ExtraVndkVersions []string `json:",omitempty"`

 NamespacesToExport []string `json:",omitempty"`

 PgoAdditionalProfileDirs []string `json:",omitempty"`

 BoardVendorSepolicyDirs      []string `json:",omitempty"`
 BoardOdmSepolicyDirs         []string `json:",omitempty"`
 SystemExtPublicSepolicyDirs  []string `json:",omitempty"`
 SystemExtPrivateSepolicyDirs []string `json:",omitempty"`
 BoardSepolicyM4Defs          []string `json:",omitempty"`

 BoardPlatform           *string `json:",omitempty"`
 BoardSepolicyVers       *string `json:",omitempty"`
 PlatformSepolicyVersion *string `json:",omitempty"`

 SystemExtSepolicyPrebuiltApiDirs []string `json:",omitempty"`
 ProductSepolicyPrebuiltApiDirs   []string `json:",omitempty"`

 PlatformSepolicyCompatVersions []string `json:",omitempty"`

 VendorVars     map[string]map[string]string `json:",omitempty"`
 VendorVarTypes map[string]map[string]string `json:",omitempty"`

 Ndk_abis *bool `json:",omitempty"`

 ForceApexSymlinkOptimization *bool `json:",omitempty"`
 CompressedApex               *bool `json:",omitempty"`
 Aml_abis                     *bool `json:",omitempty"`

 DefaultApexPayloadType               *string `json:",omitempty"`
 DefaultApexPayloadErofsCompressor    *string `json:",omitempty"`
 DefaultApexPayloadErofsCompressHints *string `json:",omitempty"`
 DefaultApexPayloadErofsPclusterSize  int64   `json:",omitempty"`

 DexpreoptGlobalConfig *string `json:",omitempty"`

 WithDexpreopt bool `json:",omitempty"`

 ManifestPackageNameOverrides   []string `json:",omitempty"`
 CertificateOverrides           []string `json:",omitempty"`
 PackageNameOverrides           []string `json:",omitempty"`
 ConfiguredJarLocationOverrides []string `json:",omitempty"`

 ApexGlobalMinSdkVersionOverride *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"`

 TargetFSConfigGen []string `json:",omitempty"`

 UseSoongSystemImage            *bool   `json:",omitempty"`
 ProductSoongDefinedSystemImage *string `json:",omitempty"`

 EnforceProductPartitionInterface *bool `json:",omitempty"`

 BoardUsesRecoveryAsBoot *bool `json:",omitempty"`

 BoardKernelBinaries                []string `json:",omitempty"`
 BoardKernelModuleInterfaceVersions []string `json:",omitempty"`

 BoardMoveRecoveryResourcesToVendorBoot *bool `json:",omitempty"`

 PrebuiltHiddenApiDir *string `json:",omitempty"`

 Shipping_api_level *string `json:",omitempty"`

 BuildBrokenPluginValidation         []string `json:",omitempty"`
 BuildBrokenClangAsFlags             bool     `json:",omitempty"`
 BuildBrokenClangCFlags              bool     `json:",omitempty"`
 BuildBrokenClangProperty            bool     `json:",omitempty"`
 BuildBrokenEnforceSyspropOwner      bool     `json:",omitempty"`
 BuildBrokenTrebleSyspropNeverallow  bool     `json:",omitempty"`
 BuildBrokenVendorPropertyNamespace  bool     `json:",omitempty"`
 BuildBrokenIncorrectPartitionImages bool     `json:",omitempty"`
 BuildBrokenInputDirModules          []string `json:",omitempty"`
 BuildBrokenDontCheckSystemSdk       bool     `json:",omitempty"`
 BuildBrokenDupSysprop               bool     `json:",omitempty"`
 BuildBrokenPrebuiltELFFiles         bool     `json:",omitempty"`

 BuildDebugfsRestrictionsEnabled bool `json:",omitempty"`

 RequiresInsecureExecmemForSwiftshader bool `json:",omitempty"`

 SelinuxIgnoreNeverallows bool `json:",omitempty"`

 Release_aidl_use_unfrozen *bool `json:",omitempty"`

 SepolicyFreezeTestExtraDirs         []string `json:",omitempty"`
 SepolicyFreezeTestExtraPrebuiltDirs []string `json:",omitempty"`

 GenerateAidlNdkPlatformBackend bool `json:",omitempty"`

 IgnorePrefer32OnDevice bool `json:",omitempty"`

 SourceRootDirs []string `json:",omitempty"`

 AfdoProfiles []string `json:",omitempty"`

 ProductManufacturer string `json:",omitempty"`
 ProductBrand        string `json:",omitempty"`
 ProductDevice       string `json:",omitempty"`
 ProductModel        string `json:",omitempty"`

 ReleaseVersion          string   `json:",omitempty"`
 ReleaseAconfigValueSets []string `json:",omitempty"`

 ReleaseAconfigFlagDefaultPermission string `json:",omitempty"`

 ReleaseDefaultModuleBuildFromSource *bool `json:",omitempty"`

 CheckVendorSeappViolations *bool `json:",omitempty"`

 BuildFlags map[string]string `json:",omitempty"`

 BuildFlagTypes map[string]string `json:",omitempty"`

 BuildFromSourceStub *bool `json:",omitempty"`

 BuildIgnoreApexContributionContents *bool `json:",omitempty"`

 HiddenapiExportableStubs *bool `json:",omitempty"`

 ExportRuntimeApis *bool `json:",omitempty"`

 AconfigContainerValidation string `json:",omitempty"`

 ProductLocales []string `json:",omitempty"`

 ProductDefaultWifiChannels []string `json:",omitempty"`

 OemProperties []string `json:",omitempty"`

 ArtTargetIncludeDebugBuild *bool `json:",omitempty"`

 SystemPropFiles    []string `json:",omitempty"`
 SystemExtPropFiles []string `json:",omitempty"`
 ProductPropFiles   []string `json:",omitempty"`
 OdmPropFiles       []string `json:",omitempty"`
 VendorPropFiles    []string `json:",omitempty"`

 EnableUffdGc       *string `json:",omitempty"`
 BoardKernelVersion *string `json:",omitempty"`

 BoardAvbEnable                         *bool    `json:",omitempty"`
 BoardAvbSystemAddHashtreeFooterArgs    []string `json:",omitempty"`
 DeviceFrameworkCompatibilityMatrixFile []string `json:",omitempty"`
 DeviceProductCompatibilityMatrixFile   []string `json:",omitempty"`

 PartitionVarsForSoongMigrationOnlyDoNotUse PartitionVariables

 AdbKeys *string `json:",omitempty"`

 DeviceMatrixFile       []string `json:",omitempty"`
 ProductManifestFiles   []string `json:",omitempty"`
 SystemManifestFile     []string `json:",omitempty"`
 SystemExtManifestFiles []string `json:",omitempty"`
 DeviceManifestFiles    []string `json:",omitempty"`
 DeviceManifestSkus     []string `json:",omitempty"`
 OdmManifestFiles       []string `json:",omitempty"`
 OdmManifestSkus        []string `json:",omitempty"`

 StripByDefault *bool `json:",omitempty"`

 CompatibilityTestcases map[string]CompatibilityTestcaseJSON

 // Will be used to install host tools in soong only builds
 ProductHostPackages []string `json:",omitempty"`

 EnforceSELinuxTrebleLabeling *bool `json:",omitempty"`

 SELinuxTrebleLabelingTrackingListFile *string `json:",omitempty"`

 BuildOTAPackage *bool `json:",omitempty"`

 RestrictsAshmemUsage bool `json:",omitempty"`
}

type CompatibilityTestcaseJSON struct {
 OutDir              string `json:",omitempty"`
 IncludeModuleFolder bool   `json:",omitempty"`
}

type PartitionQualifiedVariablesType struct {
 BuildingImage               bool   `json:",omitempty"`
 PrebuiltImage               bool   `json:",omitempty"`
 BoardErofsCompressor        string `json:",omitempty"`
 BoardErofsCompressHints     string `json:",omitempty"`
 BoardErofsPclusterSize      string `json:",omitempty"`
 BoardErofsBlockSize         string `json:",omitempty"`
 BoardErofsEnableDedupe      string `json:",omitempty"`
 BoardExtfsInodeCount        string `json:",omitempty"`
 BoardExtfsRsvPct            string `json:",omitempty"`
 BoardF2fsSloadCompressFlags string `json:",omitempty"`
 BoardFileSystemCompress     string `json:",omitempty"`
 BoardFileSystemType         string `json:",omitempty"`
 BoardJournalSize            string `json:",omitempty"`
 BoardPartitionReservedSize  string `json:",omitempty"`
 BoardPartitionSize          string `json:",omitempty"`
 ProductBaseFsPath           string `json:",omitempty"`
 ProductHeadroom             string `json:",omitempty"`
 ProductVerityPartition      string `json:",omitempty"`

 BoardAvbAddHashtreeFooterArgs string `json:",omitempty"`
 BoardAvbKeyPath               string `json:",omitempty"`
 BoardAvbAlgorithm             string `json:",omitempty"`
 BoardAvbRollbackIndex         string `json:",omitempty"`
 BoardAvbRollbackIndexLocation string `json:",omitempty"`
}

type BoardSuperPartitionGroupProps struct {
 GroupSize     string   `json:",omitempty"`
 PartitionList []string `json:",omitempty"`
}

type ChainedAvbPartitionProps struct {
 Partitions            []string `json:",omitempty"`
 Key                   string   `json:",omitempty"`
 Algorithm             string   `json:",omitempty"`
 RollbackIndex         string   `json:",omitempty"`
 RollbackIndexLocation string   `json:",omitempty"`
}

type ProductPackagesVariables struct {
 ProductPackages                   []string `json:",omitempty"`
 ProductPackagesDebug              []string `json:",omitempty"`
 ProductPackagesEng                []string `json:",omitempty"`
 ProductPackagesDebugAsan          []string `json:",omitempty"`
 ProductPackagesDebugJavaCoverage  []string `json:",omitempty"`
 ProductPackagesArm64              []string `json:",omitempty"`
 ProductPackagesShippingApiLevel29 []string `json:",omitempty"`
 ProductPackagesShippingApiLevel33 []string `json:",omitempty"`
 ProductPackagesShippingApiLevel34 []string `json:",omitempty"`
}

type PartitionVariables struct {
 ProductDirectory            string `json:",omitempty"`
 PartitionQualifiedVariables map[string]PartitionQualifiedVariablesType
 TargetUserimagesUseExt2     bool `json:",omitempty"`
 TargetUserimagesUseExt3     bool `json:",omitempty"`
 TargetUserimagesUseExt4     bool `json:",omitempty"`

 TargetUserimagesSparseExtDisabled   bool `json:",omitempty"`
 TargetUserimagesSparseErofsDisabled bool `json:",omitempty"`
 TargetUserimagesSparseF2fsDisabled  bool `json:",omitempty"`

 BoardErofsCompressor           string `json:",omitempty"`
 BoardErofsCompressorHints      string `json:",omitempty"`
 BoardErofsPclusterSize         string `json:",omitempty"`
 BoardErofsBlockSize            string `json:",omitempty"`
 BoardErofsShareDupBlocks       string `json:",omitempty"`
 BoardErofsUseLegacyCompression string `json:",omitempty"`
 BoardErofsEnableDedupe         string `json:",omitempty"`
 BoardExt4ShareDupBlocks        string `json:",omitempty"`
 BoardFlashLogicalBlockSize     string `json:",omitempty"`
 BoardFlashEraseBlockSize       string `json:",omitempty"`
 ProductUseDynamicPartitionSize bool   `json:",omitempty"`
 CopyImagesForTargetFilesZip    bool   `json:",omitempty"`

 VendorSecurityPatch     string `json:",omitempty"`
 OdmSecurityPatch        string `json:",omitempty"`
 SystemDlkmSecurityPatch string `json:",omitempty"`
 VendorDlkmSecurityPatch string `json:",omitempty"`
 OdmDlkmSecurityPatch    string `json:",omitempty"`

 BuildingSystemOtherImage bool `json:",omitempty"`

 // Boot image stuff
 BuildingRamdiskImage              bool     `json:",omitempty"`
 ProductBuildBootImage             bool     `json:",omitempty"`
 ProductBuildVendorBootImage       string   `json:",omitempty"`
 ProductBuildInitBootImage         bool     `json:",omitempty"`
 BoardUsesRecoveryAsBoot           bool     `json:",omitempty"`
 BoardPrebuiltInitBootimage        string   `json:",omitempty"`
 BoardBootimagePartitionSize       string   `json:",omitempty"`
 BoardVendorBootimagePartitionSize string   `json:",omitempty"`
 BoardInitBootimagePartitionSize   string   `json:",omitempty"`
 BoardBootHeaderVersion            string   `json:",omitempty"`
 BoardInitBootHeaderVersion        string   `json:",omitempty"`
 BoardUsesGenericKernelImage       bool     `json:",omitempty"`
 BootSecurityPatch                 string   `json:",omitempty"`
 InitBootSecurityPatch             string   `json:",omitempty"`
 BoardIncludeDtbInBootimg          bool     `json:",omitempty"`
 InternalKernelCmdline             []string `json:",omitempty"`
 InternalBootconfig                []string `json:",omitempty"`
 InternalBootconfigFile            string   `json:",omitempty"`
 BoardPrebuiltBootImage            string   `json:",omitempty"`
 BoardKernelPath16k                string   `json:",omitempty"`
 BoardPrebuiltDtboImage            string   `json:",omitempty"`
 BoardPrebuiltDtboImage16kb        string   `json:",omitempty"`
 BoardDtboPartitionSize            string   `json:",omitempty"`
 Board16kOtaUseIncremental         bool     `json:",omitempty"`
 Board16kOtaMoveVendor             bool     `json:",omitempty"`
 BoardPrebuiltDtbDir               string   `json:",omitempty"`
 BoardKernelModules16K             []string `json:",omitempty"`
 BoardKernelModulesLoad16K         []string `json:",omitempty"`
 BuildingDebugBootImage            bool     `json:",omitempty"`
 BuildingDebugVendorBootImage      bool     `json:",omitempty"`
 BoardVendorRamdiskFragments       []string `json:",omitempty"`

 // Radio stuff
 AbOtaRadioPartitions       []string `json:",omitempty"`
 BootloaderFilePath         string   `json:",omitempty"`
 AbOtaBootloaderPartitions  []string `json:",omitempty"`
 BoardRadioImagePath        string   `json:",omitempty"`
 BoardPrebuiltTzswImagePath string   `json:",omitempty"`

 // pvmfw stuff
 BoardUsesPvmfwImage              bool   `json:",omitempty"`
 BoardPvmfwPartitionSize          string `json:",omitempty"`
 BoardPvmfwImagePrebuilt          string `json:",omitempty"`
 BoardPvmfwBinPrebuilt            string `json:",omitempty"`
 BoardPvmfwEmbeddedAvbkeyPrebuilt string `json:",omitempty"`

 // Super image stuff
 ProductUseDynamicPartitions       bool                                     `json:",omitempty"`
 ProductRetrofitDynamicPartitions  bool                                     `json:",omitempty"`
 ProductBuildSuperPartition        bool                                     `json:",omitempty"`
 BuildingSuperEmptyImage           bool                                     `json:",omitempty"`
 BoardSuperPartitionSize           string                                   `json:",omitempty"`
 BoardSuperPartitionWarnLimit      string                                   `json:",omitempty"`
 BoardSuperPartitionErrorLimit     string                                   `json:",omitempty"`
 BoardSuperPartitionMetadataDevice string                                   `json:",omitempty"`
 BoardSuperPartitionBlockDevices   []string                                 `json:",omitempty"`
 BoardSuperPartitionGroups         map[string]BoardSuperPartitionGroupProps `json:",omitempty"`
 ProductVirtualAbOta               bool                                     `json:",omitempty"`
 ProductVirtualAbOtaRetrofit       bool                                     `json:",omitempty"`
 ProductVirtualAbCompression       bool                                     `json:",omitempty"`
 ProductVirtualAbCompressionMethod string                                   `json:",omitempty"`
 ProductVirtualAbCompressionFactor string                                   `json:",omitempty"`
 ProductVirtualAbCowVersion        string                                   `json:",omitempty"`
 AbOtaUpdater                      bool                                     `json:",omitempty"`
 AbOtaPartitions                   []string                                 `json:",omitempty"`
 AbOtaKeys                         []string                                 `json:",omitempty"`
 AbOtaPostInstallConfig            []string                                 `json:",omitempty"`
 BoardSuperImageInUpdatePackage    bool                                     `json:",omitempty"`

 // Avb (android verified boot) stuff
 BoardAvbEnable          bool                                `json:",omitempty"`
 BoardAvbAlgorithm       string                              `json:",omitempty"`
 BoardAvbKeyPath         string                              `json:",omitempty"`
 BoardAvbRollbackIndex   string                              `json:",omitempty"`
 BuildingVbmetaImage     bool                                `json:",omitempty"`
 ChainedVbmetaPartitions map[string]ChainedAvbPartitionProps `json:",omitempty"`

 ProductPackagesSet      map[string]ProductPackagesVariables `json:",omitempty"`
 VendorLinkerConfigSrcs  []string                            `json:",omitempty"`
 ProductLinkerConfigSrcs []string                            `json:",omitempty"`

 BoardInfoFiles      []string `json:",omitempty"`
 BootLoaderBoardName string   `json:",omitempty"`

 ProductCopyFiles []string `json:",omitempty"`

 // To be used in artifact_path_requirements.
 // We still need this even in soong-only build until we remove PRODUCT_PACKAGES from the make
 // world.
 EnforceArtifactPathRequirements             string              `json:",omitempty"`
 ArtifactPathRequirementAllowedList          []string            `json:",omitempty"`
 ArtifactPathRequirementProducts             []string            `json:",omitempty"`
 ArtifactPathRequirementSyspropAllowedList   []string            `json:",omitempty"`
 ProductSystemProperties                     []string            `json:",omitempty"`
 ProductSystemDefaultProperties              []string            `json:",omitempty"`
 ArtifactPathRequirementsOfMakefile          map[string][]string `json:",omitempty"`
 ArtifactPathAllowedListOfMakefile           map[string][]string `json:",omitempty"`
 SystemPropertiesOfMakefile                  map[string][]string `json:",omitempty"`
 SystemDefaultPropertiesOfMakefile           map[string][]string `json:",omitempty"`
 DeviceFcmFileOfMakefile                     map[string][]string `json:",omitempty"`
 ArtifactPathRequirementsIsRelaxedOfMakefile map[string]bool     `json:",omitempty"`

 BoardKernelModulesZip                              string   `json:",omitempty"`
 BoardKernelModulesZipExtraVendorKernelRamdiskLoads []string `json:",omitempty"`
 BoardKernelModulesZipExtraVendorKernelModules      []string `json:",omitempty"`
 BoardKernelModulesZipExtraBlocked16kModules        []string `json:",omitempty"`
 BuildingSystemDlkmImage                            bool     `json:",omitempty"`
 SystemKernelModules                                []string `json:",omitempty"`
 SystemKernelBlocklistFile                          string   `json:",omitempty"`
 SystemKernelLoadModules                            []string `json:",omitempty"`
 BuildingVendorDlkmImage                            bool     `json:",omitempty"`
 VendorKernelModules                                []string `json:",omitempty"`
 VendorKernelModulesLoad                            []string `json:",omitempty"`
 VendorKernelBlocklistFile                          string   `json:",omitempty"`
 VendorKernelModules2ndStage16kbMode                []string `json:",omitempty"`
 BuildingOdmDlkmImage                               bool     `json:",omitempty"`
 OdmKernelModules                                   []string `json:",omitempty"`
 OdmKernelBlocklistFile                             string   `json:",omitempty"`

 VendorRamdiskKernelModules       []string `json:",omitempty"`
 VendorRamdiskKernelBlocklistFile string   `json:",omitempty"`
 VendorRamdiskKernelLoadModules   []string `json:",omitempty"`
 VendorRamdiskKernelOptionsFile   string   `json:",omitempty"`
 DoNotStripVendorRamdiskModules   bool     `json:",omitempty"`
 DoNotStripVendorModules          bool     `json:",omitempty"`

 VendorKernelRamdiskKernelModules              []string `json:",omitempty"`
 VendorKernelRamdiskKernelModulesBlocklistFile string   `json:",omitempty"`

 ProductFsverityGenerateMetadata bool `json:",omitempty"`

 TargetScreenDensity string `json:",omitempty"`

 PrivateRecoveryUiProperties map[string]string `json:",omitempty"`

 PrebuiltBootloader string `json:",omitempty"`

 ProductFsCasefold    string `json:",omitempty"`
 ProductQuotaProjid   string `json:",omitempty"`
 ProductFsCompression string `json:",omitempty"`
 BoardF2fsBlockSize   string `json:",omitempty"`
 BoardF2fsPackedSsa   string `json:",omitempty"`

 ReleaseToolsExtensionDir string `json:",omitempty"`

 BoardPartialOtaUpdatePartitionsList []string `json:",omitempty"`
 BoardFlashBlockSize                 string   `json:",omitempty"`
 BootloaderInUpdatePackage           bool     `json:",omitempty"`

 BoardFastbootInfoFile string `json:",omitempty"`

 TargetRecoveryWipe string `json:",omitempty"`

 TargetRecoveryFstab        string `json:",omitempty"`
 TargetRecoveryFstabGenrule string `json:",omitempty"`
 TargetRecoveryFstabDefault string `json:",omitempty"`

 VendorBlobsLicense string `json:",omitempty"`

 MinimalFontFootprint bool `json:",omitempty"`

 CustomImagesPartitions []string `json:",omitempty"`

 ProductRestrictVendorFiles       string   `json:",omitempty"`
 VendorProductRestrictVendorFiles string   `json:",omitempty"`
 VendorExceptionPaths             []string `json:",omitempty"`
 VendorExceptionModules           []string `json:",omitempty"`

 AllDistGoalOutputPairs []string `json:",omitempty"`
 AllDistSrcDstPairs     []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{
  BuildNumberFile: stringPtr("build_number.txt"),

  Platform_version_name:                  stringPtr("S"),
  Platform_base_sdk_extension_version:    intPtr(30),
  Platform_sdk_version:                   intPtr(30),
  Platform_sdk_codename:                  stringPtr("S"),
  Platform_sdk_final:                     boolPtr(false),
  Platform_version_active_codenames:      []string{"S"},
  Platform_version_all_preview_codenames: []string{"S"},

  HostArch:                    stringPtr("x86_64"),
  HostSecondaryArch:           stringPtr("x86"),
  DeviceName:                  stringPtr("generic_arm64"),
  DeviceProduct:               stringPtr("aosp_arm-eng"),
  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"},
  DeviceMaxPageSizeSupported:  stringPtr("4096"),
  DeviceNoBionicPageSizeMacro: boolPtr(false),

  AAPTConfig:          []string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
  AAPTPreferredConfig: stringPtr("xhdpi"),
  AAPTCharacteristics: stringPtr("nosdcard"),
  AAPTPrebuiltDPI:     []string{"xhdpi", "xxhdpi"},

  Malloc_low_memory:            boolPtr(false),
  Malloc_scudo_tsds_max:        boolPtr(false),
  Malloc_zero_contents:         boolPtr(true),
  Malloc_pattern_fill_contents: boolPtr(false),
  Safestack:                    boolPtr(false),
  Build_from_text_stub:         boolPtr(false),

  BootJars:     ConfiguredJarList{apexes: []string{}, jars: []string{}},
  ApexBootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
 }

 if runtime.GOOS == "linux" {
  v.CrossHost = stringPtr("windows")
  v.CrossHostArch = stringPtr("x86")
  v.CrossHostSecondaryArch = stringPtr("x86_64")
 }
}

func (this *ProductVariables) GetBuildFlagBool(flag string) bool {
 val, ok := this.BuildFlags[flag]
 if !ok {
  return false
 }
 return val == "true"
}

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).Elem()

 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.GetProperties(),
  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
 }
}