blob: ec4d0ea742dffbae2b528963956ef1d5f3332c4d [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
Colin Cross7f64b6d2015-07-09 13:57:48 -070023 "github.com/google/blueprint/proptools"
24)
25
26func init() {
Paul Duffine7a055c2021-03-07 15:46:33 +000027 registerVariableBuildComponents(InitRegistrationContext)
28}
29
30func registerVariableBuildComponents(ctx RegistrationContext) {
31 ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
Colin Crosseabaedd2020-02-06 17:01:55 -080032 ctx.BottomUp("variable", VariableMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070033 })
Colin Cross7f64b6d2015-07-09 13:57:48 -070034}
35
Paul Duffine7a055c2021-03-07 15:46:33 +000036var PrepareForTestWithVariables = FixtureRegisterWithContext(registerVariableBuildComponents)
37
Colin Cross7f64b6d2015-07-09 13:57:48 -070038type variableProperties struct {
39 Product_variables struct {
Dan Willemsen47cf66b2015-09-16 16:48:54 -070040 Platform_sdk_version struct {
41 Asflags []string
Colin Crossceeff0f2017-05-08 13:43:00 -070042 Cflags []string
Dan Willemsen9fe14102021-07-13 21:52:04 -070043 Cmd *string
Dan Willemsen47cf66b2015-09-16 16:48:54 -070044 }
Colin Cross83163192015-12-01 16:31:16 -080045
Yuntao Xu402e9b02021-08-09 15:44:44 -070046 Platform_sdk_version_or_codename struct {
47 Java_resource_dirs []string
48 }
49
Anton Hanssonb021bf82021-08-27 17:35:40 +010050 Platform_sdk_extension_version struct {
51 Cmd *string
52 }
53
Dan Willemsen9fe14102021-07-13 21:52:04 -070054 Platform_version_name struct {
55 Base_dir *string
56 }
57
Steven Morelanda48df2b2024-06-03 22:29:38 +000058 Shipping_api_level struct {
59 Cflags []string
60 }
61
Colin Cross83163192015-12-01 16:31:16 -080062 // unbundled_build is a catch-all property to annotate modules that don't build in one or
63 // more unbundled branches, usually due to dependencies missing from the manifest.
64 Unbundled_build struct {
Cole Fausta963b942024-04-11 17:43:00 -070065 Enabled proptools.Configurable[bool] `android:"arch_variant,replace_instead_of_append"`
Colin Cross83163192015-12-01 16:31:16 -080066 } `android:"arch_variant"`
Dan Willemsen496e3952016-01-05 14:27:55 -080067
Jeongik Chaf08e59c2023-02-09 10:47:59 +090068 // similar to `Unbundled_build`, but `Always_use_prebuilt_sdks` means that it uses prebuilt
69 // sdk specifically.
70 Always_use_prebuilt_sdks struct {
Cole Fausta963b942024-04-11 17:43:00 -070071 Enabled proptools.Configurable[bool] `android:"arch_variant,replace_instead_of_append"`
Jeongik Chaf08e59c2023-02-09 10:47:59 +090072 } `android:"arch_variant"`
73
Christopher Ferrisa5a6b9c2024-04-23 17:17:49 -070074 Malloc_low_memory struct {
Christopher Ferrisc71193a2019-12-16 09:55:10 -080075 Cflags []string `android:"arch_variant"`
76 Shared_libs []string `android:"arch_variant"`
77 Whole_static_libs []string `android:"arch_variant"`
Florian Mayerca2854e2024-01-16 16:42:34 -080078 Static_libs []string `android:"arch_variant"`
Christopher Ferrisc71193a2019-12-16 09:55:10 -080079 Exclude_static_libs []string `android:"arch_variant"`
Christopher Ferrisdea66172021-09-24 00:07:53 -070080 Srcs []string `android:"arch_variant"`
81 Header_libs []string `android:"arch_variant"`
Sasha Smundak61ebf8d2018-08-31 16:56:05 -070082 } `android:"arch_variant"`
Evgenii Stepanov8391efa2016-05-12 18:04:18 -070083
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -070084 Malloc_zero_contents struct {
85 Cflags []string `android:"arch_variant"`
86 } `android:"arch_variant"`
87
88 Malloc_pattern_fill_contents struct {
89 Cflags []string `android:"arch_variant"`
90 } `android:"arch_variant"`
91
Evgenii Stepanov8391efa2016-05-12 18:04:18 -070092 Safestack struct {
93 Cflags []string `android:"arch_variant"`
94 } `android:"arch_variant"`
Dan Willemsena6f7d152016-07-12 14:57:40 -070095
Dan Willemsen1be35382016-07-25 17:42:18 -070096 Binder32bit struct {
97 Cflags []string
98 }
Dan Willemsenfcebcd52016-09-22 14:49:10 -070099
Colin Cross95436422017-05-04 13:57:05 -0700100 Override_rs_driver struct {
101 Cflags []string
102 }
103
Steven Morelandc2b9f062017-12-13 14:06:20 -0800104 // treble_linker_namespaces is true when the system/vendor linker namespace separation is
105 // enabled.
106 Treble_linker_namespaces struct {
107 Cflags []string
108 }
Steven Morelandc2b9f062017-12-13 14:06:20 -0800109 // enforce_vintf_manifest is true when a device is required to have a vintf manifest.
110 Enforce_vintf_manifest struct {
111 Cflags []string
112 }
113
Jihoon Kangcbcad7c2023-06-01 22:31:52 +0000114 Build_from_text_stub struct {
115 Static_libs []string
116 Exclude_static_libs []string
117 }
118
Colin Cross6bc59ef2016-12-08 09:46:35 -0800119 // debuggable is true for eng and userdebug builds, and can be used to turn on additional
120 // debugging features that don't significantly impact runtime behavior. userdebug builds
121 // are used for dogfooding and performance testing, and should be as similar to user builds
122 // as possible.
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700123 Debuggable struct {
Sasha Smundakb6d23052019-04-01 18:37:36 -0700124 Cflags []string
125 Cppflags []string
126 Init_rc []string
127 Required []string
128 Host_required []string
129 Target_required []string
Philip Cuadra328e0bf2020-10-19 22:01:29 -0700130 Strip struct {
131 All *bool
132 Keep_symbols *bool
133 Keep_symbols_and_debug_frame *bool
134 }
Herbert Xue38178322024-07-16 17:28:15 +0800135 Static_libs []string
136 Exclude_static_libs []string
137 Whole_static_libs []string
138 Shared_libs []string
139 Jni_libs []string
Jiyong Park16e77a92021-08-30 18:43:19 +0900140
141 Cmdline []string
Inseob Kimf5ed3002022-01-07 19:17:29 +0900142
Jay Aliomer2599d1d2021-09-23 15:49:54 -0400143 Srcs []string
144 Exclude_srcs []string
Cole Fausted940002023-08-15 11:59:24 -0700145 Cmd *string
Jiyong Park62532d72024-04-12 16:16:28 +0900146
147 Deps []string
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700148 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800149
Usta Shresthac725f472022-01-11 02:44:21 -0500150 // eng is true for -eng builds, and can be used to turn on additional heavyweight debugging
Colin Cross6bc59ef2016-12-08 09:46:35 -0800151 // features.
152 Eng struct {
153 Cflags []string
154 Cppflags []string
John Reck1d2b7ee2018-07-11 11:01:59 -0700155 Lto struct {
156 Never *bool
157 }
Colin Cross3273cc22018-10-26 23:58:42 -0700158 Sanitize struct {
159 Address *bool
160 }
Felka Changf13642e2019-06-21 20:58:27 +0800161 Optimize struct {
162 Enabled *bool
163 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800164 }
Colin Crossb2123aa2017-05-05 13:37:11 -0700165
Dmitry Shmidtdba54192017-08-23 14:58:37 -0700166 Uml struct {
167 Cppflags []string
168 }
Risanea004dd2017-11-27 18:14:46 +0900169
170 Arc struct {
Satoshi Niwa54f48262020-12-18 09:53:26 +0900171 Cflags []string `android:"arch_variant"`
172 Exclude_srcs []string `android:"arch_variant"`
Jasmine Chenacace422021-03-05 00:56:40 +0800173 Header_libs []string `android:"arch_variant"`
Satoshi Niwa54f48262020-12-18 09:53:26 +0900174 Include_dirs []string `android:"arch_variant"`
175 Shared_libs []string `android:"arch_variant"`
176 Static_libs []string `android:"arch_variant"`
177 Srcs []string `android:"arch_variant"`
178 Whole_static_libs []string `android:"arch_variant"`
179 } `android:"arch_variant"`
Roland Levillain2879d412019-08-13 15:00:18 +0100180
Colin Crossd9a121b2020-01-27 13:26:42 -0800181 Native_coverage struct {
Colin Cross2b10ba02020-02-05 16:23:21 -0800182 Src *string `android:"arch_variant"`
Colin Crossd9a121b2020-01-27 13:26:42 -0800183 Srcs []string `android:"arch_variant"`
184 Exclude_srcs []string `android:"arch_variant"`
185 } `android:"arch_variant"`
Devin Moorec381e102023-07-06 22:03:58 +0000186
187 // release_aidl_use_unfrozen is "true" when a device can
188 // use the unfrozen versions of AIDL interfaces.
189 Release_aidl_use_unfrozen struct {
Devin Moore570d72b2024-05-24 10:07:55 +0000190 Cflags []string
191 Cmd *string
yangbill585564c2024-05-23 10:50:56 +0000192 Required []string
Devin Moore570d72b2024-05-24 10:07:55 +0000193 Vintf_fragments []string
Devin Moorec381e102023-07-06 22:03:58 +0000194 }
Colin Cross83163192015-12-01 16:31:16 -0800195 } `android:"arch_variant"`
Colin Cross7f64b6d2015-07-09 13:57:48 -0700196}
197
Colin Cross6961a492020-02-06 16:57:45 -0800198var defaultProductVariables interface{} = variableProperties{}
Colin Cross7f64b6d2015-07-09 13:57:48 -0700199
Cole Faustf8231dd2023-04-21 17:37:11 -0700200type ProductVariables struct {
Dan Willemsen174978c2016-05-11 00:27:49 -0700201 // Suffix to add to generated Makefiles
202 Make_suffix *string `json:",omitempty"`
203
Inseob Kim2da72af2024-06-18 11:09:12 +0900204 BuildId *string `json:",omitempty"`
205 BuildFingerprintFile *string `json:",omitempty"`
206 BuildNumberFile *string `json:",omitempty"`
207 BuildHostnameFile *string `json:",omitempty"`
208 BuildThumbprintFile *string `json:",omitempty"`
209 DisplayBuildNumber *bool `json:",omitempty"`
Nan Zhang581fd212018-01-10 16:06:12 -0800210
Linus Tufvessonba270c52024-04-12 13:06:22 +0200211 Platform_display_version_name *string `json:",omitempty"`
212 Platform_version_name *string `json:",omitempty"`
213 Platform_sdk_version *int `json:",omitempty"`
214 Platform_sdk_codename *string `json:",omitempty"`
215 Platform_sdk_version_or_codename *string `json:",omitempty"`
216 Platform_sdk_final *bool `json:",omitempty"`
217 Platform_sdk_extension_version *int `json:",omitempty"`
218 Platform_base_sdk_extension_version *int `json:",omitempty"`
219 Platform_version_active_codenames []string `json:",omitempty"`
220 Platform_version_all_preview_codenames []string `json:",omitempty"`
221 Platform_systemsdk_versions []string `json:",omitempty"`
222 Platform_security_patch *string `json:",omitempty"`
223 Platform_preview_sdk_version *string `json:",omitempty"`
224 Platform_base_os *string `json:",omitempty"`
225 Platform_version_last_stable *string `json:",omitempty"`
226 Platform_version_known_codenames *string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700227
Jeongik Cha219141c2020-08-06 23:00:37 +0900228 DeviceName *string `json:",omitempty"`
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000229 DeviceProduct *string `json:",omitempty"`
Jeongik Cha219141c2020-08-06 23:00:37 +0900230 DeviceArch *string `json:",omitempty"`
231 DeviceArchVariant *string `json:",omitempty"`
232 DeviceCpuVariant *string `json:",omitempty"`
233 DeviceAbi []string `json:",omitempty"`
234 DeviceVndkVersion *string `json:",omitempty"`
235 DeviceCurrentApiLevelForVendorModules *string `json:",omitempty"`
236 DeviceSystemSdkVersions []string `json:",omitempty"`
Juan Yescas05d4d902023-04-07 10:35:35 -0700237 DeviceMaxPageSizeSupported *string `json:",omitempty"`
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000238 DeviceNoBionicPageSizeMacro *bool `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700239
Justin Yun41cbb5e2023-11-29 17:58:16 +0900240 VendorApiLevel *string `json:",omitempty"`
241
Jose Galmes6f843bc2020-12-11 13:36:29 -0800242 RecoverySnapshotVersion *string `json:",omitempty"`
243
Colin Crossa74ca042019-01-31 14:31:51 -0800244 DeviceSecondaryArch *string `json:",omitempty"`
245 DeviceSecondaryArchVariant *string `json:",omitempty"`
246 DeviceSecondaryCpuVariant *string `json:",omitempty"`
247 DeviceSecondaryAbi []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700248
dimitry8d6dde82019-07-11 10:23:53 +0200249 NativeBridgeArch *string `json:",omitempty"`
250 NativeBridgeArchVariant *string `json:",omitempty"`
251 NativeBridgeCpuVariant *string `json:",omitempty"`
252 NativeBridgeAbi []string `json:",omitempty"`
253 NativeBridgeRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100254
dimitry8d6dde82019-07-11 10:23:53 +0200255 NativeBridgeSecondaryArch *string `json:",omitempty"`
256 NativeBridgeSecondaryArchVariant *string `json:",omitempty"`
257 NativeBridgeSecondaryCpuVariant *string `json:",omitempty"`
258 NativeBridgeSecondaryAbi []string `json:",omitempty"`
259 NativeBridgeSecondaryRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100260
Colin Cross4225f652015-09-17 14:33:42 -0700261 HostArch *string `json:",omitempty"`
262 HostSecondaryArch *string `json:",omitempty"`
Colin Cross528d67e2021-07-23 22:23:07 +0000263 HostMusl *bool `json:",omitempty"`
Dan Willemsen490fd492015-11-24 17:53:15 -0800264
265 CrossHost *string `json:",omitempty"`
266 CrossHostArch *string `json:",omitempty"`
267 CrossHostSecondaryArch *string `json:",omitempty"`
Colin Cross83163192015-12-01 16:31:16 -0800268
Jeongik Chacee5ba92021-02-19 12:11:51 +0900269 DeviceResourceOverlays []string `json:",omitempty"`
270 ProductResourceOverlays []string `json:",omitempty"`
271 EnforceRROTargets []string `json:",omitempty"`
Colin Crossa74ca042019-01-31 14:31:51 -0800272 EnforceRROExcludedOverlays []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700273
Colin Crossa74ca042019-01-31 14:31:51 -0800274 AAPTCharacteristics *string `json:",omitempty"`
275 AAPTConfig []string `json:",omitempty"`
276 AAPTPreferredConfig *string `json:",omitempty"`
277 AAPTPrebuiltDPI []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700278
Justin Yun635e7882024-07-04 14:50:57 +0900279 DefaultAppCertificate *string `json:",omitempty"`
280 ExtraOtaKeys []string `json:",omitempty"`
281 ExtraOtaRecoveryKeys []string `json:",omitempty"`
282 MainlineSepolicyDevCertificates *string `json:",omitempty"`
Colin Cross61ae0b72017-12-01 17:16:02 -0800283
Colin Crossface4e42017-10-30 17:32:15 -0700284 AppsDefaultVersionName *string `json:",omitempty"`
285
Cole Faust701ca252021-11-23 19:02:08 -0800286 Allow_missing_dependencies *bool `json:",omitempty"`
287 Unbundled_build *bool `json:",omitempty"`
288 Unbundled_build_apps []string `json:",omitempty"`
289 Unbundled_build_image *bool `json:",omitempty"`
290 Always_use_prebuilt_sdks *bool `json:",omitempty"`
291 Skip_boot_jars_check *bool `json:",omitempty"`
Christopher Ferrisa5a6b9c2024-04-23 17:17:49 -0700292 Malloc_low_memory *bool `json:",omitempty"`
Cole Faust701ca252021-11-23 19:02:08 -0800293 Malloc_zero_contents *bool `json:",omitempty"`
294 Malloc_pattern_fill_contents *bool `json:",omitempty"`
295 Safestack *bool `json:",omitempty"`
296 HostStaticBinaries *bool `json:",omitempty"`
297 Binder32bit *bool `json:",omitempty"`
298 UseGoma *bool `json:",omitempty"`
299 UseRBE *bool `json:",omitempty"`
300 UseRBEJAVAC *bool `json:",omitempty"`
301 UseRBER8 *bool `json:",omitempty"`
302 UseRBED8 *bool `json:",omitempty"`
303 Debuggable *bool `json:",omitempty"`
304 Eng *bool `json:",omitempty"`
305 Treble_linker_namespaces *bool `json:",omitempty"`
306 Enforce_vintf_manifest *bool `json:",omitempty"`
307 Uml *bool `json:",omitempty"`
308 Arc *bool `json:",omitempty"`
309 MinimizeJavaDebugInfo *bool `json:",omitempty"`
Jihoon Kangcbcad7c2023-06-01 22:31:52 +0000310 Build_from_text_stub *bool `json:",omitempty"`
Colin Cross16b23492016-01-06 14:41:07 -0800311
Inseob Kim8fa54da2024-03-19 16:48:59 +0900312 BuildType *string `json:",omitempty"`
313
Logan Chien4fcea3d2018-11-20 11:59:08 +0800314 Check_elf_files *bool `json:",omitempty"`
315
Colin Cross5a0dcd52018-10-05 14:20:06 -0700316 UncompressPrivAppDex *bool `json:",omitempty"`
317 ModulesLoadedByPrivilegedModules []string `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800318
satayevd604b212021-07-21 14:23:52 +0100319 BootJars ConfiguredJarList `json:",omitempty"`
320 ApexBootJars ConfiguredJarList `json:",omitempty"`
Vladimir Markoe8b00d62018-12-21 15:54:16 +0000321
Colin Crossa74ca042019-01-31 14:31:51 -0800322 IntegerOverflowExcludePaths []string `json:",omitempty"`
Ivan Lozano5f595532017-07-13 14:46:05 -0700323
Colin Crossa74ca042019-01-31 14:31:51 -0800324 EnableCFI *bool `json:",omitempty"`
325 CFIExcludePaths []string `json:",omitempty"`
326 CFIIncludePaths []string `json:",omitempty"`
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -0700327
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -0800328 DisableScudo *bool `json:",omitempty"`
329
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -0800330 MemtagHeapExcludePaths []string `json:",omitempty"`
331 MemtagHeapAsyncIncludePaths []string `json:",omitempty"`
332 MemtagHeapSyncIncludePaths []string `json:",omitempty"`
333
Hang Lua98aab92023-03-17 13:17:22 +0800334 HWASanIncludePaths []string `json:",omitempty"`
Tomislav Novakf734f002023-08-22 10:51:44 -0700335 HWASanExcludePaths []string `json:",omitempty"`
Hang Lua98aab92023-03-17 13:17:22 +0800336
Justin Yund5f6c822019-06-25 16:47:17 +0900337 VendorPath *string `json:",omitempty"`
338 OdmPath *string `json:",omitempty"`
339 ProductPath *string `json:",omitempty"`
340 SystemExtPath *string `json:",omitempty"`
Dan Willemsen4353bc42016-12-05 17:16:02 -0800341
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700342 ClangTidy *bool `json:",omitempty"`
343 TidyChecks *string `json:",omitempty"`
344
Roland Levillainada12702020-06-09 13:07:36 +0100345 JavaCoveragePaths []string `json:",omitempty"`
346 JavaCoverageExcludePaths []string `json:",omitempty"`
347
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -0800348 GcovCoverage *bool `json:",omitempty"`
349 ClangCoverage *bool `json:",omitempty"`
350 NativeCoveragePaths []string `json:",omitempty"`
351 NativeCoverageExcludePaths []string `json:",omitempty"`
352 ClangCoverageContinuousMode *bool `json:",omitempty"`
Dan Willemsen581341d2017-02-09 16:16:31 -0800353
Colin Cross1a6acd42020-06-16 17:51:46 -0700354 // Set by NewConfig
Liz Kammer09f947d2021-05-12 14:51:49 -0400355 Native_coverage *bool `json:",omitempty"`
Colin Cross1a6acd42020-06-16 17:51:46 -0700356
Colin Cross23ae82a2016-11-02 14:34:39 -0700357 SanitizeHost []string `json:",omitempty"`
358 SanitizeDevice []string `json:",omitempty"`
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700359 SanitizeDeviceDiag []string `json:",omitempty"`
Colin Cross23ae82a2016-11-02 14:34:39 -0700360 SanitizeDeviceArch []string `json:",omitempty"`
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800361
362 ArtUseReadBarrier *bool `json:",omitempty"`
Jack He8cc71432016-12-08 15:45:07 -0800363
364 BtConfigIncludeDir *string `json:",omitempty"`
Colin Cross95436422017-05-04 13:57:05 -0700365
366 Override_rs_driver *string `json:",omitempty"`
Jiyong Parkd773eb32017-07-03 13:18:12 +0900367
368 DeviceKernelHeaders []string `json:",omitempty"`
Justin Yun71549282017-11-17 12:10:28 +0900369
370 ExtraVndkVersions []string `json:",omitempty"`
Jeff Gaston088e29e2017-11-29 16:47:17 -0800371
372 NamespacesToExport []string `json:",omitempty"`
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -0800373
Vinh Tran7a8362c2022-11-01 15:33:51 -0400374 PgoAdditionalProfileDirs []string `json:",omitempty"`
Dan Willemsen0fe78662018-03-26 12:41:18 -0700375
Inseob Kimae553032019-05-14 18:52:49 +0900376 VndkSnapshotBuildArtifacts *bool `json:",omitempty"`
Vic Yangefd249e2018-11-12 20:19:56 -0800377
Inseob Kim7cf14652021-01-06 23:06:52 +0900378 DirectedVendorSnapshot bool `json:",omitempty"`
379 VendorSnapshotModules map[string]bool `json:",omitempty"`
380
Jose Galmes4c6895e2021-02-09 07:44:30 -0800381 DirectedRecoverySnapshot bool `json:",omitempty"`
382 RecoverySnapshotModules map[string]bool `json:",omitempty"`
383
Justin DeMartino383bfb32021-02-24 10:49:43 -0800384 VendorSnapshotDirsIncluded []string `json:",omitempty"`
385 VendorSnapshotDirsExcluded []string `json:",omitempty"`
386 RecoverySnapshotDirsExcluded []string `json:",omitempty"`
387 RecoverySnapshotDirsIncluded []string `json:",omitempty"`
Rob Seymour925aa092021-08-10 20:42:03 +0000388 HostFakeSnapshotEnabled bool `json:",omitempty"`
Justin DeMartino383bfb32021-02-24 10:49:43 -0800389
Inseob Kim5eb7ee92022-04-27 10:30:34 +0900390 MultitreeUpdateMeta bool `json:",omitempty"`
391
Inseob Kim6077b232023-08-31 16:49:59 +0900392 BoardVendorSepolicyDirs []string `json:",omitempty"`
393 BoardOdmSepolicyDirs []string `json:",omitempty"`
394 SystemExtPublicSepolicyDirs []string `json:",omitempty"`
395 SystemExtPrivateSepolicyDirs []string `json:",omitempty"`
396 BoardSepolicyM4Defs []string `json:",omitempty"`
Tri Vo35a51432018-03-25 20:00:00 -0700397
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900398 BoardSepolicyVers *string `json:",omitempty"`
399 PlatformSepolicyVersion *string `json:",omitempty"`
400
Inseob Kim1a0afcc2022-02-14 23:10:51 +0900401 SystemExtSepolicyPrebuiltApiDir *string `json:",omitempty"`
402 ProductSepolicyPrebuiltApiDir *string `json:",omitempty"`
403
Inseob Kim843f6642022-01-07 09:11:23 +0900404 PlatformSepolicyCompatVersions []string `json:",omitempty"`
405
Cole Faust46f6e2f2024-06-20 12:57:43 -0700406 VendorVars map[string]map[string]string `json:",omitempty"`
407 VendorVarTypes map[string]map[string]string `json:",omitempty"`
Colin Cross395f2cf2018-10-24 16:10:32 -0700408
Dan Albertd05ba002021-04-13 15:55:47 -0700409 Ndk_abis *bool `json:",omitempty"`
Jiyong Park8fd61922018-11-08 02:50:25 +0900410
Dennis Shene2ed70c2023-01-11 14:15:43 +0000411 TrimmedApex *bool `json:",omitempty"`
Jiyong Park4da07972021-01-05 21:01:11 +0900412 ForceApexSymlinkOptimization *bool `json:",omitempty"`
413 CompressedApex *bool `json:",omitempty"`
414 Aml_abis *bool `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800415
416 DexpreoptGlobalConfig *string `json:",omitempty"`
Jiyong Park7f67f482019-01-05 12:57:48 +0900417
Inseob Kim7b85eeb2021-03-23 20:52:24 +0900418 WithDexpreopt bool `json:",omitempty"`
419
Jiakai Zhang4d90da22023-07-12 16:51:48 +0100420 ManifestPackageNameOverrides []string `json:",omitempty"`
421 CertificateOverrides []string `json:",omitempty"`
422 PackageNameOverrides []string `json:",omitempty"`
423 ConfiguredJarLocationOverrides []string `json:",omitempty"`
Jeongik Chac9464142019-01-07 12:07:27 +0900424
Albert Martineefabcf2022-03-21 20:11:16 +0000425 ApexGlobalMinSdkVersionOverride *string `json:",omitempty"`
426
Jeongik Chac9464142019-01-07 12:07:27 +0900427 EnforceSystemCertificate *bool `json:",omitempty"`
Colin Cross440e0d02020-06-11 11:32:11 -0700428 EnforceSystemCertificateAllowList []string `json:",omitempty"`
Colin Cross8faf8fc2019-01-16 15:15:52 -0800429
Colin Crossf24a22a2019-01-31 14:12:44 -0800430 ProductHiddenAPIStubs []string `json:",omitempty"`
431 ProductHiddenAPIStubsSystem []string `json:",omitempty"`
432 ProductHiddenAPIStubsTest []string `json:",omitempty"`
Dan Willemsen71c74602019-04-10 12:27:35 -0700433
Inseob Kim0866b002019-04-15 20:21:29 +0900434 ProductPublicSepolicyDirs []string `json:",omitempty"`
435 ProductPrivateSepolicyDirs []string `json:",omitempty"`
Inseob Kim0866b002019-04-15 20:21:29 +0900436
Dan Willemsen54879d12019-04-18 10:08:46 -0700437 TargetFSConfigGen []string `json:",omitempty"`
Colin Cross50ddcc42019-05-16 12:28:22 -0700438
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900439 EnforceProductPartitionInterface *bool `json:",omitempty"`
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900440
JaeMan Parkff715562020-10-19 17:25:58 +0900441 EnforceInterPartitionJavaSdkLibrary *bool `json:",omitempty"`
442 InterPartitionJavaLibraryAllowList []string `json:",omitempty"`
443
Yifan Hong82db7352020-01-21 16:12:26 -0800444 BoardUsesRecoveryAsBoot *bool `json:",omitempty"`
Yifan Hong97365ee2020-07-29 09:51:57 -0700445
Yifan Hong42bef8d2020-08-05 14:36:09 -0700446 BoardKernelBinaries []string `json:",omitempty"`
447 BoardKernelModuleInterfaceVersions []string `json:",omitempty"`
Yifan Hongdd8dacc2020-10-21 15:40:17 -0700448
449 BoardMoveRecoveryResourcesToVendorBoot *bool `json:",omitempty"`
Bill Peckhambae47492021-01-08 09:34:44 -0800450
451 PrebuiltHiddenApiDir *string `json:",omitempty"`
Inseob Kim60c32f02020-12-21 22:53:05 +0900452
Steven Morelanda48df2b2024-06-03 22:29:38 +0000453 Shipping_api_level *string `json:",omitempty"`
Inseob Kim0cac7b42021-02-03 18:16:46 +0900454
Cole Faustded79602023-09-05 17:48:11 -0700455 BuildBrokenPluginValidation []string `json:",omitempty"`
456 BuildBrokenClangAsFlags bool `json:",omitempty"`
457 BuildBrokenClangCFlags bool `json:",omitempty"`
458 BuildBrokenClangProperty bool `json:",omitempty"`
459 GenruleSandboxing *bool `json:",omitempty"`
460 BuildBrokenEnforceSyspropOwner bool `json:",omitempty"`
461 BuildBrokenTrebleSyspropNeverallow bool `json:",omitempty"`
462 BuildBrokenUsesSoongPython2Modules bool `json:",omitempty"`
463 BuildBrokenVendorPropertyNamespace bool `json:",omitempty"`
464 BuildBrokenIncorrectPartitionImages bool `json:",omitempty"`
465 BuildBrokenInputDirModules []string `json:",omitempty"`
Jiyong Park3bb99242024-01-04 23:21:26 +0000466 BuildBrokenDontCheckSystemSdk bool `json:",omitempty"`
Inseob Kim2da72af2024-06-18 11:09:12 +0900467 BuildBrokenDupSysprop bool `json:",omitempty"`
Inseob Kim67e5add192021-03-17 18:05:33 +0900468
Jiakai Zhang48203e32023-06-02 23:42:21 +0100469 BuildWarningBadOptionalUsesLibsAllowlist []string `json:",omitempty"`
470
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -0700471 BuildDebugfsRestrictionsEnabled bool `json:",omitempty"`
472
Inseob Kim67e5add192021-03-17 18:05:33 +0900473 RequiresInsecureExecmemForSwiftshader bool `json:",omitempty"`
474
475 SelinuxIgnoreNeverallows bool `json:",omitempty"`
476
Devin Moorec381e102023-07-06 22:03:58 +0000477 Release_aidl_use_unfrozen *bool `json:",omitempty"`
478
Inseob Kima10ef272021-09-15 03:04:53 +0000479 SepolicyFreezeTestExtraDirs []string `json:",omitempty"`
480 SepolicyFreezeTestExtraPrebuiltDirs []string `json:",omitempty"`
Jiyong Parkd163d4d2021-10-12 16:47:43 +0900481
482 GenerateAidlNdkPlatformBackend bool `json:",omitempty"`
Christopher Ferris98f10222022-07-13 23:16:52 -0700483
484 IgnorePrefer32OnDevice bool `json:",omitempty"`
Spandan Dasc5763832022-11-08 18:42:16 +0000485
Sam Delmerico98a73292023-02-21 11:50:29 -0500486 SourceRootDirs []string `json:",omitempty"`
Vinh Tran44cb78c2023-03-09 22:07:19 -0500487
488 AfdoProfiles []string `json:",omitempty"`
Wei Lic642d682023-05-04 09:06:06 -0700489
Inseob Kim8fa54da2024-03-19 16:48:59 +0900490 ProductManufacturer string `json:",omitempty"`
491 ProductBrand string `json:",omitempty"`
Joe Onoratofee845a2023-05-09 08:14:14 -0700492
Yu Liueebb2592023-10-12 20:31:27 -0700493 ReleaseVersion string `json:",omitempty"`
494 ReleaseAconfigValueSets []string `json:",omitempty"`
Kiyoung Kime623c582023-07-06 16:43:44 +0900495
Zhi Dou3f65a412023-08-10 21:47:40 +0000496 ReleaseAconfigFlagDefaultPermission string `json:",omitempty"`
497
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000498 ReleaseDefaultModuleBuildFromSource *bool `json:",omitempty"`
499
Inseob Kim5bac3b62023-08-25 21:29:46 +0900500 CheckVendorSeappViolations *bool `json:",omitempty"`
Cole Faustb4cb0c82023-09-14 15:16:58 -0700501
Inseob Kime4e85d52023-10-25 23:53:58 +0900502 BuildFlags map[string]string `json:",omitempty"`
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000503
Cole Faust751a4a52024-05-21 16:51:59 -0700504 BuildFlagTypes map[string]string `json:",omitempty"`
505
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000506 BuildFromSourceStub *bool `json:",omitempty"`
Spandan Das8ab28dd2024-02-17 03:31:45 +0000507
Spandan Das0d24ade2024-03-08 04:20:15 +0000508 BuildIgnoreApexContributionContents *bool `json:",omitempty"`
Jihoon Kangb36fc542024-02-22 19:35:26 +0000509
510 HiddenapiExportableStubs *bool `json:",omitempty"`
Jihoon Kang35349462024-02-22 19:52:46 +0000511
512 ExportRuntimeApis *bool `json:",omitempty"`
Yu Liu67a28422024-03-05 00:36:31 +0000513
514 AconfigContainerValidation string `json:",omitempty"`
Inseob Kim8fa54da2024-03-19 16:48:59 +0900515
516 ProductLocales []string `json:",omitempty"`
517
518 ProductDefaultWifiChannels []string `json:",omitempty"`
519
520 BoardUseVbmetaDigestInFingerprint *bool `json:",omitempty"`
521
522 OemProperties []string `json:",omitempty"`
Kiyoung Kim881e4652024-07-08 11:02:23 +0900523
524 ArtTargetIncludeDebugBuild *bool `json:",omitempty"`
Inseob Kimbcc00552024-07-19 14:57:22 +0900525
526 SystemPropFiles []string `json:",omitempty"`
Cole Faustcb193ec2023-09-20 16:01:18 -0700527}
528
Cole Faust11edf552023-10-13 11:32:14 -0700529type PartitionQualifiedVariablesType struct {
530 BuildingImage bool `json:",omitempty"`
531 BoardErofsCompressor string `json:",omitempty"`
532 BoardErofsCompressHints string `json:",omitempty"`
533 BoardErofsPclusterSize string `json:",omitempty"`
534 BoardExtfsInodeCount string `json:",omitempty"`
535 BoardExtfsRsvPct string `json:",omitempty"`
536 BoardF2fsSloadCompressFlags string `json:",omitempty"`
537 BoardFileSystemCompress string `json:",omitempty"`
538 BoardFileSystemType string `json:",omitempty"`
539 BoardJournalSize string `json:",omitempty"`
540 BoardPartitionReservedSize string `json:",omitempty"`
541 BoardPartitionSize string `json:",omitempty"`
542 BoardSquashfsBlockSize string `json:",omitempty"`
543 BoardSquashfsCompressor string `json:",omitempty"`
544 BoardSquashfsCompressorOpt string `json:",omitempty"`
545 BoardSquashfsDisable4kAlign string `json:",omitempty"`
546 ProductBaseFsPath string `json:",omitempty"`
547 ProductHeadroom string `json:",omitempty"`
548 ProductVerityPartition string `json:",omitempty"`
549
550 BoardAvbAddHashtreeFooterArgs string `json:",omitempty"`
551 BoardAvbKeyPath string `json:",omitempty"`
552 BoardAvbAlgorithm string `json:",omitempty"`
553 BoardAvbRollbackIndex string `json:",omitempty"`
554 BoardAvbRollbackIndexLocation string `json:",omitempty"`
555}
556
Cole Faustcb193ec2023-09-20 16:01:18 -0700557type PartitionVariables struct {
558 ProductDirectory string `json:",omitempty"`
Cole Faust11edf552023-10-13 11:32:14 -0700559 PartitionQualifiedVariables map[string]PartitionQualifiedVariablesType
560 TargetUserimagesUseExt2 bool `json:",omitempty"`
561 TargetUserimagesUseExt3 bool `json:",omitempty"`
562 TargetUserimagesUseExt4 bool `json:",omitempty"`
Cole Faustcb193ec2023-09-20 16:01:18 -0700563
564 TargetUserimagesSparseExtDisabled bool `json:",omitempty"`
565 TargetUserimagesSparseErofsDisabled bool `json:",omitempty"`
566 TargetUserimagesSparseSquashfsDisabled bool `json:",omitempty"`
567 TargetUserimagesSparseF2fsDisabled bool `json:",omitempty"`
568
Yi-Yo Chiang939fe1a2023-11-24 14:58:50 +0800569 BoardErofsCompressor string `json:",omitempty"`
570 BoardErofsCompressorHints string `json:",omitempty"`
571 BoardErofsPclusterSize string `json:",omitempty"`
572 BoardErofsShareDupBlocks string `json:",omitempty"`
573 BoardErofsUseLegacyCompression string `json:",omitempty"`
574 BoardExt4ShareDupBlocks string `json:",omitempty"`
575 BoardFlashLogicalBlockSize string `json:",omitempty"`
576 BoardFlashEraseBlockSize string `json:",omitempty"`
577 BoardUsesRecoveryAsBoot bool `json:",omitempty"`
578 ProductUseDynamicPartitionSize bool `json:",omitempty"`
579 CopyImagesForTargetFilesZip bool `json:",omitempty"`
Cole Faustb5055392023-09-27 13:44:40 -0700580
581 BoardAvbEnable bool `json:",omitempty"`
Cole Faust11edf552023-10-13 11:32:14 -0700582
583 ProductPackages []string `json:",omitempty"`
Colin Crossa6bc19e2015-09-16 13:53:42 -0700584}
585
586func boolPtr(v bool) *bool {
587 return &v
Colin Cross485e5722015-08-27 13:28:01 -0700588}
589
Dan Willemsen47cf66b2015-09-16 16:48:54 -0700590func intPtr(v int) *int {
591 return &v
592}
593
Colin Cross4225f652015-09-17 14:33:42 -0700594func stringPtr(v string) *string {
595 return &v
596}
597
Cole Faustf8231dd2023-04-21 17:37:11 -0700598func (v *ProductVariables) SetDefaultConfig() {
599 *v = ProductVariables{
Colin Cross2a2e0db2020-02-21 16:55:46 -0800600 BuildNumberFile: stringPtr("build_number.txt"),
Dan Willemsenb6d171b2019-04-07 09:41:44 -0700601
Dan Albert8c7a9942023-03-27 20:34:01 +0000602 Platform_version_name: stringPtr("S"),
603 Platform_base_sdk_extension_version: intPtr(30),
604 Platform_sdk_version: intPtr(30),
605 Platform_sdk_codename: stringPtr("S"),
606 Platform_sdk_final: boolPtr(false),
607 Platform_version_active_codenames: []string{"S"},
608 Platform_version_all_preview_codenames: []string{"S"},
Dan Willemsencbf9e822017-11-13 14:34:56 -0800609
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000610 HostArch: stringPtr("x86_64"),
611 HostSecondaryArch: stringPtr("x86"),
612 DeviceName: stringPtr("generic_arm64"),
613 DeviceProduct: stringPtr("aosp_arm-eng"),
614 DeviceArch: stringPtr("arm64"),
615 DeviceArchVariant: stringPtr("armv8-a"),
616 DeviceCpuVariant: stringPtr("generic"),
617 DeviceAbi: []string{"arm64-v8a"},
618 DeviceSecondaryArch: stringPtr("arm"),
619 DeviceSecondaryArchVariant: stringPtr("armv8-a"),
620 DeviceSecondaryCpuVariant: stringPtr("generic"),
621 DeviceSecondaryAbi: []string{"armeabi-v7a", "armeabi"},
622 DeviceMaxPageSizeSupported: stringPtr("4096"),
623 DeviceNoBionicPageSizeMacro: boolPtr(false),
Colin Crossface4e42017-10-30 17:32:15 -0700624
Colin Crossa74ca042019-01-31 14:31:51 -0800625 AAPTConfig: []string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700626 AAPTPreferredConfig: stringPtr("xhdpi"),
627 AAPTCharacteristics: stringPtr("nosdcard"),
Colin Crossa74ca042019-01-31 14:31:51 -0800628 AAPTPrebuiltDPI: []string{"xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700629
Christopher Ferrisa5a6b9c2024-04-23 17:17:49 -0700630 Malloc_low_memory: boolPtr(false),
Steven Morelandd1342012020-07-30 20:38:49 +0000631 Malloc_zero_contents: boolPtr(true),
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700632 Malloc_pattern_fill_contents: boolPtr(false),
633 Safestack: boolPtr(false),
Dennis Shene2ed70c2023-01-11 14:15:43 +0000634 TrimmedApex: boolPtr(false),
Jihoon Kangcbcad7c2023-06-01 22:31:52 +0000635 Build_from_text_stub: boolPtr(false),
Lukacs T. Berki720b3962021-03-17 13:34:30 +0100636
satayevd604b212021-07-21 14:23:52 +0100637 BootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
638 ApexBootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
Colin Cross485e5722015-08-27 13:28:01 -0700639 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800640
641 if runtime.GOOS == "linux" {
642 v.CrossHost = stringPtr("windows")
643 v.CrossHostArch = stringPtr("x86")
Dan Willemsen07cd0512016-02-03 23:16:33 -0800644 v.CrossHostSecondaryArch = stringPtr("x86_64")
Dan Willemsen490fd492015-11-24 17:53:15 -0800645 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700646}
647
Joe Onorato3fefc232023-12-04 17:35:15 +0000648func (this *ProductVariables) GetBuildFlagBool(flag string) bool {
649 val, ok := this.BuildFlags[flag]
650 if !ok {
651 return false
652 }
653 return val == "true"
654}
655
Colin Crosseabaedd2020-02-06 17:01:55 -0800656func VariableMutator(mctx BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700657 var module Module
Colin Cross7f64b6d2015-07-09 13:57:48 -0700658 var ok bool
Colin Cross635c3b02016-05-18 15:37:25 -0700659 if module, ok = mctx.Module().(Module); !ok {
Colin Cross7f64b6d2015-07-09 13:57:48 -0700660 return
661 }
662
663 // TODO: depend on config variable, create variants, propagate variants up tree
664 a := module.base()
Colin Cross18c46802019-09-24 22:19:02 -0700665
666 if a.variableProperties == nil {
667 return
668 }
669
670 variableValues := reflect.ValueOf(a.variableProperties).Elem().FieldByName("Product_variables")
Colin Cross7f64b6d2015-07-09 13:57:48 -0700671
Colin Cross0cec3122021-01-20 11:27:32 -0800672 productVariables := reflect.ValueOf(mctx.Config().productVariables)
673
Colin Cross7f64b6d2015-07-09 13:57:48 -0700674 for i := 0; i < variableValues.NumField(); i++ {
675 variableValue := variableValues.Field(i)
Colin Cross485e5722015-08-27 13:28:01 -0700676 name := variableValues.Type().Field(i).Name
677 property := "product_variables." + proptools.PropertyNameForField(name)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700678
Colin Crossa6bc19e2015-09-16 13:53:42 -0700679 // Check that the variable was set for the product
Colin Cross0cec3122021-01-20 11:27:32 -0800680 val := productVariables.FieldByName(name)
Colin Crossa6bc19e2015-09-16 13:53:42 -0700681 if !val.IsValid() || val.Kind() != reflect.Ptr || val.IsNil() {
682 continue
Colin Cross7f64b6d2015-07-09 13:57:48 -0700683 }
Colin Crossa6bc19e2015-09-16 13:53:42 -0700684
685 val = val.Elem()
686
687 // For bools, check that the value is true
688 if val.Kind() == reflect.Bool && val.Bool() == false {
689 continue
690 }
691
692 // Check if any properties were set for the module
Colin Cross6961a492020-02-06 16:57:45 -0800693 if variableValue.IsZero() {
Colin Crossa6bc19e2015-09-16 13:53:42 -0700694 continue
695 }
Colin Crossa6bc19e2015-09-16 13:53:42 -0700696 a.setVariableProperties(mctx, property, variableValue, val.Interface())
Colin Cross7f64b6d2015-07-09 13:57:48 -0700697 }
698}
699
Colin Cross4157e882019-06-06 16:57:04 -0700700func (m *ModuleBase) setVariableProperties(ctx BottomUpMutatorContext,
Colin Cross7f64b6d2015-07-09 13:57:48 -0700701 prefix string, productVariablePropertyValue reflect.Value, variableValue interface{}) {
702
Colin Cross7e0eaf12017-05-05 16:16:24 -0700703 printfIntoProperties(ctx, prefix, productVariablePropertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700704
Usta851a3272022-01-05 23:42:33 -0500705 err := proptools.AppendMatchingProperties(m.GetProperties(),
Colin Cross06a931b2015-10-28 17:23:31 -0700706 productVariablePropertyValue.Addr().Interface(), nil)
707 if err != nil {
708 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
709 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
710 } else {
711 panic(err)
712 }
713 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700714}
715
Colin Cross7e0eaf12017-05-05 16:16:24 -0700716func printfIntoPropertiesError(ctx BottomUpMutatorContext, prefix string,
717 productVariablePropertyValue reflect.Value, i int, err error) {
718
719 field := productVariablePropertyValue.Type().Field(i).Name
720 property := prefix + "." + proptools.PropertyNameForField(field)
721 ctx.PropertyErrorf(property, "%s", err)
722}
723
724func printfIntoProperties(ctx BottomUpMutatorContext, prefix string,
725 productVariablePropertyValue reflect.Value, variableValue interface{}) {
726
Colin Cross7f64b6d2015-07-09 13:57:48 -0700727 for i := 0; i < productVariablePropertyValue.NumField(); i++ {
728 propertyValue := productVariablePropertyValue.Field(i)
Colin Crossdd0dbe62015-12-02 15:24:38 -0800729 kind := propertyValue.Kind()
730 if kind == reflect.Ptr {
731 if propertyValue.IsNil() {
732 continue
733 }
734 propertyValue = propertyValue.Elem()
735 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700736 switch propertyValue.Kind() {
737 case reflect.String:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700738 err := printfIntoProperty(propertyValue, variableValue)
739 if err != nil {
740 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
741 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700742 case reflect.Slice:
743 for j := 0; j < propertyValue.Len(); j++ {
Colin Cross7e0eaf12017-05-05 16:16:24 -0700744 err := printfIntoProperty(propertyValue.Index(j), variableValue)
745 if err != nil {
746 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
747 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700748 }
Colin Crossdd0dbe62015-12-02 15:24:38 -0800749 case reflect.Bool:
750 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -0700751 case reflect.Struct:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700752 printfIntoProperties(ctx, prefix, propertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700753 default:
754 panic(fmt.Errorf("unsupported field kind %q", propertyValue.Kind()))
755 }
756 }
757}
758
Colin Cross7e0eaf12017-05-05 16:16:24 -0700759func printfIntoProperty(propertyValue reflect.Value, variableValue interface{}) error {
Colin Cross7f64b6d2015-07-09 13:57:48 -0700760 s := propertyValue.String()
Colin Cross7e0eaf12017-05-05 16:16:24 -0700761
762 count := strings.Count(s, "%")
763 if count == 0 {
764 return nil
765 }
766
767 if count > 1 {
768 return fmt.Errorf("product variable properties only support a single '%%'")
769 }
770
Colin Cross7f64b6d2015-07-09 13:57:48 -0700771 if strings.Contains(s, "%d") {
772 switch v := variableValue.(type) {
773 case int:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700774 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -0700775 case bool:
776 if v {
Colin Cross7e0eaf12017-05-05 16:16:24 -0700777 variableValue = 1
778 } else {
779 variableValue = 0
Colin Cross7f64b6d2015-07-09 13:57:48 -0700780 }
781 default:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700782 return fmt.Errorf("unsupported type %T for %%d", variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700783 }
Colin Cross7e0eaf12017-05-05 16:16:24 -0700784 } else if strings.Contains(s, "%s") {
785 switch variableValue.(type) {
786 case string:
787 // Nothing
788 default:
789 return fmt.Errorf("unsupported type %T for %%s", variableValue)
790 }
791 } else {
792 return fmt.Errorf("unsupported %% in product variable property")
Colin Cross7f64b6d2015-07-09 13:57:48 -0700793 }
Colin Cross7e0eaf12017-05-05 16:16:24 -0700794
795 propertyValue.Set(reflect.ValueOf(fmt.Sprintf(s, variableValue)))
796
797 return nil
Colin Cross7f64b6d2015-07-09 13:57:48 -0700798}
Colin Cross18c46802019-09-24 22:19:02 -0700799
800var variablePropTypeMap OncePer
801
802// sliceToTypeArray takes a slice of property structs and returns a reflection created array containing the
803// reflect.Types of each property struct. The result can be used as a key in a map.
804func sliceToTypeArray(s []interface{}) interface{} {
805 // Create an array using reflection whose length is the length of the input slice
806 ret := reflect.New(reflect.ArrayOf(len(s), reflect.TypeOf(reflect.TypeOf(0)))).Elem()
807 for i, e := range s {
808 ret.Index(i).Set(reflect.ValueOf(reflect.TypeOf(e)))
809 }
810 return ret.Interface()
811}
812
Colin Crosseabaedd2020-02-06 17:01:55 -0800813func initProductVariableModule(m Module) {
814 base := m.base()
815
816 // Allow tests to override the default product variables
817 if base.variableProperties == nil {
818 base.variableProperties = defaultProductVariables
819 }
820 // Filter the product variables properties to the ones that exist on this module
821 base.variableProperties = createVariableProperties(m.GetProperties(), base.variableProperties)
822 if base.variableProperties != nil {
823 m.AddProperties(base.variableProperties)
824 }
825}
826
Colin Cross18c46802019-09-24 22:19:02 -0700827// createVariableProperties takes the list of property structs for a module and returns a property struct that
828// contains the product variable properties that exist in the property structs, or nil if there are none. It
829// caches the result.
830func createVariableProperties(moduleTypeProps []interface{}, productVariables interface{}) interface{} {
831 // Convert the moduleTypeProps to an array of reflect.Types that can be used as a key in the OncePer.
832 key := sliceToTypeArray(moduleTypeProps)
833
834 // Use the variablePropTypeMap OncePer to cache the result for each set of property struct types.
835 typ, _ := variablePropTypeMap.Once(NewCustomOnceKey(key), func() interface{} {
836 // Compute the filtered property struct type.
837 return createVariablePropertiesType(moduleTypeProps, productVariables)
838 }).(reflect.Type)
839
840 if typ == nil {
841 return nil
842 }
843
844 // Create a new pointer to a filtered property struct.
845 return reflect.New(typ).Interface()
846}
847
848// createVariablePropertiesType creates a new type that contains only the product variable properties that exist in
849// a list of property structs.
850func createVariablePropertiesType(moduleTypeProps []interface{}, productVariables interface{}) reflect.Type {
851 typ, _ := proptools.FilterPropertyStruct(reflect.TypeOf(productVariables),
852 func(field reflect.StructField, prefix string) (bool, reflect.StructField) {
853 // Filter function, returns true if the field should be in the resulting struct
854 if prefix == "" {
855 // Keep the top level Product_variables field
856 return true, field
857 }
858 _, rest := splitPrefix(prefix)
859 if rest == "" {
860 // Keep the 2nd level field (i.e. Product_variables.Eng)
861 return true, field
862 }
863
864 // Strip off the first 2 levels of the prefix
865 _, prefix = splitPrefix(rest)
866
867 for _, p := range moduleTypeProps {
868 if fieldExistsByNameRecursive(reflect.TypeOf(p).Elem(), prefix, field.Name) {
869 // Keep any fields that exist in one of the property structs
870 return true, field
871 }
872 }
873
874 return false, field
875 })
876 return typ
877}
878
879func splitPrefix(prefix string) (first, rest string) {
880 index := strings.IndexByte(prefix, '.')
881 if index == -1 {
882 return prefix, ""
883 }
884 return prefix[:index], prefix[index+1:]
885}
886
887func fieldExistsByNameRecursive(t reflect.Type, prefix, name string) bool {
888 if t.Kind() != reflect.Struct {
889 panic(fmt.Errorf("fieldExistsByNameRecursive can only be called on a reflect.Struct"))
890 }
891
892 if prefix != "" {
893 split := strings.SplitN(prefix, ".", 2)
894 firstPrefix := split[0]
895 rest := ""
896 if len(split) > 1 {
897 rest = split[1]
898 }
899 f, exists := t.FieldByName(firstPrefix)
900 if !exists {
901 return false
902 }
903 ft := f.Type
904 if ft.Kind() == reflect.Ptr {
905 ft = ft.Elem()
906 }
907 if ft.Kind() != reflect.Struct {
908 panic(fmt.Errorf("field %q in %q is not a struct", firstPrefix, t))
909 }
910 return fieldExistsByNameRecursive(ft, rest, name)
911 } else {
912 _, exists := t.FieldByName(name)
913 return exists
914 }
915}