blob: a29c6f86a2891d6d72c559a153191c9d0921ba99 [file] [log] [blame]
Colin Cross7f64b6d2015-07-09 13:57:48 -07001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
Colin Cross635c3b02016-05-18 15:37:25 -070015package android
Colin Cross7f64b6d2015-07-09 13:57:48 -070016
17import (
18 "fmt"
19 "reflect"
Dan Willemsen490fd492015-11-24 17:53:15 -080020 "runtime"
Colin Cross7f64b6d2015-07-09 13:57:48 -070021 "strings"
22
Cole Faust701ca252021-11-23 19:02:08 -080023 "android/soong/android/soongconfig"
24 "android/soong/bazel"
25
Colin Cross7f64b6d2015-07-09 13:57:48 -070026 "github.com/google/blueprint/proptools"
27)
28
29func init() {
Paul Duffine7a055c2021-03-07 15:46:33 +000030 registerVariableBuildComponents(InitRegistrationContext)
31}
32
33func registerVariableBuildComponents(ctx RegistrationContext) {
34 ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
Colin Crosseabaedd2020-02-06 17:01:55 -080035 ctx.BottomUp("variable", VariableMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070036 })
Colin Cross7f64b6d2015-07-09 13:57:48 -070037}
38
Paul Duffine7a055c2021-03-07 15:46:33 +000039var PrepareForTestWithVariables = FixtureRegisterWithContext(registerVariableBuildComponents)
40
Colin Cross7f64b6d2015-07-09 13:57:48 -070041type variableProperties struct {
42 Product_variables struct {
Dan Willemsen47cf66b2015-09-16 16:48:54 -070043 Platform_sdk_version struct {
44 Asflags []string
Colin Crossceeff0f2017-05-08 13:43:00 -070045 Cflags []string
Dan Willemsen9fe14102021-07-13 21:52:04 -070046 Cmd *string
Dan Willemsen47cf66b2015-09-16 16:48:54 -070047 }
Colin Cross83163192015-12-01 16:31:16 -080048
Yuntao Xu402e9b02021-08-09 15:44:44 -070049 Platform_sdk_version_or_codename struct {
50 Java_resource_dirs []string
51 }
52
Anton Hanssonb021bf82021-08-27 17:35:40 +010053 Platform_sdk_extension_version struct {
54 Cmd *string
55 }
56
Dan Willemsen9fe14102021-07-13 21:52:04 -070057 Platform_version_name struct {
58 Base_dir *string
59 }
60
Colin Cross83163192015-12-01 16:31:16 -080061 // unbundled_build is a catch-all property to annotate modules that don't build in one or
62 // more unbundled branches, usually due to dependencies missing from the manifest.
63 Unbundled_build struct {
64 Enabled *bool `android:"arch_variant"`
65 } `android:"arch_variant"`
Dan Willemsen496e3952016-01-05 14:27:55 -080066
Dan Willemsen97cae012016-03-01 14:08:42 -080067 Malloc_not_svelte struct {
Christopher Ferrisc71193a2019-12-16 09:55:10 -080068 Cflags []string `android:"arch_variant"`
69 Shared_libs []string `android:"arch_variant"`
70 Whole_static_libs []string `android:"arch_variant"`
71 Exclude_static_libs []string `android:"arch_variant"`
Christopher Ferrisdea66172021-09-24 00:07:53 -070072 Srcs []string `android:"arch_variant"`
73 Header_libs []string `android:"arch_variant"`
Sasha Smundak61ebf8d2018-08-31 16:56:05 -070074 } `android:"arch_variant"`
Evgenii Stepanov8391efa2016-05-12 18:04:18 -070075
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -070076 Malloc_zero_contents struct {
77 Cflags []string `android:"arch_variant"`
78 } `android:"arch_variant"`
79
80 Malloc_pattern_fill_contents struct {
81 Cflags []string `android:"arch_variant"`
82 } `android:"arch_variant"`
83
Evgenii Stepanov8391efa2016-05-12 18:04:18 -070084 Safestack struct {
85 Cflags []string `android:"arch_variant"`
86 } `android:"arch_variant"`
Dan Willemsena6f7d152016-07-12 14:57:40 -070087
Dan Willemsen1be35382016-07-25 17:42:18 -070088 Binder32bit struct {
89 Cflags []string
90 }
Dan Willemsenfcebcd52016-09-22 14:49:10 -070091
Colin Cross95436422017-05-04 13:57:05 -070092 Override_rs_driver struct {
93 Cflags []string
94 }
95
Steven Morelandc2b9f062017-12-13 14:06:20 -080096 // treble_linker_namespaces is true when the system/vendor linker namespace separation is
97 // enabled.
98 Treble_linker_namespaces struct {
99 Cflags []string
100 }
Steven Morelandc2b9f062017-12-13 14:06:20 -0800101 // enforce_vintf_manifest is true when a device is required to have a vintf manifest.
102 Enforce_vintf_manifest struct {
103 Cflags []string
104 }
105
Colin Cross6bc59ef2016-12-08 09:46:35 -0800106 // debuggable is true for eng and userdebug builds, and can be used to turn on additional
107 // debugging features that don't significantly impact runtime behavior. userdebug builds
108 // are used for dogfooding and performance testing, and should be as similar to user builds
109 // as possible.
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700110 Debuggable struct {
Sasha Smundakb6d23052019-04-01 18:37:36 -0700111 Cflags []string
112 Cppflags []string
113 Init_rc []string
114 Required []string
115 Host_required []string
116 Target_required []string
Philip Cuadra328e0bf2020-10-19 22:01:29 -0700117 Strip struct {
118 All *bool
119 Keep_symbols *bool
120 Keep_symbols_and_debug_frame *bool
121 }
Yifan Hong8f323ae2021-06-23 20:01:13 -0700122 Static_libs []string
123 Whole_static_libs []string
124 Shared_libs []string
Jiyong Park16e77a92021-08-30 18:43:19 +0900125
126 Cmdline []string
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700127 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800128
129 // eng is true for -eng builds, and can be used to turn on additionaly heavyweight debugging
130 // features.
131 Eng struct {
132 Cflags []string
133 Cppflags []string
John Reck1d2b7ee2018-07-11 11:01:59 -0700134 Lto struct {
135 Never *bool
136 }
Colin Cross3273cc22018-10-26 23:58:42 -0700137 Sanitize struct {
138 Address *bool
139 }
Felka Changf13642e2019-06-21 20:58:27 +0800140 Optimize struct {
141 Enabled *bool
142 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800143 }
Colin Crossb2123aa2017-05-05 13:37:11 -0700144
145 Pdk struct {
Colin Cross99967a72017-10-17 13:55:02 -0700146 Enabled *bool `android:"arch_variant"`
147 } `android:"arch_variant"`
Dmitry Shmidtdba54192017-08-23 14:58:37 -0700148
149 Uml struct {
150 Cppflags []string
151 }
Risanea004dd2017-11-27 18:14:46 +0900152
153 Arc struct {
Satoshi Niwa54f48262020-12-18 09:53:26 +0900154 Cflags []string `android:"arch_variant"`
155 Exclude_srcs []string `android:"arch_variant"`
Jasmine Chenacace422021-03-05 00:56:40 +0800156 Header_libs []string `android:"arch_variant"`
Satoshi Niwa54f48262020-12-18 09:53:26 +0900157 Include_dirs []string `android:"arch_variant"`
158 Shared_libs []string `android:"arch_variant"`
159 Static_libs []string `android:"arch_variant"`
160 Srcs []string `android:"arch_variant"`
161 Whole_static_libs []string `android:"arch_variant"`
162 } `android:"arch_variant"`
Roland Levillain2879d412019-08-13 15:00:18 +0100163
164 Flatten_apex struct {
165 Enabled *bool
166 }
Peter Collingbournec66baf72019-10-29 11:00:15 -0700167
Colin Crossd9a121b2020-01-27 13:26:42 -0800168 Native_coverage struct {
Colin Cross2b10ba02020-02-05 16:23:21 -0800169 Src *string `android:"arch_variant"`
Colin Crossd9a121b2020-01-27 13:26:42 -0800170 Srcs []string `android:"arch_variant"`
171 Exclude_srcs []string `android:"arch_variant"`
172 } `android:"arch_variant"`
Colin Cross83163192015-12-01 16:31:16 -0800173 } `android:"arch_variant"`
Colin Cross7f64b6d2015-07-09 13:57:48 -0700174}
175
Colin Cross6961a492020-02-06 16:57:45 -0800176var defaultProductVariables interface{} = variableProperties{}
Colin Cross7f64b6d2015-07-09 13:57:48 -0700177
Colin Cross485e5722015-08-27 13:28:01 -0700178type productVariables struct {
Dan Willemsen174978c2016-05-11 00:27:49 -0700179 // Suffix to add to generated Makefiles
180 Make_suffix *string `json:",omitempty"`
181
Colin Cross2a2e0db2020-02-21 16:55:46 -0800182 BuildId *string `json:",omitempty"`
183 BuildNumberFile *string `json:",omitempty"`
Nan Zhang581fd212018-01-10 16:06:12 -0800184
Colin Cross092c9da2019-04-02 22:56:43 -0700185 Platform_version_name *string `json:",omitempty"`
186 Platform_sdk_version *int `json:",omitempty"`
187 Platform_sdk_codename *string `json:",omitempty"`
Yuntao Xu402e9b02021-08-09 15:44:44 -0700188 Platform_sdk_version_or_codename *string `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700189 Platform_sdk_final *bool `json:",omitempty"`
Anton Hanssonb021bf82021-08-27 17:35:40 +0100190 Platform_sdk_extension_version *int `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700191 Platform_version_active_codenames []string `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700192 Platform_vndk_version *string `json:",omitempty"`
193 Platform_systemsdk_versions []string `json:",omitempty"`
194 Platform_security_patch *string `json:",omitempty"`
195 Platform_preview_sdk_version *string `json:",omitempty"`
196 Platform_min_supported_target_sdk_version *string `json:",omitempty"`
197 Platform_base_os *string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700198
Jeongik Cha219141c2020-08-06 23:00:37 +0900199 DeviceName *string `json:",omitempty"`
200 DeviceArch *string `json:",omitempty"`
201 DeviceArchVariant *string `json:",omitempty"`
202 DeviceCpuVariant *string `json:",omitempty"`
203 DeviceAbi []string `json:",omitempty"`
204 DeviceVndkVersion *string `json:",omitempty"`
205 DeviceCurrentApiLevelForVendorModules *string `json:",omitempty"`
206 DeviceSystemSdkVersions []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700207
Jose Galmes6f843bc2020-12-11 13:36:29 -0800208 RecoverySnapshotVersion *string `json:",omitempty"`
209
Colin Crossa74ca042019-01-31 14:31:51 -0800210 DeviceSecondaryArch *string `json:",omitempty"`
211 DeviceSecondaryArchVariant *string `json:",omitempty"`
212 DeviceSecondaryCpuVariant *string `json:",omitempty"`
213 DeviceSecondaryAbi []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700214
dimitry8d6dde82019-07-11 10:23:53 +0200215 NativeBridgeArch *string `json:",omitempty"`
216 NativeBridgeArchVariant *string `json:",omitempty"`
217 NativeBridgeCpuVariant *string `json:",omitempty"`
218 NativeBridgeAbi []string `json:",omitempty"`
219 NativeBridgeRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100220
dimitry8d6dde82019-07-11 10:23:53 +0200221 NativeBridgeSecondaryArch *string `json:",omitempty"`
222 NativeBridgeSecondaryArchVariant *string `json:",omitempty"`
223 NativeBridgeSecondaryCpuVariant *string `json:",omitempty"`
224 NativeBridgeSecondaryAbi []string `json:",omitempty"`
225 NativeBridgeSecondaryRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100226
Colin Cross4225f652015-09-17 14:33:42 -0700227 HostArch *string `json:",omitempty"`
228 HostSecondaryArch *string `json:",omitempty"`
Colin Cross528d67e2021-07-23 22:23:07 +0000229 HostMusl *bool `json:",omitempty"`
Dan Willemsen490fd492015-11-24 17:53:15 -0800230
231 CrossHost *string `json:",omitempty"`
232 CrossHostArch *string `json:",omitempty"`
233 CrossHostSecondaryArch *string `json:",omitempty"`
Colin Cross83163192015-12-01 16:31:16 -0800234
Jeongik Chacee5ba92021-02-19 12:11:51 +0900235 DeviceResourceOverlays []string `json:",omitempty"`
236 ProductResourceOverlays []string `json:",omitempty"`
237 EnforceRROTargets []string `json:",omitempty"`
Colin Crossa74ca042019-01-31 14:31:51 -0800238 EnforceRROExcludedOverlays []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700239
Colin Crossa74ca042019-01-31 14:31:51 -0800240 AAPTCharacteristics *string `json:",omitempty"`
241 AAPTConfig []string `json:",omitempty"`
242 AAPTPreferredConfig *string `json:",omitempty"`
243 AAPTPrebuiltDPI []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700244
Colin Cross61ae0b72017-12-01 17:16:02 -0800245 DefaultAppCertificate *string `json:",omitempty"`
246
Colin Crossface4e42017-10-30 17:32:15 -0700247 AppsDefaultVersionName *string `json:",omitempty"`
248
Cole Faust701ca252021-11-23 19:02:08 -0800249 Allow_missing_dependencies *bool `json:",omitempty"`
250 Unbundled_build *bool `json:",omitempty"`
251 Unbundled_build_apps []string `json:",omitempty"`
252 Unbundled_build_image *bool `json:",omitempty"`
253 Always_use_prebuilt_sdks *bool `json:",omitempty"`
254 Skip_boot_jars_check *bool `json:",omitempty"`
255 Malloc_not_svelte *bool `json:",omitempty"`
256 Malloc_zero_contents *bool `json:",omitempty"`
257 Malloc_pattern_fill_contents *bool `json:",omitempty"`
258 Safestack *bool `json:",omitempty"`
259 HostStaticBinaries *bool `json:",omitempty"`
260 Binder32bit *bool `json:",omitempty"`
261 UseGoma *bool `json:",omitempty"`
262 UseRBE *bool `json:",omitempty"`
263 UseRBEJAVAC *bool `json:",omitempty"`
264 UseRBER8 *bool `json:",omitempty"`
265 UseRBED8 *bool `json:",omitempty"`
266 Debuggable *bool `json:",omitempty"`
267 Eng *bool `json:",omitempty"`
268 Treble_linker_namespaces *bool `json:",omitempty"`
269 Enforce_vintf_manifest *bool `json:",omitempty"`
270 Uml *bool `json:",omitempty"`
271 Arc *bool `json:",omitempty"`
272 MinimizeJavaDebugInfo *bool `json:",omitempty"`
Colin Cross16b23492016-01-06 14:41:07 -0800273
Logan Chien4fcea3d2018-11-20 11:59:08 +0800274 Check_elf_files *bool `json:",omitempty"`
275
Colin Cross5a0dcd52018-10-05 14:20:06 -0700276 UncompressPrivAppDex *bool `json:",omitempty"`
277 ModulesLoadedByPrivilegedModules []string `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800278
satayevd604b212021-07-21 14:23:52 +0100279 BootJars ConfiguredJarList `json:",omitempty"`
280 ApexBootJars ConfiguredJarList `json:",omitempty"`
Vladimir Markoe8b00d62018-12-21 15:54:16 +0000281
Colin Crossa74ca042019-01-31 14:31:51 -0800282 IntegerOverflowExcludePaths []string `json:",omitempty"`
Ivan Lozano5f595532017-07-13 14:46:05 -0700283
Colin Crossa74ca042019-01-31 14:31:51 -0800284 EnableCFI *bool `json:",omitempty"`
285 CFIExcludePaths []string `json:",omitempty"`
286 CFIIncludePaths []string `json:",omitempty"`
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -0700287
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -0800288 DisableScudo *bool `json:",omitempty"`
289
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -0800290 MemtagHeapExcludePaths []string `json:",omitempty"`
291 MemtagHeapAsyncIncludePaths []string `json:",omitempty"`
292 MemtagHeapSyncIncludePaths []string `json:",omitempty"`
293
Justin Yund5f6c822019-06-25 16:47:17 +0900294 VendorPath *string `json:",omitempty"`
295 OdmPath *string `json:",omitempty"`
296 ProductPath *string `json:",omitempty"`
297 SystemExtPath *string `json:",omitempty"`
Dan Willemsen4353bc42016-12-05 17:16:02 -0800298
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700299 ClangTidy *bool `json:",omitempty"`
300 TidyChecks *string `json:",omitempty"`
301
Jooyung Han03302ee2020-04-08 09:22:26 +0900302 SamplingPGO *bool `json:",omitempty"`
Yi Kongceb5b762020-03-20 15:22:27 +0800303
Roland Levillainada12702020-06-09 13:07:36 +0100304 JavaCoveragePaths []string `json:",omitempty"`
305 JavaCoverageExcludePaths []string `json:",omitempty"`
306
Colin Cross1a6acd42020-06-16 17:51:46 -0700307 GcovCoverage *bool `json:",omitempty"`
Roland Levillain4f5297b2020-06-09 12:44:06 +0100308 ClangCoverage *bool `json:",omitempty"`
309 NativeCoveragePaths []string `json:",omitempty"`
310 NativeCoverageExcludePaths []string `json:",omitempty"`
Dan Willemsen581341d2017-02-09 16:16:31 -0800311
Colin Cross1a6acd42020-06-16 17:51:46 -0700312 // Set by NewConfig
Liz Kammer09f947d2021-05-12 14:51:49 -0400313 Native_coverage *bool `json:",omitempty"`
Colin Cross1a6acd42020-06-16 17:51:46 -0700314
Colin Cross23ae82a2016-11-02 14:34:39 -0700315 SanitizeHost []string `json:",omitempty"`
316 SanitizeDevice []string `json:",omitempty"`
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700317 SanitizeDeviceDiag []string `json:",omitempty"`
Colin Cross23ae82a2016-11-02 14:34:39 -0700318 SanitizeDeviceArch []string `json:",omitempty"`
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800319
320 ArtUseReadBarrier *bool `json:",omitempty"`
Jack He8cc71432016-12-08 15:45:07 -0800321
322 BtConfigIncludeDir *string `json:",omitempty"`
Colin Cross95436422017-05-04 13:57:05 -0700323
324 Override_rs_driver *string `json:",omitempty"`
Jiyong Parkd773eb32017-07-03 13:18:12 +0900325
326 DeviceKernelHeaders []string `json:",omitempty"`
Justin Yun71549282017-11-17 12:10:28 +0900327
328 ExtraVndkVersions []string `json:",omitempty"`
Jeff Gaston088e29e2017-11-29 16:47:17 -0800329
330 NamespacesToExport []string `json:",omitempty"`
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -0800331
332 PgoAdditionalProfileDirs []string `json:",omitempty"`
Dan Willemsen0fe78662018-03-26 12:41:18 -0700333
Inseob Kimae553032019-05-14 18:52:49 +0900334 VndkUseCoreVariant *bool `json:",omitempty"`
335 VndkSnapshotBuildArtifacts *bool `json:",omitempty"`
Vic Yangefd249e2018-11-12 20:19:56 -0800336
Inseob Kim7cf14652021-01-06 23:06:52 +0900337 DirectedVendorSnapshot bool `json:",omitempty"`
338 VendorSnapshotModules map[string]bool `json:",omitempty"`
339
Jose Galmes4c6895e2021-02-09 07:44:30 -0800340 DirectedRecoverySnapshot bool `json:",omitempty"`
341 RecoverySnapshotModules map[string]bool `json:",omitempty"`
342
Justin DeMartino383bfb32021-02-24 10:49:43 -0800343 VendorSnapshotDirsIncluded []string `json:",omitempty"`
344 VendorSnapshotDirsExcluded []string `json:",omitempty"`
345 RecoverySnapshotDirsExcluded []string `json:",omitempty"`
346 RecoverySnapshotDirsIncluded []string `json:",omitempty"`
Rob Seymour925aa092021-08-10 20:42:03 +0000347 HostFakeSnapshotEnabled bool `json:",omitempty"`
Justin DeMartino383bfb32021-02-24 10:49:43 -0800348
Tri Vof544fe32018-05-20 14:34:48 -0700349 BoardVendorSepolicyDirs []string `json:",omitempty"`
350 BoardOdmSepolicyDirs []string `json:",omitempty"`
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900351 BoardReqdMaskPolicy []string `json:",omitempty"`
Felixa20a8752020-05-17 18:28:35 +0200352 SystemExtPublicSepolicyDirs []string `json:",omitempty"`
353 SystemExtPrivateSepolicyDirs []string `json:",omitempty"`
Inseob Kim0866b002019-04-15 20:21:29 +0900354 BoardSepolicyM4Defs []string `json:",omitempty"`
Tri Vo35a51432018-03-25 20:00:00 -0700355
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900356 BoardSepolicyVers *string `json:",omitempty"`
357 PlatformSepolicyVersion *string `json:",omitempty"`
Inseob Kima10ef272021-09-15 03:04:53 +0000358 TotSepolicyVersion *string `json:",omitempty"`
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900359
Dan Willemsen0fe78662018-03-26 12:41:18 -0700360 VendorVars map[string]map[string]string `json:",omitempty"`
Colin Cross395f2cf2018-10-24 16:10:32 -0700361
Dan Albertd05ba002021-04-13 15:55:47 -0700362 Ndk_abis *bool `json:",omitempty"`
Jiyong Park8fd61922018-11-08 02:50:25 +0900363
Jiyong Park4da07972021-01-05 21:01:11 +0900364 Flatten_apex *bool `json:",omitempty"`
365 ForceApexSymlinkOptimization *bool `json:",omitempty"`
366 CompressedApex *bool `json:",omitempty"`
367 Aml_abis *bool `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800368
369 DexpreoptGlobalConfig *string `json:",omitempty"`
Jiyong Park7f67f482019-01-05 12:57:48 +0900370
Inseob Kim7b85eeb2021-03-23 20:52:24 +0900371 WithDexpreopt bool `json:",omitempty"`
372
Jiyong Park7f67f482019-01-05 12:57:48 +0900373 ManifestPackageNameOverrides []string `json:",omitempty"`
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800374 CertificateOverrides []string `json:",omitempty"`
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800375 PackageNameOverrides []string `json:",omitempty"`
Jeongik Chac9464142019-01-07 12:07:27 +0900376
377 EnforceSystemCertificate *bool `json:",omitempty"`
Colin Cross440e0d02020-06-11 11:32:11 -0700378 EnforceSystemCertificateAllowList []string `json:",omitempty"`
Colin Cross8faf8fc2019-01-16 15:15:52 -0800379
Colin Crossf24a22a2019-01-31 14:12:44 -0800380 ProductHiddenAPIStubs []string `json:",omitempty"`
381 ProductHiddenAPIStubsSystem []string `json:",omitempty"`
382 ProductHiddenAPIStubsTest []string `json:",omitempty"`
Dan Willemsen71c74602019-04-10 12:27:35 -0700383
Inseob Kim0866b002019-04-15 20:21:29 +0900384 ProductPublicSepolicyDirs []string `json:",omitempty"`
385 ProductPrivateSepolicyDirs []string `json:",omitempty"`
Inseob Kim0866b002019-04-15 20:21:29 +0900386
Justin Yun5f7f7e82019-11-18 19:52:14 +0900387 ProductVndkVersion *string `json:",omitempty"`
388
Dan Willemsen54879d12019-04-18 10:08:46 -0700389 TargetFSConfigGen []string `json:",omitempty"`
Colin Cross50ddcc42019-05-16 12:28:22 -0700390
391 MissingUsesLibraries []string `json:",omitempty"`
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900392
393 EnforceProductPartitionInterface *bool `json:",omitempty"`
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900394
JaeMan Parkff715562020-10-19 17:25:58 +0900395 EnforceInterPartitionJavaSdkLibrary *bool `json:",omitempty"`
396 InterPartitionJavaLibraryAllowList []string `json:",omitempty"`
397
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900398 InstallExtraFlattenedApexes *bool `json:",omitempty"`
Yifan Hong82db7352020-01-21 16:12:26 -0800399
400 BoardUsesRecoveryAsBoot *bool `json:",omitempty"`
Yifan Hong97365ee2020-07-29 09:51:57 -0700401
Yifan Hong42bef8d2020-08-05 14:36:09 -0700402 BoardKernelBinaries []string `json:",omitempty"`
403 BoardKernelModuleInterfaceVersions []string `json:",omitempty"`
Yifan Hongdd8dacc2020-10-21 15:40:17 -0700404
405 BoardMoveRecoveryResourcesToVendorBoot *bool `json:",omitempty"`
Bill Peckhambae47492021-01-08 09:34:44 -0800406
407 PrebuiltHiddenApiDir *string `json:",omitempty"`
Inseob Kim60c32f02020-12-21 22:53:05 +0900408
409 ShippingApiLevel *string `json:",omitempty"`
Inseob Kim0cac7b42021-02-03 18:16:46 +0900410
Inseob Kim67e5add192021-03-17 18:05:33 +0900411 BuildBrokenEnforceSyspropOwner bool `json:",omitempty"`
412 BuildBrokenTrebleSyspropNeverallow bool `json:",omitempty"`
Inseob Kim0cac7b42021-02-03 18:16:46 +0900413 BuildBrokenVendorPropertyNamespace bool `json:",omitempty"`
Inseob Kim67e5add192021-03-17 18:05:33 +0900414
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -0700415 BuildDebugfsRestrictionsEnabled bool `json:",omitempty"`
416
Inseob Kim67e5add192021-03-17 18:05:33 +0900417 RequiresInsecureExecmemForSwiftshader bool `json:",omitempty"`
418
419 SelinuxIgnoreNeverallows bool `json:",omitempty"`
420
421 SepolicySplit bool `json:",omitempty"`
Inseob Kima10ef272021-09-15 03:04:53 +0000422
423 SepolicyFreezeTestExtraDirs []string `json:",omitempty"`
424 SepolicyFreezeTestExtraPrebuiltDirs []string `json:",omitempty"`
Jiyong Parkd163d4d2021-10-12 16:47:43 +0900425
426 GenerateAidlNdkPlatformBackend bool `json:",omitempty"`
Colin Crossa6bc19e2015-09-16 13:53:42 -0700427}
428
429func boolPtr(v bool) *bool {
430 return &v
Colin Cross485e5722015-08-27 13:28:01 -0700431}
432
Dan Willemsen47cf66b2015-09-16 16:48:54 -0700433func intPtr(v int) *int {
434 return &v
435}
436
Colin Cross4225f652015-09-17 14:33:42 -0700437func stringPtr(v string) *string {
438 return &v
439}
440
Colin Cross27385972015-09-18 10:57:10 -0700441func (v *productVariables) SetDefaultConfig() {
442 *v = productVariables{
Colin Cross2a2e0db2020-02-21 16:55:46 -0800443 BuildNumberFile: stringPtr("build_number.txt"),
Dan Willemsenb6d171b2019-04-07 09:41:44 -0700444
Jiyong Park84d8a7e2020-09-25 13:44:51 +0900445 Platform_version_name: stringPtr("S"),
446 Platform_sdk_version: intPtr(30),
447 Platform_sdk_codename: stringPtr("S"),
Dan Willemsenb6d171b2019-04-07 09:41:44 -0700448 Platform_sdk_final: boolPtr(false),
Jiyong Park84d8a7e2020-09-25 13:44:51 +0900449 Platform_version_active_codenames: []string{"S"},
450 Platform_vndk_version: stringPtr("S"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800451
Colin Cross4225f652015-09-17 14:33:42 -0700452 HostArch: stringPtr("x86_64"),
453 HostSecondaryArch: stringPtr("x86"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800454 DeviceName: stringPtr("generic_arm64"),
Colin Cross4225f652015-09-17 14:33:42 -0700455 DeviceArch: stringPtr("arm64"),
Dan Willemsena91d1272016-03-29 22:06:05 -0700456 DeviceArchVariant: stringPtr("armv8-a"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800457 DeviceCpuVariant: stringPtr("generic"),
Colin Crossa74ca042019-01-31 14:31:51 -0800458 DeviceAbi: []string{"arm64-v8a"},
Colin Cross4225f652015-09-17 14:33:42 -0700459 DeviceSecondaryArch: stringPtr("arm"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800460 DeviceSecondaryArchVariant: stringPtr("armv8-a"),
461 DeviceSecondaryCpuVariant: stringPtr("generic"),
Colin Crossa74ca042019-01-31 14:31:51 -0800462 DeviceSecondaryAbi: []string{"armeabi-v7a", "armeabi"},
Colin Crossface4e42017-10-30 17:32:15 -0700463
Colin Crossa74ca042019-01-31 14:31:51 -0800464 AAPTConfig: []string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700465 AAPTPreferredConfig: stringPtr("xhdpi"),
466 AAPTCharacteristics: stringPtr("nosdcard"),
Colin Crossa74ca042019-01-31 14:31:51 -0800467 AAPTPrebuiltDPI: []string{"xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700468
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700469 Malloc_not_svelte: boolPtr(true),
Steven Morelandd1342012020-07-30 20:38:49 +0000470 Malloc_zero_contents: boolPtr(true),
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700471 Malloc_pattern_fill_contents: boolPtr(false),
472 Safestack: boolPtr(false),
Lukacs T. Berki720b3962021-03-17 13:34:30 +0100473
satayevd604b212021-07-21 14:23:52 +0100474 BootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
475 ApexBootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
Colin Cross485e5722015-08-27 13:28:01 -0700476 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800477
478 if runtime.GOOS == "linux" {
479 v.CrossHost = stringPtr("windows")
480 v.CrossHostArch = stringPtr("x86")
Dan Willemsen07cd0512016-02-03 23:16:33 -0800481 v.CrossHostSecondaryArch = stringPtr("x86_64")
Dan Willemsen490fd492015-11-24 17:53:15 -0800482 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700483}
484
Liz Kammera060c452021-03-24 10:14:47 -0400485// ProductConfigContext requires the access to the Module to get product config properties.
486type ProductConfigContext interface {
487 Module() Module
488}
489
490// ProductConfigProperty contains the information for a single property (may be a struct) paired
491// with the appropriate ProductConfigVariable.
492type ProductConfigProperty struct {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000493 // The name of the product variable, e.g. "safestack", "malloc_not_svelte",
494 // "board"
Jingwen Chen25825ca2021-11-15 12:28:43 +0000495 Name string
Jingwen Chena47f28d2021-11-02 16:43:57 +0000496
497 // Namespace of the variable, if this is a soong_config_module_type variable
Jingwen Chen25825ca2021-11-15 12:28:43 +0000498 // e.g. "acme", "ANDROID", "vendor_name"
499 Namespace string
Jingwen Chena47f28d2021-11-02 16:43:57 +0000500
501 // Unique configuration to identify this product config property (i.e. a
502 // primary key), as just using the product variable name is not sufficient.
503 //
504 // For product variables, this is the product variable name + optional
505 // archvariant information. e.g.
506 //
507 // product_variables: {
508 // foo: {
509 // cflags: ["-Dfoo"],
510 // },
511 // },
512 //
513 // FullConfig would be "foo".
514 //
515 // target: {
516 // android: {
517 // product_variables: {
518 // foo: {
519 // cflags: ["-Dfoo-android"],
520 // },
521 // },
522 // },
523 // },
524 //
525 // FullConfig would be "foo-android".
526 //
527 // For soong config variables, this is the namespace + product variable name
528 // + value of the variable, if applicable. The value can also be
529 // conditions_default.
530 //
531 // e.g.
532 //
533 // soong_config_variables: {
534 // feature1: {
535 // conditions_default: {
536 // cflags: ["-DDEFAULT1"],
537 // },
538 // cflags: ["-DFEATURE1"],
539 // },
540 // }
541 //
542 // where feature1 is created in the "acme" namespace, so FullConfig would be
543 // "acme__feature1" and "acme__feature1__conditions_default".
544 //
545 // e.g.
546 //
547 // soong_config_variables: {
548 // board: {
549 // soc_a: {
550 // cflags: ["-DSOC_A"],
551 // },
552 // soc_b: {
553 // cflags: ["-DSOC_B"],
554 // },
555 // soc_c: {},
556 // conditions_default: {
557 // cflags: ["-DSOC_DEFAULT"]
558 // },
559 // },
560 // }
561 //
562 // where board is created in the "acme" namespace, so FullConfig would be
563 // "acme__board__soc_a", "acme__board__soc_b", and
564 // "acme__board__conditions_default"
565 FullConfig string
Liz Kammera060c452021-03-24 10:14:47 -0400566}
567
Jingwen Chen58ff6802021-11-17 12:14:41 +0000568func (p *ProductConfigProperty) AlwaysEmit() bool {
569 return p.Namespace != ""
570}
571
Jingwen Chena47f28d2021-11-02 16:43:57 +0000572func (p *ProductConfigProperty) ConfigurationAxis() bazel.ConfigurationAxis {
573 if p.Namespace == "" {
574 return bazel.ProductVariableConfigurationAxis(p.FullConfig)
575 } else {
576 // Soong config variables can be uniquely identified by the namespace
577 // (e.g. acme, android) and the product variable name (e.g. board, size)
Jingwen Chen25825ca2021-11-15 12:28:43 +0000578 return bazel.ProductVariableConfigurationAxis(p.Namespace + "__" + p.Name)
Jingwen Chena47f28d2021-11-02 16:43:57 +0000579 }
580}
581
Jingwen Chen25825ca2021-11-15 12:28:43 +0000582// SelectKey returns the literal string that represents this variable in a BUILD
583// select statement.
584func (p *ProductConfigProperty) SelectKey() string {
585 if p.Namespace == "" {
586 return strings.ToLower(p.FullConfig)
587 }
588
589 if p.FullConfig == bazel.ConditionsDefaultConfigKey {
590 return bazel.ConditionsDefaultConfigKey
591 }
592
593 value := p.FullConfig
594 if value == p.Name {
595 value = "enabled"
596 }
597 // e.g. acme__feature1__enabled, android__board__soc_a
598 return strings.ToLower(strings.Join([]string{p.Namespace, p.Name, value}, "__"))
599}
600
601// ProductConfigProperties is a map of maps to group property values according
602// their property name and the product config variable they're set under.
603//
604// The outer map key is the name of the property, like "cflags".
605//
606// The inner map key is a ProductConfigProperty, which is a struct of product
607// variable name, namespace, and the "full configuration" of the product
608// variable.
609//
610// e.g. product variable name: board, namespace: acme, full config: vendor_chip_foo
611//
612// The value of the map is the interface{} representing the value of the
613// property, like ["-DDEFINES"] for cflags.
614type ProductConfigProperties map[string]map[ProductConfigProperty]interface{}
Liz Kammera060c452021-03-24 10:14:47 -0400615
616// ProductVariableProperties returns a ProductConfigProperties containing only the properties which
617// have been set for the module in the given context.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000618func ProductVariableProperties(ctx BazelConversionPathContext) ProductConfigProperties {
Liz Kammera060c452021-03-24 10:14:47 -0400619 module := ctx.Module()
620 moduleBase := module.base()
621
622 productConfigProperties := ProductConfigProperties{}
623
Jingwen Chena47f28d2021-11-02 16:43:57 +0000624 if moduleBase.variableProperties != nil {
625 productVariablesProperty := proptools.FieldNameForProperty("product_variables")
626 productVariableValues(
627 productVariablesProperty,
628 moduleBase.variableProperties,
629 "",
630 "",
631 &productConfigProperties)
632
633 for _, configToProps := range moduleBase.GetArchVariantProperties(ctx, moduleBase.variableProperties) {
634 for config, props := range configToProps {
635 // GetArchVariantProperties is creating an instance of the requested type
636 // and productVariablesValues expects an interface, so no need to cast
637 productVariableValues(
638 productVariablesProperty,
639 props,
640 "",
641 config,
642 &productConfigProperties)
643 }
644 }
Liz Kammera060c452021-03-24 10:14:47 -0400645 }
646
Jingwen Chena47f28d2021-11-02 16:43:57 +0000647 if m, ok := module.(Bazelable); ok && m.namespacedVariableProps() != nil {
Jingwen Chen84817de2021-11-17 10:57:35 +0000648 for namespace, namespacedVariableProps := range m.namespacedVariableProps() {
649 for _, namespacedVariableProp := range namespacedVariableProps {
650 productVariableValues(
651 soongconfig.SoongConfigProperty,
652 namespacedVariableProp,
653 namespace,
654 "",
655 &productConfigProperties)
656 }
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -0400657 }
Liz Kammere3e4a5f2021-05-10 11:39:53 -0400658 }
659
Jingwen Chen58ff6802021-11-17 12:14:41 +0000660 productConfigProperties.zeroValuesForNamespacedVariables()
661
Liz Kammere3e4a5f2021-05-10 11:39:53 -0400662 return productConfigProperties
663}
664
Jingwen Chen58ff6802021-11-17 12:14:41 +0000665// zeroValuesForNamespacedVariables ensures that selects that contain __only__
666// conditions default values have zero values set for the other non-default
667// values for that select statement.
668//
669// If the ProductConfigProperties map contains these items, as parsed from the .bp file:
670//
671// library_linking_strategy: {
672// prefer_static: {
673// static_libs: [
674// "lib_a",
675// "lib_b",
676// ],
677// },
678// conditions_default: {
679// shared_libs: [
680// "lib_a",
681// "lib_b",
682// ],
683// },
684// },
685//
686// Static_libs {Library_linking_strategy ANDROID prefer_static} [lib_a lib_b]
687// Shared_libs {Library_linking_strategy ANDROID conditions_default} [lib_a lib_b]
688//
689// We need to add this:
690//
691// Shared_libs {Library_linking_strategy ANDROID prefer_static} []
692//
693// so that the following gets generated for the "dynamic_deps" attribute,
694// instead of putting lib_a and lib_b directly into dynamic_deps without a
695// select:
696//
697// dynamic_deps = select({
698// "//build/bazel/product_variables:android__library_linking_strategy__prefer_static": [],
699// "//conditions:default": [
700// "//foo/bar:lib_a",
701// "//foo/bar:lib_b",
702// ],
703// }),
704func (props *ProductConfigProperties) zeroValuesForNamespacedVariables() {
705 // A map of product config properties to the zero values of their respective
706 // property value.
707 zeroValues := make(map[ProductConfigProperty]interface{})
708
709 // A map of prop names (e.g. cflags) to product config properties where the
710 // (prop name, ProductConfigProperty) tuple contains a non-conditions_default key.
711 //
712 // e.g.
713 //
714 // prefer_static: {
715 // static_libs: [
716 // "lib_a",
717 // "lib_b",
718 // ],
719 // },
720 // conditions_default: {
721 // shared_libs: [
722 // "lib_a",
723 // "lib_b",
724 // ],
725 // },
726 //
727 // The tuple of ("static_libs", prefer_static) would be in this map.
728 hasNonDefaultValue := make(map[string]map[ProductConfigProperty]bool)
729
730 // Iterate over all added soong config variables.
731 for propName, v := range *props {
732 for p, intf := range v {
733 if p.Namespace == "" {
734 // If there's no namespace, this isn't a soong config variable,
735 // i.e. this is a product variable. product variables have no
736 // conditions_defaults, so skip them.
737 continue
738 }
739 if p.FullConfig == bazel.ConditionsDefaultConfigKey {
740 // Skip conditions_defaults.
741 continue
742 }
743 if hasNonDefaultValue[propName] == nil {
744 hasNonDefaultValue[propName] = make(map[ProductConfigProperty]bool)
745 hasNonDefaultValue[propName][p] = false
746 }
747 // Create the zero value of the variable.
748 if _, exists := zeroValues[p]; !exists {
749 zeroValue := reflect.Zero(reflect.ValueOf(intf).Type()).Interface()
750 if zeroValue == nil {
751 panic(fmt.Errorf("Expected non-nil zero value for product/config variable %+v\n", intf))
752 }
753 zeroValues[p] = zeroValue
754 }
755 hasNonDefaultValue[propName][p] = true
756 }
757 }
758
759 for propName := range *props {
760 for p, zeroValue := range zeroValues {
761 // Ignore variables that already have a non-default value for that axis
762 if exists, _ := hasNonDefaultValue[propName][p]; !exists {
763 // fmt.Println(propName, p.Namespace, p.Name, p.FullConfig, zeroValue)
764 // Insert the zero value for this propname + product config value.
765 props.AddProductConfigProperty(
766 propName,
767 p.Namespace,
768 p.Name,
769 p.FullConfig,
770 zeroValue,
771 )
772 }
773 }
774 }
775}
776
Jingwen Chena47f28d2021-11-02 16:43:57 +0000777func (p *ProductConfigProperties) AddProductConfigProperty(
778 propertyName, namespace, productVariableName, config string, property interface{}) {
779 if (*p)[propertyName] == nil {
Jingwen Chen25825ca2021-11-15 12:28:43 +0000780 (*p)[propertyName] = make(map[ProductConfigProperty]interface{})
Jingwen Chena47f28d2021-11-02 16:43:57 +0000781 }
782
Jingwen Chen25825ca2021-11-15 12:28:43 +0000783 productConfigProp := ProductConfigProperty{
784 Namespace: namespace, // e.g. acme, android
785 Name: productVariableName, // e.g. size, feature1, feature2, FEATURE3, board
786 FullConfig: config, // e.g. size, feature1-x86, size__conditions_default
Jingwen Chena47f28d2021-11-02 16:43:57 +0000787 }
Jingwen Chen25825ca2021-11-15 12:28:43 +0000788
Jingwen Chen84817de2021-11-17 10:57:35 +0000789 if existing, ok := (*p)[propertyName][productConfigProp]; ok && namespace != "" {
790 switch dst := existing.(type) {
791 case []string:
792 if src, ok := property.([]string); ok {
793 dst = append(dst, src...)
794 (*p)[propertyName][productConfigProp] = dst
795 }
796 default:
Jingwen Chen58ff6802021-11-17 12:14:41 +0000797 panic(fmt.Errorf("TODO: handle merging value %s", existing))
Jingwen Chen84817de2021-11-17 10:57:35 +0000798 }
799 } else {
800 (*p)[propertyName][productConfigProp] = property
801 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000802}
803
804var (
805 conditionsDefaultField string = proptools.FieldNameForProperty(bazel.ConditionsDefaultConfigKey)
806)
807
808// maybeExtractConfigVarProp attempts to read this value as a config var struct
809// wrapped by interfaces and ptrs. If it's not the right type, the second return
810// value is false.
811func maybeExtractConfigVarProp(v reflect.Value) (reflect.Value, bool) {
812 if v.Kind() == reflect.Interface {
813 // The conditions_default value can be either
814 // 1) an ptr to an interface of a struct (bool config variables and product variables)
815 // 2) an interface of 1) (config variables with nested structs, like string vars)
816 v = v.Elem()
817 }
818 if v.Kind() != reflect.Ptr {
819 return v, false
820 }
821 v = reflect.Indirect(v)
822 if v.Kind() == reflect.Interface {
823 // Extract the struct from the interface
824 v = v.Elem()
825 }
826
827 if !v.IsValid() {
828 return v, false
829 }
830
831 if v.Kind() != reflect.Struct {
832 return v, false
833 }
834 return v, true
835}
836
Jingwen Chen84817de2021-11-17 10:57:35 +0000837func (productConfigProperties *ProductConfigProperties) AddProductConfigProperties(namespace, suffix string, variableValues reflect.Value) {
838 // variableValues can either be a product_variables or
839 // soong_config_variables struct.
840 //
Jingwen Chena47f28d2021-11-02 16:43:57 +0000841 // Example of product_variables:
842 //
843 // product_variables: {
844 // malloc_not_svelte: {
845 // shared_libs: ["malloc_not_svelte_shared_lib"],
846 // whole_static_libs: ["malloc_not_svelte_whole_static_lib"],
847 // exclude_static_libs: [
848 // "malloc_not_svelte_static_lib_excludes",
849 // "malloc_not_svelte_whole_static_lib_excludes",
850 // ],
851 // },
852 // },
853 //
854 // Example of soong_config_variables:
855 //
856 // soong_config_variables: {
857 // feature1: {
858 // conditions_default: {
859 // ...
860 // },
861 // cflags: ...
862 // },
863 // feature2: {
864 // cflags: ...
865 // conditions_default: {
866 // ...
867 // },
868 // },
869 // board: {
870 // soc_a: {
871 // ...
872 // },
873 // soc_a: {
874 // ...
875 // },
876 // soc_c: {},
877 // conditions_default: {
878 // ...
879 // },
880 // },
881 // }
Liz Kammera060c452021-03-24 10:14:47 -0400882 for i := 0; i < variableValues.NumField(); i++ {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000883 // e.g. Platform_sdk_version, Unbundled_build, Malloc_not_svelte, etc.
884 productVariableName := variableValues.Type().Field(i).Name
885
Liz Kammera060c452021-03-24 10:14:47 -0400886 variableValue := variableValues.Field(i)
887 // Check if any properties were set for the module
888 if variableValue.IsZero() {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000889 // e.g. feature1: {}, malloc_not_svelte: {}
Liz Kammera060c452021-03-24 10:14:47 -0400890 continue
891 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000892
893 // Unlike product variables, config variables require a few more
894 // indirections to extract the struct from the reflect.Value.
895 if v, ok := maybeExtractConfigVarProp(variableValue); ok {
896 variableValue = v
897 }
898
Liz Kammera060c452021-03-24 10:14:47 -0400899 for j := 0; j < variableValue.NumField(); j++ {
900 property := variableValue.Field(j)
901 // If the property wasn't set, no need to pass it along
902 if property.IsZero() {
903 continue
904 }
905
906 // e.g. Asflags, Cflags, Enabled, etc.
907 propertyName := variableValue.Type().Field(j).Name
Jingwen Chena47f28d2021-11-02 16:43:57 +0000908
909 if v, ok := maybeExtractConfigVarProp(property); ok {
910 // The field is a struct, which is used by:
911 // 1) soong_config_string_variables
912 //
913 // soc_a: {
914 // cflags: ...,
915 // }
916 //
917 // soc_b: {
918 // cflags: ...,
919 // }
920 //
921 // 2) conditions_default structs for all soong config variable types.
922 //
923 // conditions_default: {
924 // cflags: ...,
925 // static_libs: ...
926 // }
927 field := v
928 for k := 0; k < field.NumField(); k++ {
929 // Iterate over fields of this struct prop.
930 if field.Field(k).IsZero() {
931 continue
932 }
Jingwen Chen25825ca2021-11-15 12:28:43 +0000933 // config can also be "conditions_default".
934 config := proptools.PropertyNameForField(propertyName)
Jingwen Chena47f28d2021-11-02 16:43:57 +0000935 actualPropertyName := field.Type().Field(k).Name
936
937 productConfigProperties.AddProductConfigProperty(
938 actualPropertyName, // e.g. cflags, static_libs
939 namespace, // e.g. acme, android
940 productVariableName, // e.g. size, feature1, FEATURE2, board
941 config,
942 field.Field(k).Interface(), // e.g. ["-DDEFAULT"], ["foo", "bar"]
943 )
944 }
Jingwen Chen58ff6802021-11-17 12:14:41 +0000945 } else if property.Kind() != reflect.Interface {
946 // If not an interface, then this is not a conditions_default or
947 // a struct prop. That is, this is a regular product variable,
948 // or a bool/value config variable.
Jingwen Chena47f28d2021-11-02 16:43:57 +0000949 config := productVariableName + suffix
Jingwen Chena47f28d2021-11-02 16:43:57 +0000950 productConfigProperties.AddProductConfigProperty(
951 propertyName,
952 namespace,
953 productVariableName,
954 config,
955 property.Interface(),
956 )
Liz Kammer47535c52021-06-02 16:02:22 -0400957 }
Liz Kammera060c452021-03-24 10:14:47 -0400958 }
959 }
Liz Kammera060c452021-03-24 10:14:47 -0400960}
961
Jingwen Chen84817de2021-11-17 10:57:35 +0000962// productVariableValues uses reflection to convert a property struct for
963// product_variables and soong_config_variables to structs that can be generated
964// as select statements.
965func productVariableValues(
966 fieldName string, variableProps interface{}, namespace, suffix string, productConfigProperties *ProductConfigProperties) {
967 if suffix != "" {
968 suffix = "-" + suffix
969 }
970
971 // variableValues represent the product_variables or soong_config_variables struct.
972 variableValues := reflect.ValueOf(variableProps).Elem().FieldByName(fieldName)
973 productConfigProperties.AddProductConfigProperties(namespace, suffix, variableValues)
974}
975
Colin Crosseabaedd2020-02-06 17:01:55 -0800976func VariableMutator(mctx BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700977 var module Module
Colin Cross7f64b6d2015-07-09 13:57:48 -0700978 var ok bool
Colin Cross635c3b02016-05-18 15:37:25 -0700979 if module, ok = mctx.Module().(Module); !ok {
Colin Cross7f64b6d2015-07-09 13:57:48 -0700980 return
981 }
982
983 // TODO: depend on config variable, create variants, propagate variants up tree
984 a := module.base()
Colin Cross18c46802019-09-24 22:19:02 -0700985
986 if a.variableProperties == nil {
987 return
988 }
989
990 variableValues := reflect.ValueOf(a.variableProperties).Elem().FieldByName("Product_variables")
Colin Cross7f64b6d2015-07-09 13:57:48 -0700991
Colin Cross0cec3122021-01-20 11:27:32 -0800992 productVariables := reflect.ValueOf(mctx.Config().productVariables)
993
Colin Cross7f64b6d2015-07-09 13:57:48 -0700994 for i := 0; i < variableValues.NumField(); i++ {
995 variableValue := variableValues.Field(i)
Colin Cross485e5722015-08-27 13:28:01 -0700996 name := variableValues.Type().Field(i).Name
997 property := "product_variables." + proptools.PropertyNameForField(name)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700998
Colin Crossa6bc19e2015-09-16 13:53:42 -0700999 // Check that the variable was set for the product
Colin Cross0cec3122021-01-20 11:27:32 -08001000 val := productVariables.FieldByName(name)
Colin Crossa6bc19e2015-09-16 13:53:42 -07001001 if !val.IsValid() || val.Kind() != reflect.Ptr || val.IsNil() {
1002 continue
Colin Cross7f64b6d2015-07-09 13:57:48 -07001003 }
Colin Crossa6bc19e2015-09-16 13:53:42 -07001004
1005 val = val.Elem()
1006
1007 // For bools, check that the value is true
1008 if val.Kind() == reflect.Bool && val.Bool() == false {
1009 continue
1010 }
1011
1012 // Check if any properties were set for the module
Colin Cross6961a492020-02-06 16:57:45 -08001013 if variableValue.IsZero() {
Colin Crossa6bc19e2015-09-16 13:53:42 -07001014 continue
1015 }
Colin Crossa6bc19e2015-09-16 13:53:42 -07001016 a.setVariableProperties(mctx, property, variableValue, val.Interface())
Colin Cross7f64b6d2015-07-09 13:57:48 -07001017 }
1018}
1019
Colin Cross4157e882019-06-06 16:57:04 -07001020func (m *ModuleBase) setVariableProperties(ctx BottomUpMutatorContext,
Colin Cross7f64b6d2015-07-09 13:57:48 -07001021 prefix string, productVariablePropertyValue reflect.Value, variableValue interface{}) {
1022
Colin Cross7e0eaf12017-05-05 16:16:24 -07001023 printfIntoProperties(ctx, prefix, productVariablePropertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001024
Colin Cross4157e882019-06-06 16:57:04 -07001025 err := proptools.AppendMatchingProperties(m.generalProperties,
Colin Cross06a931b2015-10-28 17:23:31 -07001026 productVariablePropertyValue.Addr().Interface(), nil)
1027 if err != nil {
1028 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1029 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1030 } else {
1031 panic(err)
1032 }
1033 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001034}
1035
Colin Cross7e0eaf12017-05-05 16:16:24 -07001036func printfIntoPropertiesError(ctx BottomUpMutatorContext, prefix string,
1037 productVariablePropertyValue reflect.Value, i int, err error) {
1038
1039 field := productVariablePropertyValue.Type().Field(i).Name
1040 property := prefix + "." + proptools.PropertyNameForField(field)
1041 ctx.PropertyErrorf(property, "%s", err)
1042}
1043
1044func printfIntoProperties(ctx BottomUpMutatorContext, prefix string,
1045 productVariablePropertyValue reflect.Value, variableValue interface{}) {
1046
Colin Cross7f64b6d2015-07-09 13:57:48 -07001047 for i := 0; i < productVariablePropertyValue.NumField(); i++ {
1048 propertyValue := productVariablePropertyValue.Field(i)
Colin Crossdd0dbe62015-12-02 15:24:38 -08001049 kind := propertyValue.Kind()
1050 if kind == reflect.Ptr {
1051 if propertyValue.IsNil() {
1052 continue
1053 }
1054 propertyValue = propertyValue.Elem()
1055 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001056 switch propertyValue.Kind() {
1057 case reflect.String:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001058 err := printfIntoProperty(propertyValue, variableValue)
1059 if err != nil {
1060 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
1061 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001062 case reflect.Slice:
1063 for j := 0; j < propertyValue.Len(); j++ {
Colin Cross7e0eaf12017-05-05 16:16:24 -07001064 err := printfIntoProperty(propertyValue.Index(j), variableValue)
1065 if err != nil {
1066 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
1067 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001068 }
Colin Crossdd0dbe62015-12-02 15:24:38 -08001069 case reflect.Bool:
1070 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -07001071 case reflect.Struct:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001072 printfIntoProperties(ctx, prefix, propertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001073 default:
1074 panic(fmt.Errorf("unsupported field kind %q", propertyValue.Kind()))
1075 }
1076 }
1077}
1078
Colin Cross7e0eaf12017-05-05 16:16:24 -07001079func printfIntoProperty(propertyValue reflect.Value, variableValue interface{}) error {
Colin Cross7f64b6d2015-07-09 13:57:48 -07001080 s := propertyValue.String()
Colin Cross7e0eaf12017-05-05 16:16:24 -07001081
1082 count := strings.Count(s, "%")
1083 if count == 0 {
1084 return nil
1085 }
1086
1087 if count > 1 {
1088 return fmt.Errorf("product variable properties only support a single '%%'")
1089 }
1090
Colin Cross7f64b6d2015-07-09 13:57:48 -07001091 if strings.Contains(s, "%d") {
1092 switch v := variableValue.(type) {
1093 case int:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001094 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -07001095 case bool:
1096 if v {
Colin Cross7e0eaf12017-05-05 16:16:24 -07001097 variableValue = 1
1098 } else {
1099 variableValue = 0
Colin Cross7f64b6d2015-07-09 13:57:48 -07001100 }
1101 default:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001102 return fmt.Errorf("unsupported type %T for %%d", variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001103 }
Colin Cross7e0eaf12017-05-05 16:16:24 -07001104 } else if strings.Contains(s, "%s") {
1105 switch variableValue.(type) {
1106 case string:
1107 // Nothing
1108 default:
1109 return fmt.Errorf("unsupported type %T for %%s", variableValue)
1110 }
1111 } else {
1112 return fmt.Errorf("unsupported %% in product variable property")
Colin Cross7f64b6d2015-07-09 13:57:48 -07001113 }
Colin Cross7e0eaf12017-05-05 16:16:24 -07001114
1115 propertyValue.Set(reflect.ValueOf(fmt.Sprintf(s, variableValue)))
1116
1117 return nil
Colin Cross7f64b6d2015-07-09 13:57:48 -07001118}
Colin Cross18c46802019-09-24 22:19:02 -07001119
1120var variablePropTypeMap OncePer
1121
1122// sliceToTypeArray takes a slice of property structs and returns a reflection created array containing the
1123// reflect.Types of each property struct. The result can be used as a key in a map.
1124func sliceToTypeArray(s []interface{}) interface{} {
1125 // Create an array using reflection whose length is the length of the input slice
1126 ret := reflect.New(reflect.ArrayOf(len(s), reflect.TypeOf(reflect.TypeOf(0)))).Elem()
1127 for i, e := range s {
1128 ret.Index(i).Set(reflect.ValueOf(reflect.TypeOf(e)))
1129 }
1130 return ret.Interface()
1131}
1132
Colin Crosseabaedd2020-02-06 17:01:55 -08001133func initProductVariableModule(m Module) {
1134 base := m.base()
1135
1136 // Allow tests to override the default product variables
1137 if base.variableProperties == nil {
1138 base.variableProperties = defaultProductVariables
1139 }
1140 // Filter the product variables properties to the ones that exist on this module
1141 base.variableProperties = createVariableProperties(m.GetProperties(), base.variableProperties)
1142 if base.variableProperties != nil {
1143 m.AddProperties(base.variableProperties)
1144 }
1145}
1146
Colin Cross18c46802019-09-24 22:19:02 -07001147// createVariableProperties takes the list of property structs for a module and returns a property struct that
1148// contains the product variable properties that exist in the property structs, or nil if there are none. It
1149// caches the result.
1150func createVariableProperties(moduleTypeProps []interface{}, productVariables interface{}) interface{} {
1151 // Convert the moduleTypeProps to an array of reflect.Types that can be used as a key in the OncePer.
1152 key := sliceToTypeArray(moduleTypeProps)
1153
1154 // Use the variablePropTypeMap OncePer to cache the result for each set of property struct types.
1155 typ, _ := variablePropTypeMap.Once(NewCustomOnceKey(key), func() interface{} {
1156 // Compute the filtered property struct type.
1157 return createVariablePropertiesType(moduleTypeProps, productVariables)
1158 }).(reflect.Type)
1159
1160 if typ == nil {
1161 return nil
1162 }
1163
1164 // Create a new pointer to a filtered property struct.
1165 return reflect.New(typ).Interface()
1166}
1167
1168// createVariablePropertiesType creates a new type that contains only the product variable properties that exist in
1169// a list of property structs.
1170func createVariablePropertiesType(moduleTypeProps []interface{}, productVariables interface{}) reflect.Type {
1171 typ, _ := proptools.FilterPropertyStruct(reflect.TypeOf(productVariables),
1172 func(field reflect.StructField, prefix string) (bool, reflect.StructField) {
1173 // Filter function, returns true if the field should be in the resulting struct
1174 if prefix == "" {
1175 // Keep the top level Product_variables field
1176 return true, field
1177 }
1178 _, rest := splitPrefix(prefix)
1179 if rest == "" {
1180 // Keep the 2nd level field (i.e. Product_variables.Eng)
1181 return true, field
1182 }
1183
1184 // Strip off the first 2 levels of the prefix
1185 _, prefix = splitPrefix(rest)
1186
1187 for _, p := range moduleTypeProps {
1188 if fieldExistsByNameRecursive(reflect.TypeOf(p).Elem(), prefix, field.Name) {
1189 // Keep any fields that exist in one of the property structs
1190 return true, field
1191 }
1192 }
1193
1194 return false, field
1195 })
1196 return typ
1197}
1198
1199func splitPrefix(prefix string) (first, rest string) {
1200 index := strings.IndexByte(prefix, '.')
1201 if index == -1 {
1202 return prefix, ""
1203 }
1204 return prefix[:index], prefix[index+1:]
1205}
1206
1207func fieldExistsByNameRecursive(t reflect.Type, prefix, name string) bool {
1208 if t.Kind() != reflect.Struct {
1209 panic(fmt.Errorf("fieldExistsByNameRecursive can only be called on a reflect.Struct"))
1210 }
1211
1212 if prefix != "" {
1213 split := strings.SplitN(prefix, ".", 2)
1214 firstPrefix := split[0]
1215 rest := ""
1216 if len(split) > 1 {
1217 rest = split[1]
1218 }
1219 f, exists := t.FieldByName(firstPrefix)
1220 if !exists {
1221 return false
1222 }
1223 ft := f.Type
1224 if ft.Kind() == reflect.Ptr {
1225 ft = ft.Elem()
1226 }
1227 if ft.Kind() != reflect.Struct {
1228 panic(fmt.Errorf("field %q in %q is not a struct", firstPrefix, t))
1229 }
1230 return fieldExistsByNameRecursive(ft, rest, name)
1231 } else {
1232 _, exists := t.FieldByName(name)
1233 return exists
1234 }
1235}