blob: 8c004df3d887913a0f7d68e66f92e7c100144a4f [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 {
Jim Tang91483242024-09-10 18:04:28 +0800124 Apk *string
Sasha Smundakb6d23052019-04-01 18:37:36 -0700125 Cflags []string
126 Cppflags []string
127 Init_rc []string
128 Required []string
129 Host_required []string
130 Target_required []string
Philip Cuadra328e0bf2020-10-19 22:01:29 -0700131 Strip struct {
132 All *bool
133 Keep_symbols *bool
134 Keep_symbols_and_debug_frame *bool
135 }
Herbert Xue38178322024-07-16 17:28:15 +0800136 Static_libs []string
137 Exclude_static_libs []string
138 Whole_static_libs []string
139 Shared_libs []string
140 Jni_libs []string
Jiyong Park16e77a92021-08-30 18:43:19 +0900141
142 Cmdline []string
Inseob Kimf5ed3002022-01-07 19:17:29 +0900143
Jay Aliomer2599d1d2021-09-23 15:49:54 -0400144 Srcs []string
145 Exclude_srcs []string
Cole Fausted940002023-08-15 11:59:24 -0700146 Cmd *string
Jiyong Park62532d72024-04-12 16:16:28 +0900147
148 Deps []string
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700149 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800150
Usta Shresthac725f472022-01-11 02:44:21 -0500151 // eng is true for -eng builds, and can be used to turn on additional heavyweight debugging
Colin Cross6bc59ef2016-12-08 09:46:35 -0800152 // features.
153 Eng struct {
154 Cflags []string
155 Cppflags []string
John Reck1d2b7ee2018-07-11 11:01:59 -0700156 Lto struct {
157 Never *bool
158 }
Colin Cross3273cc22018-10-26 23:58:42 -0700159 Sanitize struct {
160 Address *bool
161 }
Felka Changf13642e2019-06-21 20:58:27 +0800162 Optimize struct {
163 Enabled *bool
164 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800165 }
Colin Crossb2123aa2017-05-05 13:37:11 -0700166
Dmitry Shmidtdba54192017-08-23 14:58:37 -0700167 Uml struct {
168 Cppflags []string
169 }
Risanea004dd2017-11-27 18:14:46 +0900170
171 Arc struct {
Satoshi Niwa54f48262020-12-18 09:53:26 +0900172 Cflags []string `android:"arch_variant"`
173 Exclude_srcs []string `android:"arch_variant"`
Jasmine Chenacace422021-03-05 00:56:40 +0800174 Header_libs []string `android:"arch_variant"`
Satoshi Niwa54f48262020-12-18 09:53:26 +0900175 Include_dirs []string `android:"arch_variant"`
176 Shared_libs []string `android:"arch_variant"`
177 Static_libs []string `android:"arch_variant"`
178 Srcs []string `android:"arch_variant"`
179 Whole_static_libs []string `android:"arch_variant"`
180 } `android:"arch_variant"`
Roland Levillain2879d412019-08-13 15:00:18 +0100181
Colin Crossd9a121b2020-01-27 13:26:42 -0800182 Native_coverage struct {
Colin Cross2b10ba02020-02-05 16:23:21 -0800183 Src *string `android:"arch_variant"`
Colin Crossd9a121b2020-01-27 13:26:42 -0800184 Srcs []string `android:"arch_variant"`
185 Exclude_srcs []string `android:"arch_variant"`
186 } `android:"arch_variant"`
Devin Moorec381e102023-07-06 22:03:58 +0000187
188 // release_aidl_use_unfrozen is "true" when a device can
189 // use the unfrozen versions of AIDL interfaces.
190 Release_aidl_use_unfrozen struct {
Kiyoung Kima0523da2024-08-19 10:15:30 +0900191 Cflags []string
192 Cmd *string
193 Required []string
194 Vintf_fragment_modules []string
Devin Moorec381e102023-07-06 22:03:58 +0000195 }
Colin Cross83163192015-12-01 16:31:16 -0800196 } `android:"arch_variant"`
Colin Cross7f64b6d2015-07-09 13:57:48 -0700197}
198
Colin Cross6961a492020-02-06 16:57:45 -0800199var defaultProductVariables interface{} = variableProperties{}
Colin Cross7f64b6d2015-07-09 13:57:48 -0700200
Cole Faustf8231dd2023-04-21 17:37:11 -0700201type ProductVariables struct {
Dan Willemsen174978c2016-05-11 00:27:49 -0700202 // Suffix to add to generated Makefiles
203 Make_suffix *string `json:",omitempty"`
204
Inseob Kim2da72af2024-06-18 11:09:12 +0900205 BuildId *string `json:",omitempty"`
206 BuildFingerprintFile *string `json:",omitempty"`
207 BuildNumberFile *string `json:",omitempty"`
208 BuildHostnameFile *string `json:",omitempty"`
209 BuildThumbprintFile *string `json:",omitempty"`
210 DisplayBuildNumber *bool `json:",omitempty"`
Nan Zhang581fd212018-01-10 16:06:12 -0800211
Linus Tufvessonba270c52024-04-12 13:06:22 +0200212 Platform_display_version_name *string `json:",omitempty"`
213 Platform_version_name *string `json:",omitempty"`
214 Platform_sdk_version *int `json:",omitempty"`
215 Platform_sdk_codename *string `json:",omitempty"`
216 Platform_sdk_version_or_codename *string `json:",omitempty"`
217 Platform_sdk_final *bool `json:",omitempty"`
218 Platform_sdk_extension_version *int `json:",omitempty"`
219 Platform_base_sdk_extension_version *int `json:",omitempty"`
220 Platform_version_active_codenames []string `json:",omitempty"`
221 Platform_version_all_preview_codenames []string `json:",omitempty"`
222 Platform_systemsdk_versions []string `json:",omitempty"`
223 Platform_security_patch *string `json:",omitempty"`
224 Platform_preview_sdk_version *string `json:",omitempty"`
225 Platform_base_os *string `json:",omitempty"`
226 Platform_version_last_stable *string `json:",omitempty"`
227 Platform_version_known_codenames *string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700228
Jeongik Cha219141c2020-08-06 23:00:37 +0900229 DeviceName *string `json:",omitempty"`
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000230 DeviceProduct *string `json:",omitempty"`
Jeongik Cha219141c2020-08-06 23:00:37 +0900231 DeviceArch *string `json:",omitempty"`
232 DeviceArchVariant *string `json:",omitempty"`
233 DeviceCpuVariant *string `json:",omitempty"`
234 DeviceAbi []string `json:",omitempty"`
235 DeviceVndkVersion *string `json:",omitempty"`
236 DeviceCurrentApiLevelForVendorModules *string `json:",omitempty"`
237 DeviceSystemSdkVersions []string `json:",omitempty"`
Juan Yescas05d4d902023-04-07 10:35:35 -0700238 DeviceMaxPageSizeSupported *string `json:",omitempty"`
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000239 DeviceNoBionicPageSizeMacro *bool `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700240
Justin Yun41cbb5e2023-11-29 17:58:16 +0900241 VendorApiLevel *string `json:",omitempty"`
242
Colin Crossa74ca042019-01-31 14:31:51 -0800243 DeviceSecondaryArch *string `json:",omitempty"`
244 DeviceSecondaryArchVariant *string `json:",omitempty"`
245 DeviceSecondaryCpuVariant *string `json:",omitempty"`
246 DeviceSecondaryAbi []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700247
dimitry8d6dde82019-07-11 10:23:53 +0200248 NativeBridgeArch *string `json:",omitempty"`
249 NativeBridgeArchVariant *string `json:",omitempty"`
250 NativeBridgeCpuVariant *string `json:",omitempty"`
251 NativeBridgeAbi []string `json:",omitempty"`
252 NativeBridgeRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100253
dimitry8d6dde82019-07-11 10:23:53 +0200254 NativeBridgeSecondaryArch *string `json:",omitempty"`
255 NativeBridgeSecondaryArchVariant *string `json:",omitempty"`
256 NativeBridgeSecondaryCpuVariant *string `json:",omitempty"`
257 NativeBridgeSecondaryAbi []string `json:",omitempty"`
258 NativeBridgeSecondaryRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100259
Colin Cross4225f652015-09-17 14:33:42 -0700260 HostArch *string `json:",omitempty"`
261 HostSecondaryArch *string `json:",omitempty"`
Colin Cross528d67e2021-07-23 22:23:07 +0000262 HostMusl *bool `json:",omitempty"`
Dan Willemsen490fd492015-11-24 17:53:15 -0800263
264 CrossHost *string `json:",omitempty"`
265 CrossHostArch *string `json:",omitempty"`
266 CrossHostSecondaryArch *string `json:",omitempty"`
Colin Cross83163192015-12-01 16:31:16 -0800267
Jeongik Chacee5ba92021-02-19 12:11:51 +0900268 DeviceResourceOverlays []string `json:",omitempty"`
269 ProductResourceOverlays []string `json:",omitempty"`
270 EnforceRROTargets []string `json:",omitempty"`
Colin Crossa74ca042019-01-31 14:31:51 -0800271 EnforceRROExcludedOverlays []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700272
Colin Crossa74ca042019-01-31 14:31:51 -0800273 AAPTCharacteristics *string `json:",omitempty"`
274 AAPTConfig []string `json:",omitempty"`
275 AAPTPreferredConfig *string `json:",omitempty"`
276 AAPTPrebuiltDPI []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700277
Justin Yun635e7882024-07-04 14:50:57 +0900278 DefaultAppCertificate *string `json:",omitempty"`
279 ExtraOtaKeys []string `json:",omitempty"`
280 ExtraOtaRecoveryKeys []string `json:",omitempty"`
281 MainlineSepolicyDevCertificates *string `json:",omitempty"`
Colin Cross61ae0b72017-12-01 17:16:02 -0800282
Colin Crossface4e42017-10-30 17:32:15 -0700283 AppsDefaultVersionName *string `json:",omitempty"`
284
Cole Faust701ca252021-11-23 19:02:08 -0800285 Allow_missing_dependencies *bool `json:",omitempty"`
286 Unbundled_build *bool `json:",omitempty"`
287 Unbundled_build_apps []string `json:",omitempty"`
288 Unbundled_build_image *bool `json:",omitempty"`
289 Always_use_prebuilt_sdks *bool `json:",omitempty"`
290 Skip_boot_jars_check *bool `json:",omitempty"`
Christopher Ferrisa5a6b9c2024-04-23 17:17:49 -0700291 Malloc_low_memory *bool `json:",omitempty"`
Cole Faust701ca252021-11-23 19:02:08 -0800292 Malloc_zero_contents *bool `json:",omitempty"`
293 Malloc_pattern_fill_contents *bool `json:",omitempty"`
294 Safestack *bool `json:",omitempty"`
295 HostStaticBinaries *bool `json:",omitempty"`
296 Binder32bit *bool `json:",omitempty"`
297 UseGoma *bool `json:",omitempty"`
Taylor Santiago3c16e612024-05-30 14:41:31 -0700298 UseABFS *bool `json:",omitempty"`
Cole Faust701ca252021-11-23 19:02:08 -0800299 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 Kim5eb7ee92022-04-27 10:30:34 +0900376 MultitreeUpdateMeta bool `json:",omitempty"`
377
Inseob Kim6077b232023-08-31 16:49:59 +0900378 BoardVendorSepolicyDirs []string `json:",omitempty"`
379 BoardOdmSepolicyDirs []string `json:",omitempty"`
380 SystemExtPublicSepolicyDirs []string `json:",omitempty"`
381 SystemExtPrivateSepolicyDirs []string `json:",omitempty"`
382 BoardSepolicyM4Defs []string `json:",omitempty"`
Tri Vo35a51432018-03-25 20:00:00 -0700383
Herbert Xue0fc8abe2024-08-21 13:03:01 +0800384 BoardPlatform *string `json:",omitempty"`
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900385 BoardSepolicyVers *string `json:",omitempty"`
386 PlatformSepolicyVersion *string `json:",omitempty"`
387
Inseob Kim1a0afcc2022-02-14 23:10:51 +0900388 SystemExtSepolicyPrebuiltApiDir *string `json:",omitempty"`
389 ProductSepolicyPrebuiltApiDir *string `json:",omitempty"`
390
Inseob Kim843f6642022-01-07 09:11:23 +0900391 PlatformSepolicyCompatVersions []string `json:",omitempty"`
392
Cole Faust46f6e2f2024-06-20 12:57:43 -0700393 VendorVars map[string]map[string]string `json:",omitempty"`
394 VendorVarTypes map[string]map[string]string `json:",omitempty"`
Colin Cross395f2cf2018-10-24 16:10:32 -0700395
Dan Albertd05ba002021-04-13 15:55:47 -0700396 Ndk_abis *bool `json:",omitempty"`
Jiyong Park8fd61922018-11-08 02:50:25 +0900397
Dennis Shene2ed70c2023-01-11 14:15:43 +0000398 TrimmedApex *bool `json:",omitempty"`
Jiyong Park4da07972021-01-05 21:01:11 +0900399 ForceApexSymlinkOptimization *bool `json:",omitempty"`
400 CompressedApex *bool `json:",omitempty"`
401 Aml_abis *bool `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800402
403 DexpreoptGlobalConfig *string `json:",omitempty"`
Jiyong Park7f67f482019-01-05 12:57:48 +0900404
Inseob Kim7b85eeb2021-03-23 20:52:24 +0900405 WithDexpreopt bool `json:",omitempty"`
406
Jiakai Zhang4d90da22023-07-12 16:51:48 +0100407 ManifestPackageNameOverrides []string `json:",omitempty"`
408 CertificateOverrides []string `json:",omitempty"`
409 PackageNameOverrides []string `json:",omitempty"`
410 ConfiguredJarLocationOverrides []string `json:",omitempty"`
Jeongik Chac9464142019-01-07 12:07:27 +0900411
Albert Martineefabcf2022-03-21 20:11:16 +0000412 ApexGlobalMinSdkVersionOverride *string `json:",omitempty"`
413
Jeongik Chac9464142019-01-07 12:07:27 +0900414 EnforceSystemCertificate *bool `json:",omitempty"`
Colin Cross440e0d02020-06-11 11:32:11 -0700415 EnforceSystemCertificateAllowList []string `json:",omitempty"`
Colin Cross8faf8fc2019-01-16 15:15:52 -0800416
Colin Crossf24a22a2019-01-31 14:12:44 -0800417 ProductHiddenAPIStubs []string `json:",omitempty"`
418 ProductHiddenAPIStubsSystem []string `json:",omitempty"`
419 ProductHiddenAPIStubsTest []string `json:",omitempty"`
Dan Willemsen71c74602019-04-10 12:27:35 -0700420
Inseob Kim0866b002019-04-15 20:21:29 +0900421 ProductPublicSepolicyDirs []string `json:",omitempty"`
422 ProductPrivateSepolicyDirs []string `json:",omitempty"`
Inseob Kim0866b002019-04-15 20:21:29 +0900423
Dan Willemsen54879d12019-04-18 10:08:46 -0700424 TargetFSConfigGen []string `json:",omitempty"`
Colin Cross50ddcc42019-05-16 12:28:22 -0700425
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900426 EnforceProductPartitionInterface *bool `json:",omitempty"`
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900427
JaeMan Parkff715562020-10-19 17:25:58 +0900428 EnforceInterPartitionJavaSdkLibrary *bool `json:",omitempty"`
429 InterPartitionJavaLibraryAllowList []string `json:",omitempty"`
430
Yifan Hong82db7352020-01-21 16:12:26 -0800431 BoardUsesRecoveryAsBoot *bool `json:",omitempty"`
Yifan Hong97365ee2020-07-29 09:51:57 -0700432
Yifan Hong42bef8d2020-08-05 14:36:09 -0700433 BoardKernelBinaries []string `json:",omitempty"`
434 BoardKernelModuleInterfaceVersions []string `json:",omitempty"`
Yifan Hongdd8dacc2020-10-21 15:40:17 -0700435
436 BoardMoveRecoveryResourcesToVendorBoot *bool `json:",omitempty"`
Bill Peckhambae47492021-01-08 09:34:44 -0800437
438 PrebuiltHiddenApiDir *string `json:",omitempty"`
Inseob Kim60c32f02020-12-21 22:53:05 +0900439
Steven Morelanda48df2b2024-06-03 22:29:38 +0000440 Shipping_api_level *string `json:",omitempty"`
Inseob Kim0cac7b42021-02-03 18:16:46 +0900441
Cole Faustded79602023-09-05 17:48:11 -0700442 BuildBrokenPluginValidation []string `json:",omitempty"`
443 BuildBrokenClangAsFlags bool `json:",omitempty"`
444 BuildBrokenClangCFlags bool `json:",omitempty"`
445 BuildBrokenClangProperty bool `json:",omitempty"`
446 GenruleSandboxing *bool `json:",omitempty"`
447 BuildBrokenEnforceSyspropOwner bool `json:",omitempty"`
448 BuildBrokenTrebleSyspropNeverallow bool `json:",omitempty"`
449 BuildBrokenUsesSoongPython2Modules bool `json:",omitempty"`
450 BuildBrokenVendorPropertyNamespace bool `json:",omitempty"`
451 BuildBrokenIncorrectPartitionImages bool `json:",omitempty"`
452 BuildBrokenInputDirModules []string `json:",omitempty"`
Jiyong Park3bb99242024-01-04 23:21:26 +0000453 BuildBrokenDontCheckSystemSdk bool `json:",omitempty"`
Inseob Kim2da72af2024-06-18 11:09:12 +0900454 BuildBrokenDupSysprop bool `json:",omitempty"`
Inseob Kim67e5add192021-03-17 18:05:33 +0900455
Jiakai Zhang48203e32023-06-02 23:42:21 +0100456 BuildWarningBadOptionalUsesLibsAllowlist []string `json:",omitempty"`
457
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -0700458 BuildDebugfsRestrictionsEnabled bool `json:",omitempty"`
459
Inseob Kim67e5add192021-03-17 18:05:33 +0900460 RequiresInsecureExecmemForSwiftshader bool `json:",omitempty"`
461
462 SelinuxIgnoreNeverallows bool `json:",omitempty"`
463
Devin Moorec381e102023-07-06 22:03:58 +0000464 Release_aidl_use_unfrozen *bool `json:",omitempty"`
465
Inseob Kima10ef272021-09-15 03:04:53 +0000466 SepolicyFreezeTestExtraDirs []string `json:",omitempty"`
467 SepolicyFreezeTestExtraPrebuiltDirs []string `json:",omitempty"`
Jiyong Parkd163d4d2021-10-12 16:47:43 +0900468
469 GenerateAidlNdkPlatformBackend bool `json:",omitempty"`
Christopher Ferris98f10222022-07-13 23:16:52 -0700470
471 IgnorePrefer32OnDevice bool `json:",omitempty"`
Spandan Dasc5763832022-11-08 18:42:16 +0000472
Sam Delmerico98a73292023-02-21 11:50:29 -0500473 SourceRootDirs []string `json:",omitempty"`
Vinh Tran44cb78c2023-03-09 22:07:19 -0500474
475 AfdoProfiles []string `json:",omitempty"`
Wei Lic642d682023-05-04 09:06:06 -0700476
Inseob Kim8fa54da2024-03-19 16:48:59 +0900477 ProductManufacturer string `json:",omitempty"`
478 ProductBrand string `json:",omitempty"`
Joe Onoratofee845a2023-05-09 08:14:14 -0700479
Yu Liueebb2592023-10-12 20:31:27 -0700480 ReleaseVersion string `json:",omitempty"`
481 ReleaseAconfigValueSets []string `json:",omitempty"`
Kiyoung Kime623c582023-07-06 16:43:44 +0900482
Zhi Dou3f65a412023-08-10 21:47:40 +0000483 ReleaseAconfigFlagDefaultPermission string `json:",omitempty"`
484
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000485 ReleaseDefaultModuleBuildFromSource *bool `json:",omitempty"`
486
Inseob Kim5bac3b62023-08-25 21:29:46 +0900487 CheckVendorSeappViolations *bool `json:",omitempty"`
Cole Faustb4cb0c82023-09-14 15:16:58 -0700488
Inseob Kime4e85d52023-10-25 23:53:58 +0900489 BuildFlags map[string]string `json:",omitempty"`
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000490
Cole Faust751a4a52024-05-21 16:51:59 -0700491 BuildFlagTypes map[string]string `json:",omitempty"`
492
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000493 BuildFromSourceStub *bool `json:",omitempty"`
Spandan Das8ab28dd2024-02-17 03:31:45 +0000494
Spandan Das0d24ade2024-03-08 04:20:15 +0000495 BuildIgnoreApexContributionContents *bool `json:",omitempty"`
Jihoon Kangb36fc542024-02-22 19:35:26 +0000496
497 HiddenapiExportableStubs *bool `json:",omitempty"`
Jihoon Kang35349462024-02-22 19:52:46 +0000498
499 ExportRuntimeApis *bool `json:",omitempty"`
Yu Liu67a28422024-03-05 00:36:31 +0000500
501 AconfigContainerValidation string `json:",omitempty"`
Inseob Kim8fa54da2024-03-19 16:48:59 +0900502
503 ProductLocales []string `json:",omitempty"`
504
505 ProductDefaultWifiChannels []string `json:",omitempty"`
506
507 BoardUseVbmetaDigestInFingerprint *bool `json:",omitempty"`
508
509 OemProperties []string `json:",omitempty"`
Kiyoung Kim881e4652024-07-08 11:02:23 +0900510
511 ArtTargetIncludeDebugBuild *bool `json:",omitempty"`
Inseob Kimd8538e52024-07-31 02:00:41 +0000512
Inseob Kimacf91742024-08-05 12:51:05 +0900513 SystemPropFiles []string `json:",omitempty"`
514 SystemExtPropFiles []string `json:",omitempty"`
Inseob Kim01d4f8b2024-08-08 17:47:14 +0900515 ProductPropFiles []string `json:",omitempty"`
Inseob Kim9a22c7e2024-08-26 15:58:09 +0900516 OdmPropFiles []string `json:",omitempty"`
Inseob Kim6bd92d52024-07-31 02:01:03 +0000517
518 EnableUffdGc *string `json:",omitempty"`
Bill Yang3b3aac02024-09-05 09:22:09 +0000519
520 BoardAvbEnable *bool `json:",omitempty"`
521 BoardAvbSystemAddHashtreeFooterArgs []string `json:",omitempty"`
522 DeviceFrameworkCompatibilityMatrixFile []string `json:",omitempty"`
523 DeviceProductCompatibilityMatrixFile []string `json:",omitempty"`
Cole Faustcb193ec2023-09-20 16:01:18 -0700524}
525
Cole Faust11edf552023-10-13 11:32:14 -0700526type PartitionQualifiedVariablesType struct {
527 BuildingImage bool `json:",omitempty"`
528 BoardErofsCompressor string `json:",omitempty"`
529 BoardErofsCompressHints string `json:",omitempty"`
530 BoardErofsPclusterSize string `json:",omitempty"`
531 BoardExtfsInodeCount string `json:",omitempty"`
532 BoardExtfsRsvPct string `json:",omitempty"`
533 BoardF2fsSloadCompressFlags string `json:",omitempty"`
534 BoardFileSystemCompress string `json:",omitempty"`
535 BoardFileSystemType string `json:",omitempty"`
536 BoardJournalSize string `json:",omitempty"`
537 BoardPartitionReservedSize string `json:",omitempty"`
538 BoardPartitionSize string `json:",omitempty"`
539 BoardSquashfsBlockSize string `json:",omitempty"`
540 BoardSquashfsCompressor string `json:",omitempty"`
541 BoardSquashfsCompressorOpt string `json:",omitempty"`
542 BoardSquashfsDisable4kAlign string `json:",omitempty"`
543 ProductBaseFsPath string `json:",omitempty"`
544 ProductHeadroom string `json:",omitempty"`
545 ProductVerityPartition string `json:",omitempty"`
546
547 BoardAvbAddHashtreeFooterArgs string `json:",omitempty"`
548 BoardAvbKeyPath string `json:",omitempty"`
549 BoardAvbAlgorithm string `json:",omitempty"`
550 BoardAvbRollbackIndex string `json:",omitempty"`
551 BoardAvbRollbackIndexLocation string `json:",omitempty"`
552}
553
Cole Faustcb193ec2023-09-20 16:01:18 -0700554type PartitionVariables struct {
555 ProductDirectory string `json:",omitempty"`
Cole Faust11edf552023-10-13 11:32:14 -0700556 PartitionQualifiedVariables map[string]PartitionQualifiedVariablesType
557 TargetUserimagesUseExt2 bool `json:",omitempty"`
558 TargetUserimagesUseExt3 bool `json:",omitempty"`
559 TargetUserimagesUseExt4 bool `json:",omitempty"`
Cole Faustcb193ec2023-09-20 16:01:18 -0700560
561 TargetUserimagesSparseExtDisabled bool `json:",omitempty"`
562 TargetUserimagesSparseErofsDisabled bool `json:",omitempty"`
563 TargetUserimagesSparseSquashfsDisabled bool `json:",omitempty"`
564 TargetUserimagesSparseF2fsDisabled bool `json:",omitempty"`
565
Yi-Yo Chiang939fe1a2023-11-24 14:58:50 +0800566 BoardErofsCompressor string `json:",omitempty"`
567 BoardErofsCompressorHints string `json:",omitempty"`
568 BoardErofsPclusterSize string `json:",omitempty"`
569 BoardErofsShareDupBlocks string `json:",omitempty"`
570 BoardErofsUseLegacyCompression string `json:",omitempty"`
571 BoardExt4ShareDupBlocks string `json:",omitempty"`
572 BoardFlashLogicalBlockSize string `json:",omitempty"`
573 BoardFlashEraseBlockSize string `json:",omitempty"`
574 BoardUsesRecoveryAsBoot bool `json:",omitempty"`
575 ProductUseDynamicPartitionSize bool `json:",omitempty"`
576 CopyImagesForTargetFilesZip bool `json:",omitempty"`
Cole Faustb5055392023-09-27 13:44:40 -0700577
578 BoardAvbEnable bool `json:",omitempty"`
Cole Faust11edf552023-10-13 11:32:14 -0700579
580 ProductPackages []string `json:",omitempty"`
Colin Crossa6bc19e2015-09-16 13:53:42 -0700581}
582
583func boolPtr(v bool) *bool {
584 return &v
Colin Cross485e5722015-08-27 13:28:01 -0700585}
586
Dan Willemsen47cf66b2015-09-16 16:48:54 -0700587func intPtr(v int) *int {
588 return &v
589}
590
Colin Cross4225f652015-09-17 14:33:42 -0700591func stringPtr(v string) *string {
592 return &v
593}
594
Cole Faustf8231dd2023-04-21 17:37:11 -0700595func (v *ProductVariables) SetDefaultConfig() {
596 *v = ProductVariables{
Colin Cross2a2e0db2020-02-21 16:55:46 -0800597 BuildNumberFile: stringPtr("build_number.txt"),
Dan Willemsenb6d171b2019-04-07 09:41:44 -0700598
Dan Albert8c7a9942023-03-27 20:34:01 +0000599 Platform_version_name: stringPtr("S"),
600 Platform_base_sdk_extension_version: intPtr(30),
601 Platform_sdk_version: intPtr(30),
602 Platform_sdk_codename: stringPtr("S"),
603 Platform_sdk_final: boolPtr(false),
604 Platform_version_active_codenames: []string{"S"},
605 Platform_version_all_preview_codenames: []string{"S"},
Dan Willemsencbf9e822017-11-13 14:34:56 -0800606
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000607 HostArch: stringPtr("x86_64"),
608 HostSecondaryArch: stringPtr("x86"),
609 DeviceName: stringPtr("generic_arm64"),
610 DeviceProduct: stringPtr("aosp_arm-eng"),
611 DeviceArch: stringPtr("arm64"),
612 DeviceArchVariant: stringPtr("armv8-a"),
613 DeviceCpuVariant: stringPtr("generic"),
614 DeviceAbi: []string{"arm64-v8a"},
615 DeviceSecondaryArch: stringPtr("arm"),
616 DeviceSecondaryArchVariant: stringPtr("armv8-a"),
617 DeviceSecondaryCpuVariant: stringPtr("generic"),
618 DeviceSecondaryAbi: []string{"armeabi-v7a", "armeabi"},
619 DeviceMaxPageSizeSupported: stringPtr("4096"),
620 DeviceNoBionicPageSizeMacro: boolPtr(false),
Colin Crossface4e42017-10-30 17:32:15 -0700621
Colin Crossa74ca042019-01-31 14:31:51 -0800622 AAPTConfig: []string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700623 AAPTPreferredConfig: stringPtr("xhdpi"),
624 AAPTCharacteristics: stringPtr("nosdcard"),
Colin Crossa74ca042019-01-31 14:31:51 -0800625 AAPTPrebuiltDPI: []string{"xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700626
Christopher Ferrisa5a6b9c2024-04-23 17:17:49 -0700627 Malloc_low_memory: boolPtr(false),
Steven Morelandd1342012020-07-30 20:38:49 +0000628 Malloc_zero_contents: boolPtr(true),
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700629 Malloc_pattern_fill_contents: boolPtr(false),
630 Safestack: boolPtr(false),
Dennis Shene2ed70c2023-01-11 14:15:43 +0000631 TrimmedApex: boolPtr(false),
Jihoon Kangcbcad7c2023-06-01 22:31:52 +0000632 Build_from_text_stub: boolPtr(false),
Lukacs T. Berki720b3962021-03-17 13:34:30 +0100633
satayevd604b212021-07-21 14:23:52 +0100634 BootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
635 ApexBootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
Colin Cross485e5722015-08-27 13:28:01 -0700636 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800637
638 if runtime.GOOS == "linux" {
639 v.CrossHost = stringPtr("windows")
640 v.CrossHostArch = stringPtr("x86")
Dan Willemsen07cd0512016-02-03 23:16:33 -0800641 v.CrossHostSecondaryArch = stringPtr("x86_64")
Dan Willemsen490fd492015-11-24 17:53:15 -0800642 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700643}
644
Joe Onorato3fefc232023-12-04 17:35:15 +0000645func (this *ProductVariables) GetBuildFlagBool(flag string) bool {
646 val, ok := this.BuildFlags[flag]
647 if !ok {
648 return false
649 }
650 return val == "true"
651}
652
Colin Crosseabaedd2020-02-06 17:01:55 -0800653func VariableMutator(mctx BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700654 var module Module
Colin Cross7f64b6d2015-07-09 13:57:48 -0700655 var ok bool
Colin Cross635c3b02016-05-18 15:37:25 -0700656 if module, ok = mctx.Module().(Module); !ok {
Colin Cross7f64b6d2015-07-09 13:57:48 -0700657 return
658 }
659
660 // TODO: depend on config variable, create variants, propagate variants up tree
661 a := module.base()
Colin Cross18c46802019-09-24 22:19:02 -0700662
663 if a.variableProperties == nil {
664 return
665 }
666
667 variableValues := reflect.ValueOf(a.variableProperties).Elem().FieldByName("Product_variables")
Colin Cross7f64b6d2015-07-09 13:57:48 -0700668
Colin Cross0cec3122021-01-20 11:27:32 -0800669 productVariables := reflect.ValueOf(mctx.Config().productVariables)
670
Colin Cross7f64b6d2015-07-09 13:57:48 -0700671 for i := 0; i < variableValues.NumField(); i++ {
672 variableValue := variableValues.Field(i)
Colin Cross485e5722015-08-27 13:28:01 -0700673 name := variableValues.Type().Field(i).Name
674 property := "product_variables." + proptools.PropertyNameForField(name)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700675
Colin Crossa6bc19e2015-09-16 13:53:42 -0700676 // Check that the variable was set for the product
Colin Cross0cec3122021-01-20 11:27:32 -0800677 val := productVariables.FieldByName(name)
Colin Crossa6bc19e2015-09-16 13:53:42 -0700678 if !val.IsValid() || val.Kind() != reflect.Ptr || val.IsNil() {
679 continue
Colin Cross7f64b6d2015-07-09 13:57:48 -0700680 }
Colin Crossa6bc19e2015-09-16 13:53:42 -0700681
682 val = val.Elem()
683
684 // For bools, check that the value is true
685 if val.Kind() == reflect.Bool && val.Bool() == false {
686 continue
687 }
688
689 // Check if any properties were set for the module
Colin Cross6961a492020-02-06 16:57:45 -0800690 if variableValue.IsZero() {
Colin Crossa6bc19e2015-09-16 13:53:42 -0700691 continue
692 }
Colin Crossa6bc19e2015-09-16 13:53:42 -0700693 a.setVariableProperties(mctx, property, variableValue, val.Interface())
Colin Cross7f64b6d2015-07-09 13:57:48 -0700694 }
695}
696
Colin Cross4157e882019-06-06 16:57:04 -0700697func (m *ModuleBase) setVariableProperties(ctx BottomUpMutatorContext,
Colin Cross7f64b6d2015-07-09 13:57:48 -0700698 prefix string, productVariablePropertyValue reflect.Value, variableValue interface{}) {
699
Colin Cross7e0eaf12017-05-05 16:16:24 -0700700 printfIntoProperties(ctx, prefix, productVariablePropertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700701
Usta851a3272022-01-05 23:42:33 -0500702 err := proptools.AppendMatchingProperties(m.GetProperties(),
Colin Cross06a931b2015-10-28 17:23:31 -0700703 productVariablePropertyValue.Addr().Interface(), nil)
704 if err != nil {
705 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
706 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
707 } else {
708 panic(err)
709 }
710 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700711}
712
Colin Cross7e0eaf12017-05-05 16:16:24 -0700713func printfIntoPropertiesError(ctx BottomUpMutatorContext, prefix string,
714 productVariablePropertyValue reflect.Value, i int, err error) {
715
716 field := productVariablePropertyValue.Type().Field(i).Name
717 property := prefix + "." + proptools.PropertyNameForField(field)
718 ctx.PropertyErrorf(property, "%s", err)
719}
720
721func printfIntoProperties(ctx BottomUpMutatorContext, prefix string,
722 productVariablePropertyValue reflect.Value, variableValue interface{}) {
723
Colin Cross7f64b6d2015-07-09 13:57:48 -0700724 for i := 0; i < productVariablePropertyValue.NumField(); i++ {
725 propertyValue := productVariablePropertyValue.Field(i)
Colin Crossdd0dbe62015-12-02 15:24:38 -0800726 kind := propertyValue.Kind()
727 if kind == reflect.Ptr {
728 if propertyValue.IsNil() {
729 continue
730 }
731 propertyValue = propertyValue.Elem()
732 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700733 switch propertyValue.Kind() {
734 case reflect.String:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700735 err := printfIntoProperty(propertyValue, variableValue)
736 if err != nil {
737 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
738 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700739 case reflect.Slice:
740 for j := 0; j < propertyValue.Len(); j++ {
Colin Cross7e0eaf12017-05-05 16:16:24 -0700741 err := printfIntoProperty(propertyValue.Index(j), variableValue)
742 if err != nil {
743 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
744 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700745 }
Colin Crossdd0dbe62015-12-02 15:24:38 -0800746 case reflect.Bool:
747 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -0700748 case reflect.Struct:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700749 printfIntoProperties(ctx, prefix, propertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700750 default:
751 panic(fmt.Errorf("unsupported field kind %q", propertyValue.Kind()))
752 }
753 }
754}
755
Colin Cross7e0eaf12017-05-05 16:16:24 -0700756func printfIntoProperty(propertyValue reflect.Value, variableValue interface{}) error {
Colin Cross7f64b6d2015-07-09 13:57:48 -0700757 s := propertyValue.String()
Colin Cross7e0eaf12017-05-05 16:16:24 -0700758
759 count := strings.Count(s, "%")
760 if count == 0 {
761 return nil
762 }
763
764 if count > 1 {
765 return fmt.Errorf("product variable properties only support a single '%%'")
766 }
767
Colin Cross7f64b6d2015-07-09 13:57:48 -0700768 if strings.Contains(s, "%d") {
769 switch v := variableValue.(type) {
770 case int:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700771 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -0700772 case bool:
773 if v {
Colin Cross7e0eaf12017-05-05 16:16:24 -0700774 variableValue = 1
775 } else {
776 variableValue = 0
Colin Cross7f64b6d2015-07-09 13:57:48 -0700777 }
778 default:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700779 return fmt.Errorf("unsupported type %T for %%d", variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700780 }
Colin Cross7e0eaf12017-05-05 16:16:24 -0700781 } else if strings.Contains(s, "%s") {
782 switch variableValue.(type) {
783 case string:
784 // Nothing
785 default:
786 return fmt.Errorf("unsupported type %T for %%s", variableValue)
787 }
788 } else {
789 return fmt.Errorf("unsupported %% in product variable property")
Colin Cross7f64b6d2015-07-09 13:57:48 -0700790 }
Colin Cross7e0eaf12017-05-05 16:16:24 -0700791
792 propertyValue.Set(reflect.ValueOf(fmt.Sprintf(s, variableValue)))
793
794 return nil
Colin Cross7f64b6d2015-07-09 13:57:48 -0700795}
Colin Cross18c46802019-09-24 22:19:02 -0700796
797var variablePropTypeMap OncePer
798
799// sliceToTypeArray takes a slice of property structs and returns a reflection created array containing the
800// reflect.Types of each property struct. The result can be used as a key in a map.
801func sliceToTypeArray(s []interface{}) interface{} {
802 // Create an array using reflection whose length is the length of the input slice
803 ret := reflect.New(reflect.ArrayOf(len(s), reflect.TypeOf(reflect.TypeOf(0)))).Elem()
804 for i, e := range s {
805 ret.Index(i).Set(reflect.ValueOf(reflect.TypeOf(e)))
806 }
807 return ret.Interface()
808}
809
Colin Crosseabaedd2020-02-06 17:01:55 -0800810func initProductVariableModule(m Module) {
811 base := m.base()
812
813 // Allow tests to override the default product variables
814 if base.variableProperties == nil {
815 base.variableProperties = defaultProductVariables
816 }
817 // Filter the product variables properties to the ones that exist on this module
818 base.variableProperties = createVariableProperties(m.GetProperties(), base.variableProperties)
819 if base.variableProperties != nil {
820 m.AddProperties(base.variableProperties)
821 }
822}
823
Colin Cross18c46802019-09-24 22:19:02 -0700824// createVariableProperties takes the list of property structs for a module and returns a property struct that
825// contains the product variable properties that exist in the property structs, or nil if there are none. It
826// caches the result.
827func createVariableProperties(moduleTypeProps []interface{}, productVariables interface{}) interface{} {
828 // Convert the moduleTypeProps to an array of reflect.Types that can be used as a key in the OncePer.
829 key := sliceToTypeArray(moduleTypeProps)
830
831 // Use the variablePropTypeMap OncePer to cache the result for each set of property struct types.
832 typ, _ := variablePropTypeMap.Once(NewCustomOnceKey(key), func() interface{} {
833 // Compute the filtered property struct type.
834 return createVariablePropertiesType(moduleTypeProps, productVariables)
835 }).(reflect.Type)
836
837 if typ == nil {
838 return nil
839 }
840
841 // Create a new pointer to a filtered property struct.
842 return reflect.New(typ).Interface()
843}
844
845// createVariablePropertiesType creates a new type that contains only the product variable properties that exist in
846// a list of property structs.
847func createVariablePropertiesType(moduleTypeProps []interface{}, productVariables interface{}) reflect.Type {
848 typ, _ := proptools.FilterPropertyStruct(reflect.TypeOf(productVariables),
849 func(field reflect.StructField, prefix string) (bool, reflect.StructField) {
850 // Filter function, returns true if the field should be in the resulting struct
851 if prefix == "" {
852 // Keep the top level Product_variables field
853 return true, field
854 }
855 _, rest := splitPrefix(prefix)
856 if rest == "" {
857 // Keep the 2nd level field (i.e. Product_variables.Eng)
858 return true, field
859 }
860
861 // Strip off the first 2 levels of the prefix
862 _, prefix = splitPrefix(rest)
863
864 for _, p := range moduleTypeProps {
865 if fieldExistsByNameRecursive(reflect.TypeOf(p).Elem(), prefix, field.Name) {
866 // Keep any fields that exist in one of the property structs
867 return true, field
868 }
869 }
870
871 return false, field
872 })
873 return typ
874}
875
876func splitPrefix(prefix string) (first, rest string) {
877 index := strings.IndexByte(prefix, '.')
878 if index == -1 {
879 return prefix, ""
880 }
881 return prefix[:index], prefix[index+1:]
882}
883
884func fieldExistsByNameRecursive(t reflect.Type, prefix, name string) bool {
885 if t.Kind() != reflect.Struct {
886 panic(fmt.Errorf("fieldExistsByNameRecursive can only be called on a reflect.Struct"))
887 }
888
889 if prefix != "" {
890 split := strings.SplitN(prefix, ".", 2)
891 firstPrefix := split[0]
892 rest := ""
893 if len(split) > 1 {
894 rest = split[1]
895 }
896 f, exists := t.FieldByName(firstPrefix)
897 if !exists {
898 return false
899 }
900 ft := f.Type
901 if ft.Kind() == reflect.Ptr {
902 ft = ft.Elem()
903 }
904 if ft.Kind() != reflect.Struct {
905 panic(fmt.Errorf("field %q in %q is not a struct", firstPrefix, t))
906 }
907 return fieldExistsByNameRecursive(ft, rest, name)
908 } else {
909 _, exists := t.FieldByName(name)
910 return exists
911 }
912}