blob: 648e4cf189f11101bb684e1c4b4ff1980d5b95e3 [file] [log] [blame]
Colin Cross7f64b6d2015-07-09 13:57:48 -07001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
Colin Cross635c3b02016-05-18 15:37:25 -070015package android
Colin Cross7f64b6d2015-07-09 13:57:48 -070016
17import (
18 "fmt"
19 "reflect"
Dan Willemsen490fd492015-11-24 17:53:15 -080020 "runtime"
Colin Cross7f64b6d2015-07-09 13:57:48 -070021 "strings"
22
Cole Faust701ca252021-11-23 19:02:08 -080023 "android/soong/android/soongconfig"
24 "android/soong/bazel"
25
Colin Cross7f64b6d2015-07-09 13:57:48 -070026 "github.com/google/blueprint/proptools"
27)
28
29func init() {
Paul Duffine7a055c2021-03-07 15:46:33 +000030 registerVariableBuildComponents(InitRegistrationContext)
31}
32
33func registerVariableBuildComponents(ctx RegistrationContext) {
34 ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
Colin Crosseabaedd2020-02-06 17:01:55 -080035 ctx.BottomUp("variable", VariableMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070036 })
Colin Cross7f64b6d2015-07-09 13:57:48 -070037}
38
Paul Duffine7a055c2021-03-07 15:46:33 +000039var PrepareForTestWithVariables = FixtureRegisterWithContext(registerVariableBuildComponents)
40
Colin Cross7f64b6d2015-07-09 13:57:48 -070041type variableProperties struct {
42 Product_variables struct {
Dan Willemsen47cf66b2015-09-16 16:48:54 -070043 Platform_sdk_version struct {
44 Asflags []string
Colin Crossceeff0f2017-05-08 13:43:00 -070045 Cflags []string
Dan Willemsen9fe14102021-07-13 21:52:04 -070046 Cmd *string
Dan Willemsen47cf66b2015-09-16 16:48:54 -070047 }
Colin Cross83163192015-12-01 16:31:16 -080048
Yuntao Xu402e9b02021-08-09 15:44:44 -070049 Platform_sdk_version_or_codename struct {
50 Java_resource_dirs []string
51 }
52
Anton Hanssonb021bf82021-08-27 17:35:40 +010053 Platform_sdk_extension_version struct {
54 Cmd *string
55 }
56
Dan Willemsen9fe14102021-07-13 21:52:04 -070057 Platform_version_name struct {
58 Base_dir *string
59 }
60
Colin Cross83163192015-12-01 16:31:16 -080061 // unbundled_build is a catch-all property to annotate modules that don't build in one or
62 // more unbundled branches, usually due to dependencies missing from the manifest.
63 Unbundled_build struct {
64 Enabled *bool `android:"arch_variant"`
65 } `android:"arch_variant"`
Dan Willemsen496e3952016-01-05 14:27:55 -080066
Jeongik Chaf08e59c2023-02-09 10:47:59 +090067 // similar to `Unbundled_build`, but `Always_use_prebuilt_sdks` means that it uses prebuilt
68 // sdk specifically.
69 Always_use_prebuilt_sdks struct {
70 Enabled *bool `android:"arch_variant"`
71 } `android:"arch_variant"`
72
Dan Willemsen97cae012016-03-01 14:08:42 -080073 Malloc_not_svelte struct {
Christopher Ferrisc71193a2019-12-16 09:55:10 -080074 Cflags []string `android:"arch_variant"`
75 Shared_libs []string `android:"arch_variant"`
76 Whole_static_libs []string `android:"arch_variant"`
77 Exclude_static_libs []string `android:"arch_variant"`
Christopher Ferrisdea66172021-09-24 00:07:53 -070078 Srcs []string `android:"arch_variant"`
79 Header_libs []string `android:"arch_variant"`
Sasha Smundak61ebf8d2018-08-31 16:56:05 -070080 } `android:"arch_variant"`
Evgenii Stepanov8391efa2016-05-12 18:04:18 -070081
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -070082 Malloc_zero_contents struct {
83 Cflags []string `android:"arch_variant"`
84 } `android:"arch_variant"`
85
86 Malloc_pattern_fill_contents struct {
87 Cflags []string `android:"arch_variant"`
88 } `android:"arch_variant"`
89
Evgenii Stepanov8391efa2016-05-12 18:04:18 -070090 Safestack struct {
91 Cflags []string `android:"arch_variant"`
92 } `android:"arch_variant"`
Dan Willemsena6f7d152016-07-12 14:57:40 -070093
Dan Willemsen1be35382016-07-25 17:42:18 -070094 Binder32bit struct {
95 Cflags []string
96 }
Dan Willemsenfcebcd52016-09-22 14:49:10 -070097
Colin Cross95436422017-05-04 13:57:05 -070098 Override_rs_driver struct {
99 Cflags []string
100 }
101
Steven Morelandc2b9f062017-12-13 14:06:20 -0800102 // treble_linker_namespaces is true when the system/vendor linker namespace separation is
103 // enabled.
104 Treble_linker_namespaces struct {
105 Cflags []string
106 }
Steven Morelandc2b9f062017-12-13 14:06:20 -0800107 // enforce_vintf_manifest is true when a device is required to have a vintf manifest.
108 Enforce_vintf_manifest struct {
109 Cflags []string
110 }
111
Jihoon Kangcbcad7c2023-06-01 22:31:52 +0000112 Build_from_text_stub struct {
113 Static_libs []string
114 Exclude_static_libs []string
115 }
116
Colin Cross6bc59ef2016-12-08 09:46:35 -0800117 // debuggable is true for eng and userdebug builds, and can be used to turn on additional
118 // debugging features that don't significantly impact runtime behavior. userdebug builds
119 // are used for dogfooding and performance testing, and should be as similar to user builds
120 // as possible.
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700121 Debuggable struct {
Sasha Smundakb6d23052019-04-01 18:37:36 -0700122 Cflags []string
123 Cppflags []string
124 Init_rc []string
125 Required []string
126 Host_required []string
127 Target_required []string
Philip Cuadra328e0bf2020-10-19 22:01:29 -0700128 Strip struct {
129 All *bool
130 Keep_symbols *bool
131 Keep_symbols_and_debug_frame *bool
132 }
Yifan Hong8f323ae2021-06-23 20:01:13 -0700133 Static_libs []string
134 Whole_static_libs []string
135 Shared_libs []string
Jiyong Park16e77a92021-08-30 18:43:19 +0900136
137 Cmdline []string
Inseob Kimf5ed3002022-01-07 19:17:29 +0900138
Jay Aliomer2599d1d2021-09-23 15:49:54 -0400139 Srcs []string
140 Exclude_srcs []string
Cole Fausted940002023-08-15 11:59:24 -0700141 Cmd *string
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700142 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800143
Usta Shresthac725f472022-01-11 02:44:21 -0500144 // eng is true for -eng builds, and can be used to turn on additional heavyweight debugging
Colin Cross6bc59ef2016-12-08 09:46:35 -0800145 // features.
146 Eng struct {
147 Cflags []string
148 Cppflags []string
John Reck1d2b7ee2018-07-11 11:01:59 -0700149 Lto struct {
150 Never *bool
151 }
Colin Cross3273cc22018-10-26 23:58:42 -0700152 Sanitize struct {
153 Address *bool
154 }
Felka Changf13642e2019-06-21 20:58:27 +0800155 Optimize struct {
156 Enabled *bool
157 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800158 }
Colin Crossb2123aa2017-05-05 13:37:11 -0700159
Dmitry Shmidtdba54192017-08-23 14:58:37 -0700160 Uml struct {
161 Cppflags []string
162 }
Risanea004dd2017-11-27 18:14:46 +0900163
164 Arc struct {
Satoshi Niwa54f48262020-12-18 09:53:26 +0900165 Cflags []string `android:"arch_variant"`
166 Exclude_srcs []string `android:"arch_variant"`
Jasmine Chenacace422021-03-05 00:56:40 +0800167 Header_libs []string `android:"arch_variant"`
Satoshi Niwa54f48262020-12-18 09:53:26 +0900168 Include_dirs []string `android:"arch_variant"`
169 Shared_libs []string `android:"arch_variant"`
170 Static_libs []string `android:"arch_variant"`
171 Srcs []string `android:"arch_variant"`
172 Whole_static_libs []string `android:"arch_variant"`
173 } `android:"arch_variant"`
Roland Levillain2879d412019-08-13 15:00:18 +0100174
Colin Crossd9a121b2020-01-27 13:26:42 -0800175 Native_coverage struct {
Colin Cross2b10ba02020-02-05 16:23:21 -0800176 Src *string `android:"arch_variant"`
Colin Crossd9a121b2020-01-27 13:26:42 -0800177 Srcs []string `android:"arch_variant"`
178 Exclude_srcs []string `android:"arch_variant"`
179 } `android:"arch_variant"`
Devin Moorec381e102023-07-06 22:03:58 +0000180
181 // release_aidl_use_unfrozen is "true" when a device can
182 // use the unfrozen versions of AIDL interfaces.
183 Release_aidl_use_unfrozen struct {
184 Cflags []string
185 Cmd *string
186 }
Colin Cross83163192015-12-01 16:31:16 -0800187 } `android:"arch_variant"`
Colin Cross7f64b6d2015-07-09 13:57:48 -0700188}
189
Colin Cross6961a492020-02-06 16:57:45 -0800190var defaultProductVariables interface{} = variableProperties{}
Colin Cross7f64b6d2015-07-09 13:57:48 -0700191
Cole Faustf8231dd2023-04-21 17:37:11 -0700192type ProductVariables struct {
Dan Willemsen174978c2016-05-11 00:27:49 -0700193 // Suffix to add to generated Makefiles
194 Make_suffix *string `json:",omitempty"`
195
Colin Cross2a2e0db2020-02-21 16:55:46 -0800196 BuildId *string `json:",omitempty"`
197 BuildNumberFile *string `json:",omitempty"`
Nan Zhang581fd212018-01-10 16:06:12 -0800198
Colin Cross092c9da2019-04-02 22:56:43 -0700199 Platform_version_name *string `json:",omitempty"`
200 Platform_sdk_version *int `json:",omitempty"`
201 Platform_sdk_codename *string `json:",omitempty"`
Yuntao Xu402e9b02021-08-09 15:44:44 -0700202 Platform_sdk_version_or_codename *string `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700203 Platform_sdk_final *bool `json:",omitempty"`
Anton Hanssonb021bf82021-08-27 17:35:40 +0100204 Platform_sdk_extension_version *int `json:",omitempty"`
Anton Hansson97d0bae2022-02-16 16:15:10 +0000205 Platform_base_sdk_extension_version *int `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700206 Platform_version_active_codenames []string `json:",omitempty"`
Dan Albert8c7a9942023-03-27 20:34:01 +0000207 Platform_version_all_preview_codenames []string `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700208 Platform_vndk_version *string `json:",omitempty"`
209 Platform_systemsdk_versions []string `json:",omitempty"`
210 Platform_security_patch *string `json:",omitempty"`
211 Platform_preview_sdk_version *string `json:",omitempty"`
212 Platform_min_supported_target_sdk_version *string `json:",omitempty"`
213 Platform_base_os *string `json:",omitempty"`
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900214 Platform_version_last_stable *string `json:",omitempty"`
Jiyong Park37073842022-06-21 10:13:42 +0900215 Platform_version_known_codenames *string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700216
Jeongik Cha219141c2020-08-06 23:00:37 +0900217 DeviceName *string `json:",omitempty"`
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000218 DeviceProduct *string `json:",omitempty"`
Jeongik Cha219141c2020-08-06 23:00:37 +0900219 DeviceArch *string `json:",omitempty"`
220 DeviceArchVariant *string `json:",omitempty"`
221 DeviceCpuVariant *string `json:",omitempty"`
222 DeviceAbi []string `json:",omitempty"`
223 DeviceVndkVersion *string `json:",omitempty"`
224 DeviceCurrentApiLevelForVendorModules *string `json:",omitempty"`
225 DeviceSystemSdkVersions []string `json:",omitempty"`
Juan Yescas05d4d902023-04-07 10:35:35 -0700226 DeviceMaxPageSizeSupported *string `json:",omitempty"`
Juan Yescas01065602023-08-09 08:34:37 -0700227 DevicePageSizeAgnostic *bool `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700228
Jose Galmes6f843bc2020-12-11 13:36:29 -0800229 RecoverySnapshotVersion *string `json:",omitempty"`
230
Colin Crossa74ca042019-01-31 14:31:51 -0800231 DeviceSecondaryArch *string `json:",omitempty"`
232 DeviceSecondaryArchVariant *string `json:",omitempty"`
233 DeviceSecondaryCpuVariant *string `json:",omitempty"`
234 DeviceSecondaryAbi []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700235
dimitry8d6dde82019-07-11 10:23:53 +0200236 NativeBridgeArch *string `json:",omitempty"`
237 NativeBridgeArchVariant *string `json:",omitempty"`
238 NativeBridgeCpuVariant *string `json:",omitempty"`
239 NativeBridgeAbi []string `json:",omitempty"`
240 NativeBridgeRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100241
dimitry8d6dde82019-07-11 10:23:53 +0200242 NativeBridgeSecondaryArch *string `json:",omitempty"`
243 NativeBridgeSecondaryArchVariant *string `json:",omitempty"`
244 NativeBridgeSecondaryCpuVariant *string `json:",omitempty"`
245 NativeBridgeSecondaryAbi []string `json:",omitempty"`
246 NativeBridgeSecondaryRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100247
Colin Cross4225f652015-09-17 14:33:42 -0700248 HostArch *string `json:",omitempty"`
249 HostSecondaryArch *string `json:",omitempty"`
Colin Cross528d67e2021-07-23 22:23:07 +0000250 HostMusl *bool `json:",omitempty"`
Dan Willemsen490fd492015-11-24 17:53:15 -0800251
252 CrossHost *string `json:",omitempty"`
253 CrossHostArch *string `json:",omitempty"`
254 CrossHostSecondaryArch *string `json:",omitempty"`
Colin Cross83163192015-12-01 16:31:16 -0800255
Jeongik Chacee5ba92021-02-19 12:11:51 +0900256 DeviceResourceOverlays []string `json:",omitempty"`
257 ProductResourceOverlays []string `json:",omitempty"`
258 EnforceRROTargets []string `json:",omitempty"`
Colin Crossa74ca042019-01-31 14:31:51 -0800259 EnforceRROExcludedOverlays []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700260
Colin Crossa74ca042019-01-31 14:31:51 -0800261 AAPTCharacteristics *string `json:",omitempty"`
262 AAPTConfig []string `json:",omitempty"`
263 AAPTPreferredConfig *string `json:",omitempty"`
264 AAPTPrebuiltDPI []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700265
Inseob Kim80fa7982022-08-12 21:36:25 +0900266 DefaultAppCertificate *string `json:",omitempty"`
267 MainlineSepolicyDevCertificates *string `json:",omitempty"`
Colin Cross61ae0b72017-12-01 17:16:02 -0800268
Colin Crossface4e42017-10-30 17:32:15 -0700269 AppsDefaultVersionName *string `json:",omitempty"`
270
Cole Faust701ca252021-11-23 19:02:08 -0800271 Allow_missing_dependencies *bool `json:",omitempty"`
272 Unbundled_build *bool `json:",omitempty"`
273 Unbundled_build_apps []string `json:",omitempty"`
274 Unbundled_build_image *bool `json:",omitempty"`
275 Always_use_prebuilt_sdks *bool `json:",omitempty"`
276 Skip_boot_jars_check *bool `json:",omitempty"`
277 Malloc_not_svelte *bool `json:",omitempty"`
278 Malloc_zero_contents *bool `json:",omitempty"`
279 Malloc_pattern_fill_contents *bool `json:",omitempty"`
280 Safestack *bool `json:",omitempty"`
281 HostStaticBinaries *bool `json:",omitempty"`
282 Binder32bit *bool `json:",omitempty"`
283 UseGoma *bool `json:",omitempty"`
284 UseRBE *bool `json:",omitempty"`
285 UseRBEJAVAC *bool `json:",omitempty"`
286 UseRBER8 *bool `json:",omitempty"`
287 UseRBED8 *bool `json:",omitempty"`
288 Debuggable *bool `json:",omitempty"`
289 Eng *bool `json:",omitempty"`
290 Treble_linker_namespaces *bool `json:",omitempty"`
291 Enforce_vintf_manifest *bool `json:",omitempty"`
292 Uml *bool `json:",omitempty"`
293 Arc *bool `json:",omitempty"`
294 MinimizeJavaDebugInfo *bool `json:",omitempty"`
Jihoon Kangcbcad7c2023-06-01 22:31:52 +0000295 Build_from_text_stub *bool `json:",omitempty"`
Colin Cross16b23492016-01-06 14:41:07 -0800296
Logan Chien4fcea3d2018-11-20 11:59:08 +0800297 Check_elf_files *bool `json:",omitempty"`
298
Colin Cross5a0dcd52018-10-05 14:20:06 -0700299 UncompressPrivAppDex *bool `json:",omitempty"`
300 ModulesLoadedByPrivilegedModules []string `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800301
satayevd604b212021-07-21 14:23:52 +0100302 BootJars ConfiguredJarList `json:",omitempty"`
303 ApexBootJars ConfiguredJarList `json:",omitempty"`
Vladimir Markoe8b00d62018-12-21 15:54:16 +0000304
Colin Crossa74ca042019-01-31 14:31:51 -0800305 IntegerOverflowExcludePaths []string `json:",omitempty"`
Ivan Lozano5f595532017-07-13 14:46:05 -0700306
Colin Crossa74ca042019-01-31 14:31:51 -0800307 EnableCFI *bool `json:",omitempty"`
308 CFIExcludePaths []string `json:",omitempty"`
309 CFIIncludePaths []string `json:",omitempty"`
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -0700310
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -0800311 DisableScudo *bool `json:",omitempty"`
312
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -0800313 MemtagHeapExcludePaths []string `json:",omitempty"`
314 MemtagHeapAsyncIncludePaths []string `json:",omitempty"`
315 MemtagHeapSyncIncludePaths []string `json:",omitempty"`
316
Hang Lua98aab92023-03-17 13:17:22 +0800317 HWASanIncludePaths []string `json:",omitempty"`
Tomislav Novakf734f002023-08-22 10:51:44 -0700318 HWASanExcludePaths []string `json:",omitempty"`
Hang Lua98aab92023-03-17 13:17:22 +0800319
Justin Yund5f6c822019-06-25 16:47:17 +0900320 VendorPath *string `json:",omitempty"`
321 OdmPath *string `json:",omitempty"`
322 ProductPath *string `json:",omitempty"`
323 SystemExtPath *string `json:",omitempty"`
Dan Willemsen4353bc42016-12-05 17:16:02 -0800324
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700325 ClangTidy *bool `json:",omitempty"`
326 TidyChecks *string `json:",omitempty"`
327
Roland Levillainada12702020-06-09 13:07:36 +0100328 JavaCoveragePaths []string `json:",omitempty"`
329 JavaCoverageExcludePaths []string `json:",omitempty"`
330
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -0800331 GcovCoverage *bool `json:",omitempty"`
332 ClangCoverage *bool `json:",omitempty"`
333 NativeCoveragePaths []string `json:",omitempty"`
334 NativeCoverageExcludePaths []string `json:",omitempty"`
335 ClangCoverageContinuousMode *bool `json:",omitempty"`
Dan Willemsen581341d2017-02-09 16:16:31 -0800336
Colin Cross1a6acd42020-06-16 17:51:46 -0700337 // Set by NewConfig
Liz Kammer09f947d2021-05-12 14:51:49 -0400338 Native_coverage *bool `json:",omitempty"`
Colin Cross1a6acd42020-06-16 17:51:46 -0700339
Colin Cross23ae82a2016-11-02 14:34:39 -0700340 SanitizeHost []string `json:",omitempty"`
341 SanitizeDevice []string `json:",omitempty"`
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700342 SanitizeDeviceDiag []string `json:",omitempty"`
Colin Cross23ae82a2016-11-02 14:34:39 -0700343 SanitizeDeviceArch []string `json:",omitempty"`
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800344
345 ArtUseReadBarrier *bool `json:",omitempty"`
Jack He8cc71432016-12-08 15:45:07 -0800346
347 BtConfigIncludeDir *string `json:",omitempty"`
Colin Cross95436422017-05-04 13:57:05 -0700348
349 Override_rs_driver *string `json:",omitempty"`
Jiyong Parkd773eb32017-07-03 13:18:12 +0900350
351 DeviceKernelHeaders []string `json:",omitempty"`
Justin Yun71549282017-11-17 12:10:28 +0900352
353 ExtraVndkVersions []string `json:",omitempty"`
Jeff Gaston088e29e2017-11-29 16:47:17 -0800354
355 NamespacesToExport []string `json:",omitempty"`
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -0800356
Vinh Tran7a8362c2022-11-01 15:33:51 -0400357 PgoAdditionalProfileDirs []string `json:",omitempty"`
Dan Willemsen0fe78662018-03-26 12:41:18 -0700358
Inseob Kimae553032019-05-14 18:52:49 +0900359 VndkUseCoreVariant *bool `json:",omitempty"`
360 VndkSnapshotBuildArtifacts *bool `json:",omitempty"`
Vic Yangefd249e2018-11-12 20:19:56 -0800361
Inseob Kim7cf14652021-01-06 23:06:52 +0900362 DirectedVendorSnapshot bool `json:",omitempty"`
363 VendorSnapshotModules map[string]bool `json:",omitempty"`
364
Jose Galmes4c6895e2021-02-09 07:44:30 -0800365 DirectedRecoverySnapshot bool `json:",omitempty"`
366 RecoverySnapshotModules map[string]bool `json:",omitempty"`
367
Justin DeMartino383bfb32021-02-24 10:49:43 -0800368 VendorSnapshotDirsIncluded []string `json:",omitempty"`
369 VendorSnapshotDirsExcluded []string `json:",omitempty"`
370 RecoverySnapshotDirsExcluded []string `json:",omitempty"`
371 RecoverySnapshotDirsIncluded []string `json:",omitempty"`
Rob Seymour925aa092021-08-10 20:42:03 +0000372 HostFakeSnapshotEnabled bool `json:",omitempty"`
Justin DeMartino383bfb32021-02-24 10:49:43 -0800373
Inseob Kim5eb7ee92022-04-27 10:30:34 +0900374 MultitreeUpdateMeta bool `json:",omitempty"`
375
Inseob Kim6077b232023-08-31 16:49:59 +0900376 BoardVendorSepolicyDirs []string `json:",omitempty"`
377 BoardOdmSepolicyDirs []string `json:",omitempty"`
378 SystemExtPublicSepolicyDirs []string `json:",omitempty"`
379 SystemExtPrivateSepolicyDirs []string `json:",omitempty"`
380 BoardSepolicyM4Defs []string `json:",omitempty"`
Tri Vo35a51432018-03-25 20:00:00 -0700381
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900382 BoardSepolicyVers *string `json:",omitempty"`
383 PlatformSepolicyVersion *string `json:",omitempty"`
Inseob Kima10ef272021-09-15 03:04:53 +0000384 TotSepolicyVersion *string `json:",omitempty"`
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900385
Inseob Kim1a0afcc2022-02-14 23:10:51 +0900386 SystemExtSepolicyPrebuiltApiDir *string `json:",omitempty"`
387 ProductSepolicyPrebuiltApiDir *string `json:",omitempty"`
388
Inseob Kim843f6642022-01-07 09:11:23 +0900389 PlatformSepolicyCompatVersions []string `json:",omitempty"`
390
Dan Willemsen0fe78662018-03-26 12:41:18 -0700391 VendorVars map[string]map[string]string `json:",omitempty"`
Colin Cross395f2cf2018-10-24 16:10:32 -0700392
Dan Albertd05ba002021-04-13 15:55:47 -0700393 Ndk_abis *bool `json:",omitempty"`
Jiyong Park8fd61922018-11-08 02:50:25 +0900394
Dennis Shene2ed70c2023-01-11 14:15:43 +0000395 TrimmedApex *bool `json:",omitempty"`
Jiyong Park4da07972021-01-05 21:01:11 +0900396 ForceApexSymlinkOptimization *bool `json:",omitempty"`
397 CompressedApex *bool `json:",omitempty"`
398 Aml_abis *bool `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800399
400 DexpreoptGlobalConfig *string `json:",omitempty"`
Jiyong Park7f67f482019-01-05 12:57:48 +0900401
Inseob Kim7b85eeb2021-03-23 20:52:24 +0900402 WithDexpreopt bool `json:",omitempty"`
403
Jiakai Zhang4d90da22023-07-12 16:51:48 +0100404 ManifestPackageNameOverrides []string `json:",omitempty"`
405 CertificateOverrides []string `json:",omitempty"`
406 PackageNameOverrides []string `json:",omitempty"`
407 ConfiguredJarLocationOverrides []string `json:",omitempty"`
Jeongik Chac9464142019-01-07 12:07:27 +0900408
Albert Martineefabcf2022-03-21 20:11:16 +0000409 ApexGlobalMinSdkVersionOverride *string `json:",omitempty"`
410
Jeongik Chac9464142019-01-07 12:07:27 +0900411 EnforceSystemCertificate *bool `json:",omitempty"`
Colin Cross440e0d02020-06-11 11:32:11 -0700412 EnforceSystemCertificateAllowList []string `json:",omitempty"`
Colin Cross8faf8fc2019-01-16 15:15:52 -0800413
Colin Crossf24a22a2019-01-31 14:12:44 -0800414 ProductHiddenAPIStubs []string `json:",omitempty"`
415 ProductHiddenAPIStubsSystem []string `json:",omitempty"`
416 ProductHiddenAPIStubsTest []string `json:",omitempty"`
Dan Willemsen71c74602019-04-10 12:27:35 -0700417
Inseob Kim0866b002019-04-15 20:21:29 +0900418 ProductPublicSepolicyDirs []string `json:",omitempty"`
419 ProductPrivateSepolicyDirs []string `json:",omitempty"`
Inseob Kim0866b002019-04-15 20:21:29 +0900420
Dan Willemsen54879d12019-04-18 10:08:46 -0700421 TargetFSConfigGen []string `json:",omitempty"`
Colin Cross50ddcc42019-05-16 12:28:22 -0700422
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900423 EnforceProductPartitionInterface *bool `json:",omitempty"`
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900424
JaeMan Parkff715562020-10-19 17:25:58 +0900425 EnforceInterPartitionJavaSdkLibrary *bool `json:",omitempty"`
426 InterPartitionJavaLibraryAllowList []string `json:",omitempty"`
427
Yifan Hong82db7352020-01-21 16:12:26 -0800428 BoardUsesRecoveryAsBoot *bool `json:",omitempty"`
Yifan Hong97365ee2020-07-29 09:51:57 -0700429
Yifan Hong42bef8d2020-08-05 14:36:09 -0700430 BoardKernelBinaries []string `json:",omitempty"`
431 BoardKernelModuleInterfaceVersions []string `json:",omitempty"`
Yifan Hongdd8dacc2020-10-21 15:40:17 -0700432
433 BoardMoveRecoveryResourcesToVendorBoot *bool `json:",omitempty"`
Bill Peckhambae47492021-01-08 09:34:44 -0800434
435 PrebuiltHiddenApiDir *string `json:",omitempty"`
Inseob Kim60c32f02020-12-21 22:53:05 +0900436
437 ShippingApiLevel *string `json:",omitempty"`
Inseob Kim0cac7b42021-02-03 18:16:46 +0900438
Cole Faustded79602023-09-05 17:48:11 -0700439 BuildBrokenPluginValidation []string `json:",omitempty"`
440 BuildBrokenClangAsFlags bool `json:",omitempty"`
441 BuildBrokenClangCFlags bool `json:",omitempty"`
442 BuildBrokenClangProperty bool `json:",omitempty"`
443 GenruleSandboxing *bool `json:",omitempty"`
444 BuildBrokenEnforceSyspropOwner bool `json:",omitempty"`
445 BuildBrokenTrebleSyspropNeverallow bool `json:",omitempty"`
446 BuildBrokenUsesSoongPython2Modules bool `json:",omitempty"`
447 BuildBrokenVendorPropertyNamespace bool `json:",omitempty"`
448 BuildBrokenIncorrectPartitionImages bool `json:",omitempty"`
449 BuildBrokenInputDirModules []string `json:",omitempty"`
Inseob Kim67e5add192021-03-17 18:05:33 +0900450
Jiakai Zhang48203e32023-06-02 23:42:21 +0100451 BuildWarningBadOptionalUsesLibsAllowlist []string `json:",omitempty"`
452
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -0700453 BuildDebugfsRestrictionsEnabled bool `json:",omitempty"`
454
Inseob Kim67e5add192021-03-17 18:05:33 +0900455 RequiresInsecureExecmemForSwiftshader bool `json:",omitempty"`
456
457 SelinuxIgnoreNeverallows bool `json:",omitempty"`
458
Devin Moorec381e102023-07-06 22:03:58 +0000459 Release_aidl_use_unfrozen *bool `json:",omitempty"`
460
Inseob Kima10ef272021-09-15 03:04:53 +0000461 SepolicyFreezeTestExtraDirs []string `json:",omitempty"`
462 SepolicyFreezeTestExtraPrebuiltDirs []string `json:",omitempty"`
Jiyong Parkd163d4d2021-10-12 16:47:43 +0900463
464 GenerateAidlNdkPlatformBackend bool `json:",omitempty"`
Christopher Ferris98f10222022-07-13 23:16:52 -0700465
466 IgnorePrefer32OnDevice bool `json:",omitempty"`
Spandan Dasc5763832022-11-08 18:42:16 +0000467
Sam Delmerico98a73292023-02-21 11:50:29 -0500468 IncludeTags []string `json:",omitempty"`
469 SourceRootDirs []string `json:",omitempty"`
Vinh Tran44cb78c2023-03-09 22:07:19 -0500470
471 AfdoProfiles []string `json:",omitempty"`
Wei Lic642d682023-05-04 09:06:06 -0700472
473 ProductManufacturer string `json:",omitempty"`
474 ProductBrand string `json:",omitempty"`
475 BuildVersionTags []string `json:",omitempty"`
Joe Onoratofee845a2023-05-09 08:14:14 -0700476
Yu Liueebb2592023-10-12 20:31:27 -0700477 ReleaseVersion string `json:",omitempty"`
478 ReleaseAconfigValueSets []string `json:",omitempty"`
Kiyoung Kime623c582023-07-06 16:43:44 +0900479
Zhi Dou3f65a412023-08-10 21:47:40 +0000480 ReleaseAconfigFlagDefaultPermission string `json:",omitempty"`
481
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000482 ReleaseDefaultModuleBuildFromSource *bool `json:",omitempty"`
483
Kiyoung Kime623c582023-07-06 16:43:44 +0900484 KeepVndk *bool `json:",omitempty"`
Inseob Kim5bac3b62023-08-25 21:29:46 +0900485
486 CheckVendorSeappViolations *bool `json:",omitempty"`
Cole Faustb4cb0c82023-09-14 15:16:58 -0700487
Cole Faustcb193ec2023-09-20 16:01:18 -0700488 // PartitionVarsForBazelMigrationOnlyDoNotUse are extra variables that are used to define the
489 // partition images. They should not be read from soong modules.
490 PartitionVarsForBazelMigrationOnlyDoNotUse PartitionVariables `json:",omitempty"`
Jihoon Kangcfbc4072023-09-20 01:02:18 +0000491
492 NextReleaseHideFlaggedApi *bool `json:",omitempty"`
Jihoon Kangf3aa3222023-09-26 22:32:08 +0000493
494 Release_expose_flagged_api *bool `json:",omitempty"`
Inseob Kime4e85d52023-10-25 23:53:58 +0900495
496 BuildFlags map[string]string `json:",omitempty"`
Cole Faustcb193ec2023-09-20 16:01:18 -0700497}
498
Cole Faust11edf552023-10-13 11:32:14 -0700499type PartitionQualifiedVariablesType struct {
500 BuildingImage bool `json:",omitempty"`
501 BoardErofsCompressor string `json:",omitempty"`
502 BoardErofsCompressHints string `json:",omitempty"`
503 BoardErofsPclusterSize string `json:",omitempty"`
504 BoardExtfsInodeCount string `json:",omitempty"`
505 BoardExtfsRsvPct string `json:",omitempty"`
506 BoardF2fsSloadCompressFlags string `json:",omitempty"`
507 BoardFileSystemCompress string `json:",omitempty"`
508 BoardFileSystemType string `json:",omitempty"`
509 BoardJournalSize string `json:",omitempty"`
510 BoardPartitionReservedSize string `json:",omitempty"`
511 BoardPartitionSize string `json:",omitempty"`
512 BoardSquashfsBlockSize string `json:",omitempty"`
513 BoardSquashfsCompressor string `json:",omitempty"`
514 BoardSquashfsCompressorOpt string `json:",omitempty"`
515 BoardSquashfsDisable4kAlign string `json:",omitempty"`
516 ProductBaseFsPath string `json:",omitempty"`
517 ProductHeadroom string `json:",omitempty"`
518 ProductVerityPartition string `json:",omitempty"`
519
520 BoardAvbAddHashtreeFooterArgs string `json:",omitempty"`
521 BoardAvbKeyPath string `json:",omitempty"`
522 BoardAvbAlgorithm string `json:",omitempty"`
523 BoardAvbRollbackIndex string `json:",omitempty"`
524 BoardAvbRollbackIndexLocation string `json:",omitempty"`
525}
526
Cole Faustcb193ec2023-09-20 16:01:18 -0700527type PartitionVariables struct {
528 ProductDirectory string `json:",omitempty"`
Cole Faust11edf552023-10-13 11:32:14 -0700529 PartitionQualifiedVariables map[string]PartitionQualifiedVariablesType
530 TargetUserimagesUseExt2 bool `json:",omitempty"`
531 TargetUserimagesUseExt3 bool `json:",omitempty"`
532 TargetUserimagesUseExt4 bool `json:",omitempty"`
Cole Faustcb193ec2023-09-20 16:01:18 -0700533
534 TargetUserimagesSparseExtDisabled bool `json:",omitempty"`
535 TargetUserimagesSparseErofsDisabled bool `json:",omitempty"`
536 TargetUserimagesSparseSquashfsDisabled bool `json:",omitempty"`
537 TargetUserimagesSparseF2fsDisabled bool `json:",omitempty"`
538
539 BoardErofsCompressor string `json:",omitempty"`
540 BoardErofsCompressorHints string `json:",omitempty"`
541 BoardErofsPclusterSize string `json:",omitempty"`
542 BoardErofsShareDupBlocks string `json:",omitempty"`
543 BoardErofsUseLegacyCompression string `json:",omitempty"`
544 BoardExt4ShareDupBlocks string `json:",omitempty"`
545 BoardFlashLogicalBlockSize string `json:",omitempty"`
546 BoardFlashEraseBlockSize string `json:",omitempty"`
547 BoardUsesRecoveryAsBoot bool `json:",omitempty"`
548 BoardBuildGkiBootImageWithoutRamdisk bool `json:",omitempty"`
549 ProductUseDynamicPartitionSize bool `json:",omitempty"`
550 CopyImagesForTargetFilesZip bool `json:",omitempty"`
Cole Faustb5055392023-09-27 13:44:40 -0700551
552 BoardAvbEnable bool `json:",omitempty"`
Cole Faust11edf552023-10-13 11:32:14 -0700553
554 ProductPackages []string `json:",omitempty"`
Colin Crossa6bc19e2015-09-16 13:53:42 -0700555}
556
557func boolPtr(v bool) *bool {
558 return &v
Colin Cross485e5722015-08-27 13:28:01 -0700559}
560
Dan Willemsen47cf66b2015-09-16 16:48:54 -0700561func intPtr(v int) *int {
562 return &v
563}
564
Colin Cross4225f652015-09-17 14:33:42 -0700565func stringPtr(v string) *string {
566 return &v
567}
568
Cole Faustf8231dd2023-04-21 17:37:11 -0700569func (v *ProductVariables) SetDefaultConfig() {
570 *v = ProductVariables{
Colin Cross2a2e0db2020-02-21 16:55:46 -0800571 BuildNumberFile: stringPtr("build_number.txt"),
Dan Willemsenb6d171b2019-04-07 09:41:44 -0700572
Dan Albert8c7a9942023-03-27 20:34:01 +0000573 Platform_version_name: stringPtr("S"),
574 Platform_base_sdk_extension_version: intPtr(30),
575 Platform_sdk_version: intPtr(30),
576 Platform_sdk_codename: stringPtr("S"),
577 Platform_sdk_final: boolPtr(false),
578 Platform_version_active_codenames: []string{"S"},
579 Platform_version_all_preview_codenames: []string{"S"},
580 Platform_vndk_version: stringPtr("S"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800581
Colin Cross4225f652015-09-17 14:33:42 -0700582 HostArch: stringPtr("x86_64"),
583 HostSecondaryArch: stringPtr("x86"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800584 DeviceName: stringPtr("generic_arm64"),
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000585 DeviceProduct: stringPtr("aosp_arm-eng"),
Colin Cross4225f652015-09-17 14:33:42 -0700586 DeviceArch: stringPtr("arm64"),
Dan Willemsena91d1272016-03-29 22:06:05 -0700587 DeviceArchVariant: stringPtr("armv8-a"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800588 DeviceCpuVariant: stringPtr("generic"),
Colin Crossa74ca042019-01-31 14:31:51 -0800589 DeviceAbi: []string{"arm64-v8a"},
Colin Cross4225f652015-09-17 14:33:42 -0700590 DeviceSecondaryArch: stringPtr("arm"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800591 DeviceSecondaryArchVariant: stringPtr("armv8-a"),
592 DeviceSecondaryCpuVariant: stringPtr("generic"),
Colin Crossa74ca042019-01-31 14:31:51 -0800593 DeviceSecondaryAbi: []string{"armeabi-v7a", "armeabi"},
Juan Yescas05d4d902023-04-07 10:35:35 -0700594 DeviceMaxPageSizeSupported: stringPtr("4096"),
Juan Yescas01065602023-08-09 08:34:37 -0700595 DevicePageSizeAgnostic: boolPtr(false),
Colin Crossface4e42017-10-30 17:32:15 -0700596
Colin Crossa74ca042019-01-31 14:31:51 -0800597 AAPTConfig: []string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700598 AAPTPreferredConfig: stringPtr("xhdpi"),
599 AAPTCharacteristics: stringPtr("nosdcard"),
Colin Crossa74ca042019-01-31 14:31:51 -0800600 AAPTPrebuiltDPI: []string{"xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700601
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700602 Malloc_not_svelte: boolPtr(true),
Steven Morelandd1342012020-07-30 20:38:49 +0000603 Malloc_zero_contents: boolPtr(true),
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700604 Malloc_pattern_fill_contents: boolPtr(false),
605 Safestack: boolPtr(false),
Dennis Shene2ed70c2023-01-11 14:15:43 +0000606 TrimmedApex: boolPtr(false),
Jihoon Kangcbcad7c2023-06-01 22:31:52 +0000607 Build_from_text_stub: boolPtr(false),
Lukacs T. Berki720b3962021-03-17 13:34:30 +0100608
satayevd604b212021-07-21 14:23:52 +0100609 BootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
610 ApexBootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
Colin Cross485e5722015-08-27 13:28:01 -0700611 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800612
613 if runtime.GOOS == "linux" {
614 v.CrossHost = stringPtr("windows")
615 v.CrossHostArch = stringPtr("x86")
Dan Willemsen07cd0512016-02-03 23:16:33 -0800616 v.CrossHostSecondaryArch = stringPtr("x86_64")
Dan Willemsen490fd492015-11-24 17:53:15 -0800617 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700618}
619
Liz Kammera060c452021-03-24 10:14:47 -0400620// ProductConfigContext requires the access to the Module to get product config properties.
621type ProductConfigContext interface {
622 Module() Module
623}
624
Cole Faust150f9a52023-04-26 10:52:24 -0700625// ProductConfigOrSoongConfigProperty represents either a soong config variable + its value
626// or a product config variable. You can get both a ConfigurationAxis and a SelectKey from it
627// for use in bazel attributes. ProductVariableProperties() will return a map from properties ->
628// this interface -> property structs for use in bp2build converters
629type ProductConfigOrSoongConfigProperty interface {
630 // Name of the product variable or soong config variable
631 Name() string
632 // AlwaysEmit returns true for soong config variables but false for product variables. This
633 // is intended to indicate if we need to always emit empty lists in the select statements.
634 AlwaysEmit() bool
635 // ConfigurationAxis returns the bazel.ConfigurationAxis that represents this variable. The
636 // configuration axis will change depending on the variable and whether it's arch/os variant
637 // as well.
638 ConfigurationAxis() bazel.ConfigurationAxis
639 // SelectKey returns a string that represents the key of a select branch, however, it is not
640 // actually the real label written out to the build file.
641 // this.ConfigurationAxis().SelectKey(this.SelectKey()) will give the actual label.
642 SelectKey() string
643}
644
645// ProductConfigProperty represents a product config variable, and if it is arch-variant or not.
Liz Kammera060c452021-03-24 10:14:47 -0400646type ProductConfigProperty struct {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000647 // The name of the product variable, e.g. "safestack", "malloc_not_svelte",
648 // "board"
Cole Faust150f9a52023-04-26 10:52:24 -0700649 name string
Jingwen Chena47f28d2021-11-02 16:43:57 +0000650
Cole Faust150f9a52023-04-26 10:52:24 -0700651 arch string
Liz Kammera060c452021-03-24 10:14:47 -0400652}
653
Cole Faust150f9a52023-04-26 10:52:24 -0700654func (p ProductConfigProperty) Name() string {
655 return p.name
Jingwen Chen58ff6802021-11-17 12:14:41 +0000656}
657
Cole Faust150f9a52023-04-26 10:52:24 -0700658func (p ProductConfigProperty) AlwaysEmit() bool {
659 return false
660}
661
662func (p ProductConfigProperty) ConfigurationAxis() bazel.ConfigurationAxis {
663 return bazel.ProductVariableConfigurationAxis(p.arch != "", p.name+"__"+p.arch)
664}
665
666func (p ProductConfigProperty) SelectKey() string {
667 if p.arch == "" {
668 return strings.ToLower(p.name)
Jingwen Chena47f28d2021-11-02 16:43:57 +0000669 } else {
Cole Faust150f9a52023-04-26 10:52:24 -0700670 return strings.ToLower(p.name + "-" + p.arch)
Jingwen Chena47f28d2021-11-02 16:43:57 +0000671 }
672}
673
Cole Faust150f9a52023-04-26 10:52:24 -0700674// SoongConfigProperty represents a soong config variable, its value if it's a string variable,
675// and if it's dependent on the OS or not
676type SoongConfigProperty struct {
677 name string
678 namespace string
679 // Can be an empty string for bool/value soong config variables
680 value string
681 // If there is a target: field inside a soong config property struct, the os that it selects
682 // on will be represented here.
683 os string
684}
685
686func (p SoongConfigProperty) Name() string {
687 return p.name
688}
689
690func (p SoongConfigProperty) AlwaysEmit() bool {
691 return true
692}
693
694func (p SoongConfigProperty) ConfigurationAxis() bazel.ConfigurationAxis {
695 return bazel.ProductVariableConfigurationAxis(false, p.namespace+"__"+p.name+"__"+p.os)
696}
697
Jingwen Chen25825ca2021-11-15 12:28:43 +0000698// SelectKey returns the literal string that represents this variable in a BUILD
699// select statement.
Cole Faust150f9a52023-04-26 10:52:24 -0700700func (p SoongConfigProperty) SelectKey() string {
701 // p.value being conditions_default can happen with or without a desired os. When not using
702 // an os, we want to emit literally just //conditions:default in the select statement, but
703 // when using an os, we want to emit namespace__name__conditions_default__os, so that
704 // the branch is only taken if the variable is not set, and we're on the desired os.
705 // ConfigurationAxis#SelectKey will map the conditions_default result of this function to
706 // //conditions:default.
707 if p.value == bazel.ConditionsDefaultConfigKey && p.os == "" {
Jingwen Chen25825ca2021-11-15 12:28:43 +0000708 return bazel.ConditionsDefaultConfigKey
709 }
710
Cole Faust150f9a52023-04-26 10:52:24 -0700711 parts := []string{p.namespace, p.name}
712 if p.value != "" && p.value != bazel.ConditionsDefaultSelectKey {
713 parts = append(parts, p.value)
714 }
715 if p.os != "" {
716 parts = append(parts, p.os)
Jingwen Chen25825ca2021-11-15 12:28:43 +0000717 }
Sam Delmerico0e33c9d2022-01-07 20:39:21 +0000718
Cole Faust150f9a52023-04-26 10:52:24 -0700719 // e.g. acme__feature1, android__board__soc_a, my_namespace__my_variables__my_value__my_os
720 return strings.ToLower(strings.Join(parts, "__"))
Jingwen Chen25825ca2021-11-15 12:28:43 +0000721}
722
723// ProductConfigProperties is a map of maps to group property values according
724// their property name and the product config variable they're set under.
725//
726// The outer map key is the name of the property, like "cflags".
727//
728// The inner map key is a ProductConfigProperty, which is a struct of product
729// variable name, namespace, and the "full configuration" of the product
730// variable.
731//
732// e.g. product variable name: board, namespace: acme, full config: vendor_chip_foo
733//
734// The value of the map is the interface{} representing the value of the
735// property, like ["-DDEFINES"] for cflags.
Cole Faust150f9a52023-04-26 10:52:24 -0700736type ProductConfigProperties map[string]map[ProductConfigOrSoongConfigProperty]interface{}
Liz Kammera060c452021-03-24 10:14:47 -0400737
738// ProductVariableProperties returns a ProductConfigProperties containing only the properties which
Cole Faust912bc882023-03-08 12:29:50 -0800739// have been set for the given module.
Liz Kammer9e2a5a72023-09-19 08:41:14 -0400740func ProductVariableProperties(ctx ArchVariantContext, module Module) (ProductConfigProperties, []error) {
741 var errs []error
Liz Kammera060c452021-03-24 10:14:47 -0400742 moduleBase := module.base()
743
744 productConfigProperties := ProductConfigProperties{}
745
Jingwen Chena47f28d2021-11-02 16:43:57 +0000746 if moduleBase.variableProperties != nil {
747 productVariablesProperty := proptools.FieldNameForProperty("product_variables")
Cole Fausted940002023-08-15 11:59:24 -0700748 if moduleBase.ArchSpecific() {
749 for /* axis */ _, configToProps := range moduleBase.GetArchVariantProperties(ctx, moduleBase.variableProperties) {
750 for config, props := range configToProps {
751 variableValues := reflect.ValueOf(props).Elem().FieldByName(productVariablesProperty)
752 productConfigProperties.AddProductConfigProperties(variableValues, config)
753 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000754 }
Cole Fausted940002023-08-15 11:59:24 -0700755 } else {
756 variableValues := reflect.ValueOf(moduleBase.variableProperties).Elem().FieldByName(productVariablesProperty)
757 productConfigProperties.AddProductConfigProperties(variableValues, "")
Jingwen Chena47f28d2021-11-02 16:43:57 +0000758 }
Liz Kammera060c452021-03-24 10:14:47 -0400759 }
760
Jingwen Chena47f28d2021-11-02 16:43:57 +0000761 if m, ok := module.(Bazelable); ok && m.namespacedVariableProps() != nil {
Jingwen Chen84817de2021-11-17 10:57:35 +0000762 for namespace, namespacedVariableProps := range m.namespacedVariableProps() {
763 for _, namespacedVariableProp := range namespacedVariableProps {
Cole Faust150f9a52023-04-26 10:52:24 -0700764 variableValues := reflect.ValueOf(namespacedVariableProp).Elem().FieldByName(soongconfig.SoongConfigProperty)
Liz Kammer9e2a5a72023-09-19 08:41:14 -0400765 err := productConfigProperties.AddSoongConfigProperties(namespace, variableValues)
766 if err != nil {
767 errs = append(errs, err)
768 }
Jingwen Chen84817de2021-11-17 10:57:35 +0000769 }
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -0400770 }
Liz Kammere3e4a5f2021-05-10 11:39:53 -0400771 }
772
Liz Kammer9e2a5a72023-09-19 08:41:14 -0400773 return productConfigProperties, errs
Liz Kammere3e4a5f2021-05-10 11:39:53 -0400774}
775
Jingwen Chena47f28d2021-11-02 16:43:57 +0000776func (p *ProductConfigProperties) AddProductConfigProperty(
Cole Faust150f9a52023-04-26 10:52:24 -0700777 propertyName, productVariableName, arch string, propertyValue interface{}) {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000778
Jingwen Chen25825ca2021-11-15 12:28:43 +0000779 productConfigProp := ProductConfigProperty{
Cole Faust150f9a52023-04-26 10:52:24 -0700780 name: productVariableName, // e.g. size, feature1, feature2, FEATURE3, board
781 arch: arch, // e.g. "", x86, arm64
Jingwen Chena47f28d2021-11-02 16:43:57 +0000782 }
Jingwen Chen25825ca2021-11-15 12:28:43 +0000783
Cole Faust150f9a52023-04-26 10:52:24 -0700784 p.AddEitherProperty(propertyName, productConfigProp, propertyValue)
785}
786
787func (p *ProductConfigProperties) AddSoongConfigProperty(
788 propertyName, namespace, variableName, value, os string, propertyValue interface{}) {
789
790 soongConfigProp := SoongConfigProperty{
791 namespace: namespace,
792 name: variableName, // e.g. size, feature1, feature2, FEATURE3, board
793 value: value,
794 os: os, // e.g. android, linux_x86
795 }
796
797 p.AddEitherProperty(propertyName, soongConfigProp, propertyValue)
798}
799
800func (p *ProductConfigProperties) AddEitherProperty(
801 propertyName string, key ProductConfigOrSoongConfigProperty, propertyValue interface{}) {
802 if (*p)[propertyName] == nil {
803 (*p)[propertyName] = make(map[ProductConfigOrSoongConfigProperty]interface{})
804 }
805
806 if existing, ok := (*p)[propertyName][key]; ok {
Jingwen Chen84817de2021-11-17 10:57:35 +0000807 switch dst := existing.(type) {
808 case []string:
Cole Faust150f9a52023-04-26 10:52:24 -0700809 src, ok := propertyValue.([]string)
810 if !ok {
811 panic("Conflicting types")
Jingwen Chen84817de2021-11-17 10:57:35 +0000812 }
Cole Faust150f9a52023-04-26 10:52:24 -0700813 dst = append(dst, src...)
814 (*p)[propertyName][key] = dst
Jingwen Chen84817de2021-11-17 10:57:35 +0000815 default:
Spandan Das7b26e0f2023-07-28 01:31:15 +0000816 if existing != propertyValue {
817 panic(fmt.Errorf("TODO: handle merging value %#v", existing))
818 }
Jingwen Chen84817de2021-11-17 10:57:35 +0000819 }
820 } else {
Cole Faust150f9a52023-04-26 10:52:24 -0700821 (*p)[propertyName][key] = propertyValue
Jingwen Chen84817de2021-11-17 10:57:35 +0000822 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000823}
824
825var (
826 conditionsDefaultField string = proptools.FieldNameForProperty(bazel.ConditionsDefaultConfigKey)
827)
828
829// maybeExtractConfigVarProp attempts to read this value as a config var struct
830// wrapped by interfaces and ptrs. If it's not the right type, the second return
831// value is false.
832func maybeExtractConfigVarProp(v reflect.Value) (reflect.Value, bool) {
833 if v.Kind() == reflect.Interface {
834 // The conditions_default value can be either
835 // 1) an ptr to an interface of a struct (bool config variables and product variables)
836 // 2) an interface of 1) (config variables with nested structs, like string vars)
837 v = v.Elem()
838 }
839 if v.Kind() != reflect.Ptr {
840 return v, false
841 }
842 v = reflect.Indirect(v)
843 if v.Kind() == reflect.Interface {
844 // Extract the struct from the interface
845 v = v.Elem()
846 }
847
848 if !v.IsValid() {
849 return v, false
850 }
851
852 if v.Kind() != reflect.Struct {
853 return v, false
854 }
855 return v, true
856}
857
Cole Faust150f9a52023-04-26 10:52:24 -0700858func (productConfigProperties *ProductConfigProperties) AddProductConfigProperties(variableValues reflect.Value, arch string) {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000859 // Example of product_variables:
860 //
861 // product_variables: {
862 // malloc_not_svelte: {
863 // shared_libs: ["malloc_not_svelte_shared_lib"],
864 // whole_static_libs: ["malloc_not_svelte_whole_static_lib"],
865 // exclude_static_libs: [
866 // "malloc_not_svelte_static_lib_excludes",
867 // "malloc_not_svelte_whole_static_lib_excludes",
868 // ],
869 // },
870 // },
Cole Faust150f9a52023-04-26 10:52:24 -0700871
Liz Kammera060c452021-03-24 10:14:47 -0400872 for i := 0; i < variableValues.NumField(); i++ {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000873 // e.g. Platform_sdk_version, Unbundled_build, Malloc_not_svelte, etc.
874 productVariableName := variableValues.Type().Field(i).Name
875
Liz Kammera060c452021-03-24 10:14:47 -0400876 variableValue := variableValues.Field(i)
877 // Check if any properties were set for the module
878 if variableValue.IsZero() {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000879 // e.g. feature1: {}, malloc_not_svelte: {}
Liz Kammera060c452021-03-24 10:14:47 -0400880 continue
881 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000882
Liz Kammera060c452021-03-24 10:14:47 -0400883 for j := 0; j < variableValue.NumField(); j++ {
884 property := variableValue.Field(j)
Liz Kammerf3963f82022-12-21 14:47:18 -0500885 // e.g. Asflags, Cflags, Enabled, etc.
886 propertyName := variableValue.Type().Field(j).Name
Cole Faust150f9a52023-04-26 10:52:24 -0700887 if property.Kind() != reflect.Interface {
888 productConfigProperties.AddProductConfigProperty(propertyName, productVariableName, arch, property.Interface())
889 }
890 }
891 }
892
893}
894
Liz Kammer9e2a5a72023-09-19 08:41:14 -0400895func (productConfigProperties *ProductConfigProperties) AddSoongConfigProperties(namespace string, soongConfigVariablesStruct reflect.Value) error {
Cole Faust150f9a52023-04-26 10:52:24 -0700896 //
897 // Example of soong_config_variables:
898 //
899 // soong_config_variables: {
900 // feature1: {
901 // conditions_default: {
902 // ...
903 // },
904 // cflags: ...
905 // },
906 // feature2: {
907 // cflags: ...
908 // conditions_default: {
909 // ...
910 // },
911 // },
912 // board: {
913 // soc_a: {
914 // ...
915 // },
916 // soc_b: {
917 // ...
918 // },
919 // soc_c: {},
920 // conditions_default: {
921 // ...
922 // },
923 // },
924 // }
925 for i := 0; i < soongConfigVariablesStruct.NumField(); i++ {
926 // e.g. feature1, feature2, board
927 variableName := soongConfigVariablesStruct.Type().Field(i).Name
928 variableStruct := soongConfigVariablesStruct.Field(i)
929 // Check if any properties were set for the module
930 if variableStruct.IsZero() {
931 // e.g. feature1: {}
932 continue
933 }
934
935 // Unlike product variables, config variables require a few more
936 // indirections to extract the struct from the reflect.Value.
937 if v, ok := maybeExtractConfigVarProp(variableStruct); ok {
938 variableStruct = v
liulvping4d11d102023-05-24 10:27:44 +0800939 } else if !v.IsValid() {
940 // Skip invalid variables which may not used, else leads to panic
941 continue
Cole Faust150f9a52023-04-26 10:52:24 -0700942 }
943
944 for j := 0; j < variableStruct.NumField(); j++ {
945 propertyOrStruct := variableStruct.Field(j)
946 // propertyOrValueName can either be:
947 // - A property, like: Asflags, Cflags, Enabled, etc.
948 // - A soong config string variable's value, like soc_a, soc_b, soc_c in the example above
949 // - "conditions_default"
950 propertyOrValueName := variableStruct.Type().Field(j).Name
Liz Kammerf3963f82022-12-21 14:47:18 -0500951
Liz Kammera060c452021-03-24 10:14:47 -0400952 // If the property wasn't set, no need to pass it along
Cole Faust150f9a52023-04-26 10:52:24 -0700953 if propertyOrStruct.IsZero() {
Liz Kammera060c452021-03-24 10:14:47 -0400954 continue
955 }
956
Cole Faust150f9a52023-04-26 10:52:24 -0700957 if v, ok := maybeExtractConfigVarProp(propertyOrStruct); ok {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000958 // The field is a struct, which is used by:
959 // 1) soong_config_string_variables
960 //
961 // soc_a: {
962 // cflags: ...,
963 // }
964 //
965 // soc_b: {
966 // cflags: ...,
967 // }
968 //
969 // 2) conditions_default structs for all soong config variable types.
970 //
971 // conditions_default: {
972 // cflags: ...,
973 // static_libs: ...
974 // }
Cole Faust150f9a52023-04-26 10:52:24 -0700975 //
976 // This means that propertyOrValueName is either conditions_default, or a soong
977 // config string variable's value.
Jingwen Chena47f28d2021-11-02 16:43:57 +0000978 field := v
Liz Kammerf3963f82022-12-21 14:47:18 -0500979 // Iterate over fields of this struct prop.
Jingwen Chena47f28d2021-11-02 16:43:57 +0000980 for k := 0; k < field.NumField(); k++ {
Liz Kammerf3963f82022-12-21 14:47:18 -0500981 // For product variables, zero values are irrelevant; however, for soong config variables,
982 // empty values are relevant because there can also be a conditions default which is not
983 // applied for empty variables.
984 if field.Field(k).IsZero() && namespace == "" {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000985 continue
986 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000987
Cole Faust150f9a52023-04-26 10:52:24 -0700988 propertyName := field.Type().Field(k).Name
989 if propertyName == "Target" {
990 productConfigProperties.AddSoongConfigPropertiesFromTargetStruct(namespace, variableName, proptools.PropertyNameForField(propertyOrValueName), field.Field(k))
991 } else if propertyName == "Arch" || propertyName == "Multilib" {
Liz Kammer9e2a5a72023-09-19 08:41:14 -0400992 return fmt.Errorf("Arch/Multilib are not currently supported in soong config variable structs")
Cole Faust150f9a52023-04-26 10:52:24 -0700993 } else {
994 productConfigProperties.AddSoongConfigProperty(propertyName, namespace, variableName, proptools.PropertyNameForField(propertyOrValueName), "", field.Field(k).Interface())
995 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000996 }
Cole Faust150f9a52023-04-26 10:52:24 -0700997 } else if propertyOrStruct.Kind() != reflect.Interface {
Jingwen Chen58ff6802021-11-17 12:14:41 +0000998 // If not an interface, then this is not a conditions_default or
Cole Faust150f9a52023-04-26 10:52:24 -0700999 // a struct prop. That is, this is a bool/value config variable.
1000 if propertyOrValueName == "Target" {
1001 productConfigProperties.AddSoongConfigPropertiesFromTargetStruct(namespace, variableName, "", propertyOrStruct)
1002 } else if propertyOrValueName == "Arch" || propertyOrValueName == "Multilib" {
Liz Kammer9e2a5a72023-09-19 08:41:14 -04001003 return fmt.Errorf("Arch/Multilib are not currently supported in soong config variable structs")
Cole Faust150f9a52023-04-26 10:52:24 -07001004 } else {
1005 productConfigProperties.AddSoongConfigProperty(propertyOrValueName, namespace, variableName, "", "", propertyOrStruct.Interface())
1006 }
Liz Kammer47535c52021-06-02 16:02:22 -04001007 }
Liz Kammera060c452021-03-24 10:14:47 -04001008 }
1009 }
Liz Kammer9e2a5a72023-09-19 08:41:14 -04001010 return nil
Liz Kammera060c452021-03-24 10:14:47 -04001011}
1012
Cole Faust150f9a52023-04-26 10:52:24 -07001013func (productConfigProperties *ProductConfigProperties) AddSoongConfigPropertiesFromTargetStruct(namespace, soongConfigVariableName string, soongConfigVariableValue string, targetStruct reflect.Value) {
1014 // targetStruct will be a struct with fields like "android", "host", "arm", "x86",
1015 // "android_arm", etc. The values of each of those fields will be a regular property struct.
1016 for i := 0; i < targetStruct.NumField(); i++ {
1017 targetFieldName := targetStruct.Type().Field(i).Name
1018 archOrOsSpecificStruct := targetStruct.Field(i)
1019 for j := 0; j < archOrOsSpecificStruct.NumField(); j++ {
1020 property := archOrOsSpecificStruct.Field(j)
1021 // e.g. Asflags, Cflags, Enabled, etc.
1022 propertyName := archOrOsSpecificStruct.Type().Field(j).Name
Jingwen Chen84817de2021-11-17 10:57:35 +00001023
Cole Faust150f9a52023-04-26 10:52:24 -07001024 if targetFieldName == "Android" {
1025 productConfigProperties.AddSoongConfigProperty(propertyName, namespace, soongConfigVariableName, soongConfigVariableValue, "android", property.Interface())
1026 } else if targetFieldName == "Host" {
1027 for _, os := range osTypeList {
1028 if os.Class == Host {
1029 productConfigProperties.AddSoongConfigProperty(propertyName, namespace, soongConfigVariableName, soongConfigVariableValue, os.Name, property.Interface())
1030 }
1031 }
Spandan Das474d43b2023-07-27 23:01:06 +00001032 } else if !archOrOsSpecificStruct.IsZero() {
Cole Faust150f9a52023-04-26 10:52:24 -07001033 // One problem with supporting additional fields is that if multiple branches of
1034 // "target" overlap, we don't want them to be in the same select statement (aka
1035 // configuration axis). "android" and "host" are disjoint, so it's ok that we only
1036 // have 2 axes right now. (soongConfigVariables and soongConfigVariablesPlusOs)
1037 panic("TODO: support other target types in soong config variable structs: " + targetFieldName)
1038 }
1039 }
1040 }
Jingwen Chen84817de2021-11-17 10:57:35 +00001041}
1042
Colin Crosseabaedd2020-02-06 17:01:55 -08001043func VariableMutator(mctx BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -07001044 var module Module
Colin Cross7f64b6d2015-07-09 13:57:48 -07001045 var ok bool
Colin Cross635c3b02016-05-18 15:37:25 -07001046 if module, ok = mctx.Module().(Module); !ok {
Colin Cross7f64b6d2015-07-09 13:57:48 -07001047 return
1048 }
1049
1050 // TODO: depend on config variable, create variants, propagate variants up tree
1051 a := module.base()
Colin Cross18c46802019-09-24 22:19:02 -07001052
1053 if a.variableProperties == nil {
1054 return
1055 }
1056
1057 variableValues := reflect.ValueOf(a.variableProperties).Elem().FieldByName("Product_variables")
Colin Cross7f64b6d2015-07-09 13:57:48 -07001058
Colin Cross0cec3122021-01-20 11:27:32 -08001059 productVariables := reflect.ValueOf(mctx.Config().productVariables)
1060
Colin Cross7f64b6d2015-07-09 13:57:48 -07001061 for i := 0; i < variableValues.NumField(); i++ {
1062 variableValue := variableValues.Field(i)
Colin Cross485e5722015-08-27 13:28:01 -07001063 name := variableValues.Type().Field(i).Name
1064 property := "product_variables." + proptools.PropertyNameForField(name)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001065
Colin Crossa6bc19e2015-09-16 13:53:42 -07001066 // Check that the variable was set for the product
Colin Cross0cec3122021-01-20 11:27:32 -08001067 val := productVariables.FieldByName(name)
Colin Crossa6bc19e2015-09-16 13:53:42 -07001068 if !val.IsValid() || val.Kind() != reflect.Ptr || val.IsNil() {
1069 continue
Colin Cross7f64b6d2015-07-09 13:57:48 -07001070 }
Colin Crossa6bc19e2015-09-16 13:53:42 -07001071
1072 val = val.Elem()
1073
1074 // For bools, check that the value is true
1075 if val.Kind() == reflect.Bool && val.Bool() == false {
1076 continue
1077 }
1078
1079 // Check if any properties were set for the module
Colin Cross6961a492020-02-06 16:57:45 -08001080 if variableValue.IsZero() {
Colin Crossa6bc19e2015-09-16 13:53:42 -07001081 continue
1082 }
Colin Crossa6bc19e2015-09-16 13:53:42 -07001083 a.setVariableProperties(mctx, property, variableValue, val.Interface())
Colin Cross7f64b6d2015-07-09 13:57:48 -07001084 }
1085}
1086
Colin Cross4157e882019-06-06 16:57:04 -07001087func (m *ModuleBase) setVariableProperties(ctx BottomUpMutatorContext,
Colin Cross7f64b6d2015-07-09 13:57:48 -07001088 prefix string, productVariablePropertyValue reflect.Value, variableValue interface{}) {
1089
Colin Cross7e0eaf12017-05-05 16:16:24 -07001090 printfIntoProperties(ctx, prefix, productVariablePropertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001091
Usta851a3272022-01-05 23:42:33 -05001092 err := proptools.AppendMatchingProperties(m.GetProperties(),
Colin Cross06a931b2015-10-28 17:23:31 -07001093 productVariablePropertyValue.Addr().Interface(), nil)
1094 if err != nil {
1095 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1096 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1097 } else {
1098 panic(err)
1099 }
1100 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001101}
1102
Colin Cross7e0eaf12017-05-05 16:16:24 -07001103func printfIntoPropertiesError(ctx BottomUpMutatorContext, prefix string,
1104 productVariablePropertyValue reflect.Value, i int, err error) {
1105
1106 field := productVariablePropertyValue.Type().Field(i).Name
1107 property := prefix + "." + proptools.PropertyNameForField(field)
1108 ctx.PropertyErrorf(property, "%s", err)
1109}
1110
1111func printfIntoProperties(ctx BottomUpMutatorContext, prefix string,
1112 productVariablePropertyValue reflect.Value, variableValue interface{}) {
1113
Colin Cross7f64b6d2015-07-09 13:57:48 -07001114 for i := 0; i < productVariablePropertyValue.NumField(); i++ {
1115 propertyValue := productVariablePropertyValue.Field(i)
Colin Crossdd0dbe62015-12-02 15:24:38 -08001116 kind := propertyValue.Kind()
1117 if kind == reflect.Ptr {
1118 if propertyValue.IsNil() {
1119 continue
1120 }
1121 propertyValue = propertyValue.Elem()
1122 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001123 switch propertyValue.Kind() {
1124 case reflect.String:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001125 err := printfIntoProperty(propertyValue, variableValue)
1126 if err != nil {
1127 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
1128 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001129 case reflect.Slice:
1130 for j := 0; j < propertyValue.Len(); j++ {
Colin Cross7e0eaf12017-05-05 16:16:24 -07001131 err := printfIntoProperty(propertyValue.Index(j), variableValue)
1132 if err != nil {
1133 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
1134 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001135 }
Colin Crossdd0dbe62015-12-02 15:24:38 -08001136 case reflect.Bool:
1137 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -07001138 case reflect.Struct:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001139 printfIntoProperties(ctx, prefix, propertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001140 default:
1141 panic(fmt.Errorf("unsupported field kind %q", propertyValue.Kind()))
1142 }
1143 }
1144}
1145
Colin Cross7e0eaf12017-05-05 16:16:24 -07001146func printfIntoProperty(propertyValue reflect.Value, variableValue interface{}) error {
Colin Cross7f64b6d2015-07-09 13:57:48 -07001147 s := propertyValue.String()
Colin Cross7e0eaf12017-05-05 16:16:24 -07001148
1149 count := strings.Count(s, "%")
1150 if count == 0 {
1151 return nil
1152 }
1153
1154 if count > 1 {
1155 return fmt.Errorf("product variable properties only support a single '%%'")
1156 }
1157
Colin Cross7f64b6d2015-07-09 13:57:48 -07001158 if strings.Contains(s, "%d") {
1159 switch v := variableValue.(type) {
1160 case int:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001161 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -07001162 case bool:
1163 if v {
Colin Cross7e0eaf12017-05-05 16:16:24 -07001164 variableValue = 1
1165 } else {
1166 variableValue = 0
Colin Cross7f64b6d2015-07-09 13:57:48 -07001167 }
1168 default:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001169 return fmt.Errorf("unsupported type %T for %%d", variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001170 }
Colin Cross7e0eaf12017-05-05 16:16:24 -07001171 } else if strings.Contains(s, "%s") {
1172 switch variableValue.(type) {
1173 case string:
1174 // Nothing
1175 default:
1176 return fmt.Errorf("unsupported type %T for %%s", variableValue)
1177 }
1178 } else {
1179 return fmt.Errorf("unsupported %% in product variable property")
Colin Cross7f64b6d2015-07-09 13:57:48 -07001180 }
Colin Cross7e0eaf12017-05-05 16:16:24 -07001181
1182 propertyValue.Set(reflect.ValueOf(fmt.Sprintf(s, variableValue)))
1183
1184 return nil
Colin Cross7f64b6d2015-07-09 13:57:48 -07001185}
Colin Cross18c46802019-09-24 22:19:02 -07001186
1187var variablePropTypeMap OncePer
1188
1189// sliceToTypeArray takes a slice of property structs and returns a reflection created array containing the
1190// reflect.Types of each property struct. The result can be used as a key in a map.
1191func sliceToTypeArray(s []interface{}) interface{} {
1192 // Create an array using reflection whose length is the length of the input slice
1193 ret := reflect.New(reflect.ArrayOf(len(s), reflect.TypeOf(reflect.TypeOf(0)))).Elem()
1194 for i, e := range s {
1195 ret.Index(i).Set(reflect.ValueOf(reflect.TypeOf(e)))
1196 }
1197 return ret.Interface()
1198}
1199
Colin Crosseabaedd2020-02-06 17:01:55 -08001200func initProductVariableModule(m Module) {
1201 base := m.base()
1202
1203 // Allow tests to override the default product variables
1204 if base.variableProperties == nil {
1205 base.variableProperties = defaultProductVariables
1206 }
1207 // Filter the product variables properties to the ones that exist on this module
1208 base.variableProperties = createVariableProperties(m.GetProperties(), base.variableProperties)
1209 if base.variableProperties != nil {
1210 m.AddProperties(base.variableProperties)
1211 }
1212}
1213
Colin Cross18c46802019-09-24 22:19:02 -07001214// createVariableProperties takes the list of property structs for a module and returns a property struct that
1215// contains the product variable properties that exist in the property structs, or nil if there are none. It
1216// caches the result.
1217func createVariableProperties(moduleTypeProps []interface{}, productVariables interface{}) interface{} {
1218 // Convert the moduleTypeProps to an array of reflect.Types that can be used as a key in the OncePer.
1219 key := sliceToTypeArray(moduleTypeProps)
1220
1221 // Use the variablePropTypeMap OncePer to cache the result for each set of property struct types.
1222 typ, _ := variablePropTypeMap.Once(NewCustomOnceKey(key), func() interface{} {
1223 // Compute the filtered property struct type.
1224 return createVariablePropertiesType(moduleTypeProps, productVariables)
1225 }).(reflect.Type)
1226
1227 if typ == nil {
1228 return nil
1229 }
1230
1231 // Create a new pointer to a filtered property struct.
1232 return reflect.New(typ).Interface()
1233}
1234
1235// createVariablePropertiesType creates a new type that contains only the product variable properties that exist in
1236// a list of property structs.
1237func createVariablePropertiesType(moduleTypeProps []interface{}, productVariables interface{}) reflect.Type {
1238 typ, _ := proptools.FilterPropertyStruct(reflect.TypeOf(productVariables),
1239 func(field reflect.StructField, prefix string) (bool, reflect.StructField) {
1240 // Filter function, returns true if the field should be in the resulting struct
1241 if prefix == "" {
1242 // Keep the top level Product_variables field
1243 return true, field
1244 }
1245 _, rest := splitPrefix(prefix)
1246 if rest == "" {
1247 // Keep the 2nd level field (i.e. Product_variables.Eng)
1248 return true, field
1249 }
1250
1251 // Strip off the first 2 levels of the prefix
1252 _, prefix = splitPrefix(rest)
1253
1254 for _, p := range moduleTypeProps {
1255 if fieldExistsByNameRecursive(reflect.TypeOf(p).Elem(), prefix, field.Name) {
1256 // Keep any fields that exist in one of the property structs
1257 return true, field
1258 }
1259 }
1260
1261 return false, field
1262 })
1263 return typ
1264}
1265
1266func splitPrefix(prefix string) (first, rest string) {
1267 index := strings.IndexByte(prefix, '.')
1268 if index == -1 {
1269 return prefix, ""
1270 }
1271 return prefix[:index], prefix[index+1:]
1272}
1273
1274func fieldExistsByNameRecursive(t reflect.Type, prefix, name string) bool {
1275 if t.Kind() != reflect.Struct {
1276 panic(fmt.Errorf("fieldExistsByNameRecursive can only be called on a reflect.Struct"))
1277 }
1278
1279 if prefix != "" {
1280 split := strings.SplitN(prefix, ".", 2)
1281 firstPrefix := split[0]
1282 rest := ""
1283 if len(split) > 1 {
1284 rest = split[1]
1285 }
1286 f, exists := t.FieldByName(firstPrefix)
1287 if !exists {
1288 return false
1289 }
1290 ft := f.Type
1291 if ft.Kind() == reflect.Ptr {
1292 ft = ft.Elem()
1293 }
1294 if ft.Kind() != reflect.Struct {
1295 panic(fmt.Errorf("field %q in %q is not a struct", firstPrefix, t))
1296 }
1297 return fieldExistsByNameRecursive(ft, rest, name)
1298 } else {
1299 _, exists := t.FieldByName(name)
1300 return exists
1301 }
1302}