blob: 59ae919373fed430913259d482dfaaef7381f34a [file] [log] [blame]
Colin Cross7f64b6d2015-07-09 13:57:48 -07001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
Colin Cross635c3b02016-05-18 15:37:25 -070015package android
Colin Cross7f64b6d2015-07-09 13:57:48 -070016
17import (
18 "fmt"
19 "reflect"
Dan Willemsen490fd492015-11-24 17:53:15 -080020 "runtime"
Colin Cross7f64b6d2015-07-09 13:57:48 -070021 "strings"
22
Cole Faust701ca252021-11-23 19:02:08 -080023 "android/soong/android/soongconfig"
24 "android/soong/bazel"
25
Colin Cross7f64b6d2015-07-09 13:57:48 -070026 "github.com/google/blueprint/proptools"
27)
28
29func init() {
Paul Duffine7a055c2021-03-07 15:46:33 +000030 registerVariableBuildComponents(InitRegistrationContext)
31}
32
33func registerVariableBuildComponents(ctx RegistrationContext) {
34 ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
Colin Crosseabaedd2020-02-06 17:01:55 -080035 ctx.BottomUp("variable", VariableMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070036 })
Colin Cross7f64b6d2015-07-09 13:57:48 -070037}
38
Paul Duffine7a055c2021-03-07 15:46:33 +000039var PrepareForTestWithVariables = FixtureRegisterWithContext(registerVariableBuildComponents)
40
Colin Cross7f64b6d2015-07-09 13:57:48 -070041type variableProperties struct {
42 Product_variables struct {
Dan Willemsen47cf66b2015-09-16 16:48:54 -070043 Platform_sdk_version struct {
44 Asflags []string
Colin Crossceeff0f2017-05-08 13:43:00 -070045 Cflags []string
Dan Willemsen9fe14102021-07-13 21:52:04 -070046 Cmd *string
Dan Willemsen47cf66b2015-09-16 16:48:54 -070047 }
Colin Cross83163192015-12-01 16:31:16 -080048
Yuntao Xu402e9b02021-08-09 15:44:44 -070049 Platform_sdk_version_or_codename struct {
50 Java_resource_dirs []string
51 }
52
Anton Hanssonb021bf82021-08-27 17:35:40 +010053 Platform_sdk_extension_version struct {
54 Cmd *string
55 }
56
Dan Willemsen9fe14102021-07-13 21:52:04 -070057 Platform_version_name struct {
58 Base_dir *string
59 }
60
Colin Cross83163192015-12-01 16:31:16 -080061 // unbundled_build is a catch-all property to annotate modules that don't build in one or
62 // more unbundled branches, usually due to dependencies missing from the manifest.
63 Unbundled_build struct {
64 Enabled *bool `android:"arch_variant"`
65 } `android:"arch_variant"`
Dan Willemsen496e3952016-01-05 14:27:55 -080066
Dan Willemsen97cae012016-03-01 14:08:42 -080067 Malloc_not_svelte struct {
Christopher Ferrisc71193a2019-12-16 09:55:10 -080068 Cflags []string `android:"arch_variant"`
69 Shared_libs []string `android:"arch_variant"`
70 Whole_static_libs []string `android:"arch_variant"`
71 Exclude_static_libs []string `android:"arch_variant"`
Christopher Ferrisdea66172021-09-24 00:07:53 -070072 Srcs []string `android:"arch_variant"`
73 Header_libs []string `android:"arch_variant"`
Sasha Smundak61ebf8d2018-08-31 16:56:05 -070074 } `android:"arch_variant"`
Evgenii Stepanov8391efa2016-05-12 18:04:18 -070075
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -070076 Malloc_zero_contents struct {
77 Cflags []string `android:"arch_variant"`
78 } `android:"arch_variant"`
79
80 Malloc_pattern_fill_contents struct {
81 Cflags []string `android:"arch_variant"`
82 } `android:"arch_variant"`
83
Evgenii Stepanov8391efa2016-05-12 18:04:18 -070084 Safestack struct {
85 Cflags []string `android:"arch_variant"`
86 } `android:"arch_variant"`
Dan Willemsena6f7d152016-07-12 14:57:40 -070087
Dan Willemsen1be35382016-07-25 17:42:18 -070088 Binder32bit struct {
89 Cflags []string
90 }
Dan Willemsenfcebcd52016-09-22 14:49:10 -070091
Colin Cross95436422017-05-04 13:57:05 -070092 Override_rs_driver struct {
93 Cflags []string
94 }
95
Steven Morelandc2b9f062017-12-13 14:06:20 -080096 // treble_linker_namespaces is true when the system/vendor linker namespace separation is
97 // enabled.
98 Treble_linker_namespaces struct {
99 Cflags []string
100 }
Steven Morelandc2b9f062017-12-13 14:06:20 -0800101 // enforce_vintf_manifest is true when a device is required to have a vintf manifest.
102 Enforce_vintf_manifest struct {
103 Cflags []string
104 }
105
Colin Cross6bc59ef2016-12-08 09:46:35 -0800106 // debuggable is true for eng and userdebug builds, and can be used to turn on additional
107 // debugging features that don't significantly impact runtime behavior. userdebug builds
108 // are used for dogfooding and performance testing, and should be as similar to user builds
109 // as possible.
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700110 Debuggable struct {
Sasha Smundakb6d23052019-04-01 18:37:36 -0700111 Cflags []string
112 Cppflags []string
113 Init_rc []string
114 Required []string
115 Host_required []string
116 Target_required []string
Philip Cuadra328e0bf2020-10-19 22:01:29 -0700117 Strip struct {
118 All *bool
119 Keep_symbols *bool
120 Keep_symbols_and_debug_frame *bool
121 }
Yifan Hong8f323ae2021-06-23 20:01:13 -0700122 Static_libs []string
123 Whole_static_libs []string
124 Shared_libs []string
Jiyong Park16e77a92021-08-30 18:43:19 +0900125
126 Cmdline []string
Inseob Kimf5ed3002022-01-07 19:17:29 +0900127
Jay Aliomer2599d1d2021-09-23 15:49:54 -0400128 Srcs []string
129 Exclude_srcs []string
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700130 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800131
Usta Shresthac725f472022-01-11 02:44:21 -0500132 // eng is true for -eng builds, and can be used to turn on additional heavyweight debugging
Colin Cross6bc59ef2016-12-08 09:46:35 -0800133 // features.
134 Eng struct {
135 Cflags []string
136 Cppflags []string
John Reck1d2b7ee2018-07-11 11:01:59 -0700137 Lto struct {
138 Never *bool
139 }
Colin Cross3273cc22018-10-26 23:58:42 -0700140 Sanitize struct {
141 Address *bool
142 }
Felka Changf13642e2019-06-21 20:58:27 +0800143 Optimize struct {
144 Enabled *bool
145 }
Colin Cross6bc59ef2016-12-08 09:46:35 -0800146 }
Colin Crossb2123aa2017-05-05 13:37:11 -0700147
148 Pdk struct {
Colin Cross99967a72017-10-17 13:55:02 -0700149 Enabled *bool `android:"arch_variant"`
150 } `android:"arch_variant"`
Dmitry Shmidtdba54192017-08-23 14:58:37 -0700151
152 Uml struct {
153 Cppflags []string
154 }
Risanea004dd2017-11-27 18:14:46 +0900155
156 Arc struct {
Satoshi Niwa54f48262020-12-18 09:53:26 +0900157 Cflags []string `android:"arch_variant"`
158 Exclude_srcs []string `android:"arch_variant"`
Jasmine Chenacace422021-03-05 00:56:40 +0800159 Header_libs []string `android:"arch_variant"`
Satoshi Niwa54f48262020-12-18 09:53:26 +0900160 Include_dirs []string `android:"arch_variant"`
161 Shared_libs []string `android:"arch_variant"`
162 Static_libs []string `android:"arch_variant"`
163 Srcs []string `android:"arch_variant"`
164 Whole_static_libs []string `android:"arch_variant"`
165 } `android:"arch_variant"`
Roland Levillain2879d412019-08-13 15:00:18 +0100166
167 Flatten_apex struct {
168 Enabled *bool
169 }
Peter Collingbournec66baf72019-10-29 11:00:15 -0700170
Colin Crossd9a121b2020-01-27 13:26:42 -0800171 Native_coverage struct {
Colin Cross2b10ba02020-02-05 16:23:21 -0800172 Src *string `android:"arch_variant"`
Colin Crossd9a121b2020-01-27 13:26:42 -0800173 Srcs []string `android:"arch_variant"`
174 Exclude_srcs []string `android:"arch_variant"`
175 } `android:"arch_variant"`
Colin Cross83163192015-12-01 16:31:16 -0800176 } `android:"arch_variant"`
Colin Cross7f64b6d2015-07-09 13:57:48 -0700177}
178
Colin Cross6961a492020-02-06 16:57:45 -0800179var defaultProductVariables interface{} = variableProperties{}
Colin Cross7f64b6d2015-07-09 13:57:48 -0700180
Colin Cross485e5722015-08-27 13:28:01 -0700181type productVariables struct {
Dan Willemsen174978c2016-05-11 00:27:49 -0700182 // Suffix to add to generated Makefiles
183 Make_suffix *string `json:",omitempty"`
184
Colin Cross2a2e0db2020-02-21 16:55:46 -0800185 BuildId *string `json:",omitempty"`
186 BuildNumberFile *string `json:",omitempty"`
Nan Zhang581fd212018-01-10 16:06:12 -0800187
Colin Cross092c9da2019-04-02 22:56:43 -0700188 Platform_version_name *string `json:",omitempty"`
189 Platform_sdk_version *int `json:",omitempty"`
190 Platform_sdk_codename *string `json:",omitempty"`
Yuntao Xu402e9b02021-08-09 15:44:44 -0700191 Platform_sdk_version_or_codename *string `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700192 Platform_sdk_final *bool `json:",omitempty"`
Anton Hanssonb021bf82021-08-27 17:35:40 +0100193 Platform_sdk_extension_version *int `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700194 Platform_version_active_codenames []string `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700195 Platform_vndk_version *string `json:",omitempty"`
196 Platform_systemsdk_versions []string `json:",omitempty"`
197 Platform_security_patch *string `json:",omitempty"`
198 Platform_preview_sdk_version *string `json:",omitempty"`
199 Platform_min_supported_target_sdk_version *string `json:",omitempty"`
200 Platform_base_os *string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700201
Jeongik Cha219141c2020-08-06 23:00:37 +0900202 DeviceName *string `json:",omitempty"`
203 DeviceArch *string `json:",omitempty"`
204 DeviceArchVariant *string `json:",omitempty"`
205 DeviceCpuVariant *string `json:",omitempty"`
206 DeviceAbi []string `json:",omitempty"`
207 DeviceVndkVersion *string `json:",omitempty"`
208 DeviceCurrentApiLevelForVendorModules *string `json:",omitempty"`
209 DeviceSystemSdkVersions []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700210
Jose Galmes6f843bc2020-12-11 13:36:29 -0800211 RecoverySnapshotVersion *string `json:",omitempty"`
212
Colin Crossa74ca042019-01-31 14:31:51 -0800213 DeviceSecondaryArch *string `json:",omitempty"`
214 DeviceSecondaryArchVariant *string `json:",omitempty"`
215 DeviceSecondaryCpuVariant *string `json:",omitempty"`
216 DeviceSecondaryAbi []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700217
dimitry8d6dde82019-07-11 10:23:53 +0200218 NativeBridgeArch *string `json:",omitempty"`
219 NativeBridgeArchVariant *string `json:",omitempty"`
220 NativeBridgeCpuVariant *string `json:",omitempty"`
221 NativeBridgeAbi []string `json:",omitempty"`
222 NativeBridgeRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100223
dimitry8d6dde82019-07-11 10:23:53 +0200224 NativeBridgeSecondaryArch *string `json:",omitempty"`
225 NativeBridgeSecondaryArchVariant *string `json:",omitempty"`
226 NativeBridgeSecondaryCpuVariant *string `json:",omitempty"`
227 NativeBridgeSecondaryAbi []string `json:",omitempty"`
228 NativeBridgeSecondaryRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100229
Colin Cross4225f652015-09-17 14:33:42 -0700230 HostArch *string `json:",omitempty"`
231 HostSecondaryArch *string `json:",omitempty"`
Colin Cross528d67e2021-07-23 22:23:07 +0000232 HostMusl *bool `json:",omitempty"`
Dan Willemsen490fd492015-11-24 17:53:15 -0800233
234 CrossHost *string `json:",omitempty"`
235 CrossHostArch *string `json:",omitempty"`
236 CrossHostSecondaryArch *string `json:",omitempty"`
Colin Cross83163192015-12-01 16:31:16 -0800237
Jeongik Chacee5ba92021-02-19 12:11:51 +0900238 DeviceResourceOverlays []string `json:",omitempty"`
239 ProductResourceOverlays []string `json:",omitempty"`
240 EnforceRROTargets []string `json:",omitempty"`
Colin Crossa74ca042019-01-31 14:31:51 -0800241 EnforceRROExcludedOverlays []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700242
Colin Crossa74ca042019-01-31 14:31:51 -0800243 AAPTCharacteristics *string `json:",omitempty"`
244 AAPTConfig []string `json:",omitempty"`
245 AAPTPreferredConfig *string `json:",omitempty"`
246 AAPTPrebuiltDPI []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700247
Colin Cross61ae0b72017-12-01 17:16:02 -0800248 DefaultAppCertificate *string `json:",omitempty"`
249
Colin Crossface4e42017-10-30 17:32:15 -0700250 AppsDefaultVersionName *string `json:",omitempty"`
251
Cole Faust701ca252021-11-23 19:02:08 -0800252 Allow_missing_dependencies *bool `json:",omitempty"`
253 Unbundled_build *bool `json:",omitempty"`
254 Unbundled_build_apps []string `json:",omitempty"`
255 Unbundled_build_image *bool `json:",omitempty"`
256 Always_use_prebuilt_sdks *bool `json:",omitempty"`
257 Skip_boot_jars_check *bool `json:",omitempty"`
258 Malloc_not_svelte *bool `json:",omitempty"`
259 Malloc_zero_contents *bool `json:",omitempty"`
260 Malloc_pattern_fill_contents *bool `json:",omitempty"`
261 Safestack *bool `json:",omitempty"`
262 HostStaticBinaries *bool `json:",omitempty"`
263 Binder32bit *bool `json:",omitempty"`
264 UseGoma *bool `json:",omitempty"`
265 UseRBE *bool `json:",omitempty"`
266 UseRBEJAVAC *bool `json:",omitempty"`
267 UseRBER8 *bool `json:",omitempty"`
268 UseRBED8 *bool `json:",omitempty"`
269 Debuggable *bool `json:",omitempty"`
270 Eng *bool `json:",omitempty"`
271 Treble_linker_namespaces *bool `json:",omitempty"`
272 Enforce_vintf_manifest *bool `json:",omitempty"`
273 Uml *bool `json:",omitempty"`
274 Arc *bool `json:",omitempty"`
275 MinimizeJavaDebugInfo *bool `json:",omitempty"`
Colin Cross16b23492016-01-06 14:41:07 -0800276
Logan Chien4fcea3d2018-11-20 11:59:08 +0800277 Check_elf_files *bool `json:",omitempty"`
278
Colin Cross5a0dcd52018-10-05 14:20:06 -0700279 UncompressPrivAppDex *bool `json:",omitempty"`
280 ModulesLoadedByPrivilegedModules []string `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800281
satayevd604b212021-07-21 14:23:52 +0100282 BootJars ConfiguredJarList `json:",omitempty"`
283 ApexBootJars ConfiguredJarList `json:",omitempty"`
Vladimir Markoe8b00d62018-12-21 15:54:16 +0000284
Colin Crossa74ca042019-01-31 14:31:51 -0800285 IntegerOverflowExcludePaths []string `json:",omitempty"`
Ivan Lozano5f595532017-07-13 14:46:05 -0700286
Colin Crossa74ca042019-01-31 14:31:51 -0800287 EnableCFI *bool `json:",omitempty"`
288 CFIExcludePaths []string `json:",omitempty"`
289 CFIIncludePaths []string `json:",omitempty"`
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -0700290
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -0800291 DisableScudo *bool `json:",omitempty"`
292
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -0800293 MemtagHeapExcludePaths []string `json:",omitempty"`
294 MemtagHeapAsyncIncludePaths []string `json:",omitempty"`
295 MemtagHeapSyncIncludePaths []string `json:",omitempty"`
296
Justin Yund5f6c822019-06-25 16:47:17 +0900297 VendorPath *string `json:",omitempty"`
298 OdmPath *string `json:",omitempty"`
299 ProductPath *string `json:",omitempty"`
300 SystemExtPath *string `json:",omitempty"`
Dan Willemsen4353bc42016-12-05 17:16:02 -0800301
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700302 ClangTidy *bool `json:",omitempty"`
303 TidyChecks *string `json:",omitempty"`
304
Roland Levillainada12702020-06-09 13:07:36 +0100305 JavaCoveragePaths []string `json:",omitempty"`
306 JavaCoverageExcludePaths []string `json:",omitempty"`
307
Colin Cross1a6acd42020-06-16 17:51:46 -0700308 GcovCoverage *bool `json:",omitempty"`
Roland Levillain4f5297b2020-06-09 12:44:06 +0100309 ClangCoverage *bool `json:",omitempty"`
310 NativeCoveragePaths []string `json:",omitempty"`
311 NativeCoverageExcludePaths []string `json:",omitempty"`
Dan Willemsen581341d2017-02-09 16:16:31 -0800312
Colin Cross1a6acd42020-06-16 17:51:46 -0700313 // Set by NewConfig
Liz Kammer09f947d2021-05-12 14:51:49 -0400314 Native_coverage *bool `json:",omitempty"`
Colin Cross1a6acd42020-06-16 17:51:46 -0700315
Colin Cross23ae82a2016-11-02 14:34:39 -0700316 SanitizeHost []string `json:",omitempty"`
317 SanitizeDevice []string `json:",omitempty"`
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700318 SanitizeDeviceDiag []string `json:",omitempty"`
Colin Cross23ae82a2016-11-02 14:34:39 -0700319 SanitizeDeviceArch []string `json:",omitempty"`
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800320
321 ArtUseReadBarrier *bool `json:",omitempty"`
Jack He8cc71432016-12-08 15:45:07 -0800322
323 BtConfigIncludeDir *string `json:",omitempty"`
Colin Cross95436422017-05-04 13:57:05 -0700324
325 Override_rs_driver *string `json:",omitempty"`
Jiyong Parkd773eb32017-07-03 13:18:12 +0900326
327 DeviceKernelHeaders []string `json:",omitempty"`
Justin Yun71549282017-11-17 12:10:28 +0900328
329 ExtraVndkVersions []string `json:",omitempty"`
Jeff Gaston088e29e2017-11-29 16:47:17 -0800330
331 NamespacesToExport []string `json:",omitempty"`
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -0800332
Yi Kongeb8efc92021-12-09 18:06:29 +0800333 AfdoAdditionalProfileDirs []string `json:",omitempty"`
334 PgoAdditionalProfileDirs []string `json:",omitempty"`
Dan Willemsen0fe78662018-03-26 12:41:18 -0700335
Inseob Kimae553032019-05-14 18:52:49 +0900336 VndkUseCoreVariant *bool `json:",omitempty"`
337 VndkSnapshotBuildArtifacts *bool `json:",omitempty"`
Vic Yangefd249e2018-11-12 20:19:56 -0800338
Inseob Kim7cf14652021-01-06 23:06:52 +0900339 DirectedVendorSnapshot bool `json:",omitempty"`
340 VendorSnapshotModules map[string]bool `json:",omitempty"`
341
Jose Galmes4c6895e2021-02-09 07:44:30 -0800342 DirectedRecoverySnapshot bool `json:",omitempty"`
343 RecoverySnapshotModules map[string]bool `json:",omitempty"`
344
Justin DeMartino383bfb32021-02-24 10:49:43 -0800345 VendorSnapshotDirsIncluded []string `json:",omitempty"`
346 VendorSnapshotDirsExcluded []string `json:",omitempty"`
347 RecoverySnapshotDirsExcluded []string `json:",omitempty"`
348 RecoverySnapshotDirsIncluded []string `json:",omitempty"`
Rob Seymour925aa092021-08-10 20:42:03 +0000349 HostFakeSnapshotEnabled bool `json:",omitempty"`
Justin DeMartino383bfb32021-02-24 10:49:43 -0800350
Inseob Kim0f46e7c2021-12-15 22:48:14 +0900351 BoardVendorSepolicyDirs []string `json:",omitempty"`
352 BoardOdmSepolicyDirs []string `json:",omitempty"`
353 BoardReqdMaskPolicy []string `json:",omitempty"`
354 BoardPlatVendorPolicy []string `json:",omitempty"`
355 BoardSystemExtPublicPrebuiltDirs []string `json:",omitempty"`
356 BoardSystemExtPrivatePrebuiltDirs []string `json:",omitempty"`
357 BoardProductPublicPrebuiltDirs []string `json:",omitempty"`
358 BoardProductPrivatePrebuiltDirs []string `json:",omitempty"`
359 SystemExtPublicSepolicyDirs []string `json:",omitempty"`
360 SystemExtPrivateSepolicyDirs []string `json:",omitempty"`
361 BoardSepolicyM4Defs []string `json:",omitempty"`
Tri Vo35a51432018-03-25 20:00:00 -0700362
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900363 BoardSepolicyVers *string `json:",omitempty"`
364 PlatformSepolicyVersion *string `json:",omitempty"`
Inseob Kima10ef272021-09-15 03:04:53 +0000365 TotSepolicyVersion *string `json:",omitempty"`
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900366
Inseob Kim1a0afcc2022-02-14 23:10:51 +0900367 SystemExtSepolicyPrebuiltApiDir *string `json:",omitempty"`
368 ProductSepolicyPrebuiltApiDir *string `json:",omitempty"`
369
Inseob Kim843f6642022-01-07 09:11:23 +0900370 PlatformSepolicyCompatVersions []string `json:",omitempty"`
371
Dan Willemsen0fe78662018-03-26 12:41:18 -0700372 VendorVars map[string]map[string]string `json:",omitempty"`
Colin Cross395f2cf2018-10-24 16:10:32 -0700373
Dan Albertd05ba002021-04-13 15:55:47 -0700374 Ndk_abis *bool `json:",omitempty"`
Jiyong Park8fd61922018-11-08 02:50:25 +0900375
Jiyong Park4da07972021-01-05 21:01:11 +0900376 Flatten_apex *bool `json:",omitempty"`
377 ForceApexSymlinkOptimization *bool `json:",omitempty"`
378 CompressedApex *bool `json:",omitempty"`
379 Aml_abis *bool `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800380
381 DexpreoptGlobalConfig *string `json:",omitempty"`
Jiyong Park7f67f482019-01-05 12:57:48 +0900382
Inseob Kim7b85eeb2021-03-23 20:52:24 +0900383 WithDexpreopt bool `json:",omitempty"`
384
Jiyong Park7f67f482019-01-05 12:57:48 +0900385 ManifestPackageNameOverrides []string `json:",omitempty"`
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800386 CertificateOverrides []string `json:",omitempty"`
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800387 PackageNameOverrides []string `json:",omitempty"`
Jeongik Chac9464142019-01-07 12:07:27 +0900388
389 EnforceSystemCertificate *bool `json:",omitempty"`
Colin Cross440e0d02020-06-11 11:32:11 -0700390 EnforceSystemCertificateAllowList []string `json:",omitempty"`
Colin Cross8faf8fc2019-01-16 15:15:52 -0800391
Colin Crossf24a22a2019-01-31 14:12:44 -0800392 ProductHiddenAPIStubs []string `json:",omitempty"`
393 ProductHiddenAPIStubsSystem []string `json:",omitempty"`
394 ProductHiddenAPIStubsTest []string `json:",omitempty"`
Dan Willemsen71c74602019-04-10 12:27:35 -0700395
Inseob Kim0866b002019-04-15 20:21:29 +0900396 ProductPublicSepolicyDirs []string `json:",omitempty"`
397 ProductPrivateSepolicyDirs []string `json:",omitempty"`
Inseob Kim0866b002019-04-15 20:21:29 +0900398
Justin Yun5f7f7e82019-11-18 19:52:14 +0900399 ProductVndkVersion *string `json:",omitempty"`
400
Dan Willemsen54879d12019-04-18 10:08:46 -0700401 TargetFSConfigGen []string `json:",omitempty"`
Colin Cross50ddcc42019-05-16 12:28:22 -0700402
403 MissingUsesLibraries []string `json:",omitempty"`
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900404
405 EnforceProductPartitionInterface *bool `json:",omitempty"`
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900406
JaeMan Parkff715562020-10-19 17:25:58 +0900407 EnforceInterPartitionJavaSdkLibrary *bool `json:",omitempty"`
408 InterPartitionJavaLibraryAllowList []string `json:",omitempty"`
409
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900410 InstallExtraFlattenedApexes *bool `json:",omitempty"`
Yifan Hong82db7352020-01-21 16:12:26 -0800411
412 BoardUsesRecoveryAsBoot *bool `json:",omitempty"`
Yifan Hong97365ee2020-07-29 09:51:57 -0700413
Yifan Hong42bef8d2020-08-05 14:36:09 -0700414 BoardKernelBinaries []string `json:",omitempty"`
415 BoardKernelModuleInterfaceVersions []string `json:",omitempty"`
Yifan Hongdd8dacc2020-10-21 15:40:17 -0700416
417 BoardMoveRecoveryResourcesToVendorBoot *bool `json:",omitempty"`
Bill Peckhambae47492021-01-08 09:34:44 -0800418
419 PrebuiltHiddenApiDir *string `json:",omitempty"`
Inseob Kim60c32f02020-12-21 22:53:05 +0900420
421 ShippingApiLevel *string `json:",omitempty"`
Inseob Kim0cac7b42021-02-03 18:16:46 +0900422
Inseob Kim67e5add192021-03-17 18:05:33 +0900423 BuildBrokenEnforceSyspropOwner bool `json:",omitempty"`
424 BuildBrokenTrebleSyspropNeverallow bool `json:",omitempty"`
Inseob Kim0cac7b42021-02-03 18:16:46 +0900425 BuildBrokenVendorPropertyNamespace bool `json:",omitempty"`
Inseob Kim67e5add192021-03-17 18:05:33 +0900426
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -0700427 BuildDebugfsRestrictionsEnabled bool `json:",omitempty"`
428
Inseob Kim67e5add192021-03-17 18:05:33 +0900429 RequiresInsecureExecmemForSwiftshader bool `json:",omitempty"`
430
431 SelinuxIgnoreNeverallows bool `json:",omitempty"`
432
433 SepolicySplit bool `json:",omitempty"`
Inseob Kima10ef272021-09-15 03:04:53 +0000434
435 SepolicyFreezeTestExtraDirs []string `json:",omitempty"`
436 SepolicyFreezeTestExtraPrebuiltDirs []string `json:",omitempty"`
Jiyong Parkd163d4d2021-10-12 16:47:43 +0900437
438 GenerateAidlNdkPlatformBackend bool `json:",omitempty"`
Colin Crossa6bc19e2015-09-16 13:53:42 -0700439}
440
441func boolPtr(v bool) *bool {
442 return &v
Colin Cross485e5722015-08-27 13:28:01 -0700443}
444
Dan Willemsen47cf66b2015-09-16 16:48:54 -0700445func intPtr(v int) *int {
446 return &v
447}
448
Colin Cross4225f652015-09-17 14:33:42 -0700449func stringPtr(v string) *string {
450 return &v
451}
452
Colin Cross27385972015-09-18 10:57:10 -0700453func (v *productVariables) SetDefaultConfig() {
454 *v = productVariables{
Colin Cross2a2e0db2020-02-21 16:55:46 -0800455 BuildNumberFile: stringPtr("build_number.txt"),
Dan Willemsenb6d171b2019-04-07 09:41:44 -0700456
Jiyong Park84d8a7e2020-09-25 13:44:51 +0900457 Platform_version_name: stringPtr("S"),
458 Platform_sdk_version: intPtr(30),
459 Platform_sdk_codename: stringPtr("S"),
Dan Willemsenb6d171b2019-04-07 09:41:44 -0700460 Platform_sdk_final: boolPtr(false),
Jiyong Park84d8a7e2020-09-25 13:44:51 +0900461 Platform_version_active_codenames: []string{"S"},
462 Platform_vndk_version: stringPtr("S"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800463
Colin Cross4225f652015-09-17 14:33:42 -0700464 HostArch: stringPtr("x86_64"),
465 HostSecondaryArch: stringPtr("x86"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800466 DeviceName: stringPtr("generic_arm64"),
Colin Cross4225f652015-09-17 14:33:42 -0700467 DeviceArch: stringPtr("arm64"),
Dan Willemsena91d1272016-03-29 22:06:05 -0700468 DeviceArchVariant: stringPtr("armv8-a"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800469 DeviceCpuVariant: stringPtr("generic"),
Colin Crossa74ca042019-01-31 14:31:51 -0800470 DeviceAbi: []string{"arm64-v8a"},
Colin Cross4225f652015-09-17 14:33:42 -0700471 DeviceSecondaryArch: stringPtr("arm"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800472 DeviceSecondaryArchVariant: stringPtr("armv8-a"),
473 DeviceSecondaryCpuVariant: stringPtr("generic"),
Colin Crossa74ca042019-01-31 14:31:51 -0800474 DeviceSecondaryAbi: []string{"armeabi-v7a", "armeabi"},
Colin Crossface4e42017-10-30 17:32:15 -0700475
Colin Crossa74ca042019-01-31 14:31:51 -0800476 AAPTConfig: []string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700477 AAPTPreferredConfig: stringPtr("xhdpi"),
478 AAPTCharacteristics: stringPtr("nosdcard"),
Colin Crossa74ca042019-01-31 14:31:51 -0800479 AAPTPrebuiltDPI: []string{"xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700480
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700481 Malloc_not_svelte: boolPtr(true),
Steven Morelandd1342012020-07-30 20:38:49 +0000482 Malloc_zero_contents: boolPtr(true),
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700483 Malloc_pattern_fill_contents: boolPtr(false),
484 Safestack: boolPtr(false),
Lukacs T. Berki720b3962021-03-17 13:34:30 +0100485
satayevd604b212021-07-21 14:23:52 +0100486 BootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
487 ApexBootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
Colin Cross485e5722015-08-27 13:28:01 -0700488 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800489
490 if runtime.GOOS == "linux" {
491 v.CrossHost = stringPtr("windows")
492 v.CrossHostArch = stringPtr("x86")
Dan Willemsen07cd0512016-02-03 23:16:33 -0800493 v.CrossHostSecondaryArch = stringPtr("x86_64")
Dan Willemsen490fd492015-11-24 17:53:15 -0800494 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700495}
496
Liz Kammera060c452021-03-24 10:14:47 -0400497// ProductConfigContext requires the access to the Module to get product config properties.
498type ProductConfigContext interface {
499 Module() Module
500}
501
502// ProductConfigProperty contains the information for a single property (may be a struct) paired
503// with the appropriate ProductConfigVariable.
504type ProductConfigProperty struct {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000505 // The name of the product variable, e.g. "safestack", "malloc_not_svelte",
506 // "board"
Jingwen Chen25825ca2021-11-15 12:28:43 +0000507 Name string
Jingwen Chena47f28d2021-11-02 16:43:57 +0000508
509 // Namespace of the variable, if this is a soong_config_module_type variable
Jingwen Chen25825ca2021-11-15 12:28:43 +0000510 // e.g. "acme", "ANDROID", "vendor_name"
511 Namespace string
Jingwen Chena47f28d2021-11-02 16:43:57 +0000512
513 // Unique configuration to identify this product config property (i.e. a
514 // primary key), as just using the product variable name is not sufficient.
515 //
516 // For product variables, this is the product variable name + optional
517 // archvariant information. e.g.
518 //
519 // product_variables: {
520 // foo: {
521 // cflags: ["-Dfoo"],
522 // },
523 // },
524 //
525 // FullConfig would be "foo".
526 //
527 // target: {
528 // android: {
529 // product_variables: {
530 // foo: {
531 // cflags: ["-Dfoo-android"],
532 // },
533 // },
534 // },
535 // },
536 //
537 // FullConfig would be "foo-android".
538 //
539 // For soong config variables, this is the namespace + product variable name
540 // + value of the variable, if applicable. The value can also be
541 // conditions_default.
542 //
543 // e.g.
544 //
545 // soong_config_variables: {
546 // feature1: {
547 // conditions_default: {
548 // cflags: ["-DDEFAULT1"],
549 // },
550 // cflags: ["-DFEATURE1"],
551 // },
552 // }
553 //
554 // where feature1 is created in the "acme" namespace, so FullConfig would be
555 // "acme__feature1" and "acme__feature1__conditions_default".
556 //
557 // e.g.
558 //
559 // soong_config_variables: {
560 // board: {
561 // soc_a: {
562 // cflags: ["-DSOC_A"],
563 // },
564 // soc_b: {
565 // cflags: ["-DSOC_B"],
566 // },
567 // soc_c: {},
568 // conditions_default: {
569 // cflags: ["-DSOC_DEFAULT"]
570 // },
571 // },
572 // }
573 //
574 // where board is created in the "acme" namespace, so FullConfig would be
575 // "acme__board__soc_a", "acme__board__soc_b", and
576 // "acme__board__conditions_default"
577 FullConfig string
Liz Kammera060c452021-03-24 10:14:47 -0400578}
579
Jingwen Chen58ff6802021-11-17 12:14:41 +0000580func (p *ProductConfigProperty) AlwaysEmit() bool {
581 return p.Namespace != ""
582}
583
Jingwen Chena47f28d2021-11-02 16:43:57 +0000584func (p *ProductConfigProperty) ConfigurationAxis() bazel.ConfigurationAxis {
585 if p.Namespace == "" {
586 return bazel.ProductVariableConfigurationAxis(p.FullConfig)
587 } else {
588 // Soong config variables can be uniquely identified by the namespace
589 // (e.g. acme, android) and the product variable name (e.g. board, size)
Jingwen Chen25825ca2021-11-15 12:28:43 +0000590 return bazel.ProductVariableConfigurationAxis(p.Namespace + "__" + p.Name)
Jingwen Chena47f28d2021-11-02 16:43:57 +0000591 }
592}
593
Jingwen Chen25825ca2021-11-15 12:28:43 +0000594// SelectKey returns the literal string that represents this variable in a BUILD
595// select statement.
596func (p *ProductConfigProperty) SelectKey() string {
597 if p.Namespace == "" {
598 return strings.ToLower(p.FullConfig)
599 }
600
601 if p.FullConfig == bazel.ConditionsDefaultConfigKey {
602 return bazel.ConditionsDefaultConfigKey
603 }
604
605 value := p.FullConfig
606 if value == p.Name {
Sam Delmerico0e33c9d2022-01-07 20:39:21 +0000607 value = ""
Jingwen Chen25825ca2021-11-15 12:28:43 +0000608 }
Sam Delmerico0e33c9d2022-01-07 20:39:21 +0000609
610 // e.g. acme__feature1, android__board__soc_a
611 selectKey := strings.ToLower(strings.Join([]string{p.Namespace, p.Name}, "__"))
612 if value != "" {
613 selectKey = strings.ToLower(strings.Join([]string{selectKey, value}, "__"))
614 }
615
616 return selectKey
Jingwen Chen25825ca2021-11-15 12:28:43 +0000617}
618
619// ProductConfigProperties is a map of maps to group property values according
620// their property name and the product config variable they're set under.
621//
622// The outer map key is the name of the property, like "cflags".
623//
624// The inner map key is a ProductConfigProperty, which is a struct of product
625// variable name, namespace, and the "full configuration" of the product
626// variable.
627//
628// e.g. product variable name: board, namespace: acme, full config: vendor_chip_foo
629//
630// The value of the map is the interface{} representing the value of the
631// property, like ["-DDEFINES"] for cflags.
632type ProductConfigProperties map[string]map[ProductConfigProperty]interface{}
Liz Kammera060c452021-03-24 10:14:47 -0400633
634// ProductVariableProperties returns a ProductConfigProperties containing only the properties which
635// have been set for the module in the given context.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000636func ProductVariableProperties(ctx BazelConversionPathContext) ProductConfigProperties {
Liz Kammera060c452021-03-24 10:14:47 -0400637 module := ctx.Module()
638 moduleBase := module.base()
639
640 productConfigProperties := ProductConfigProperties{}
641
Jingwen Chena47f28d2021-11-02 16:43:57 +0000642 if moduleBase.variableProperties != nil {
643 productVariablesProperty := proptools.FieldNameForProperty("product_variables")
644 productVariableValues(
645 productVariablesProperty,
646 moduleBase.variableProperties,
647 "",
648 "",
649 &productConfigProperties)
650
651 for _, configToProps := range moduleBase.GetArchVariantProperties(ctx, moduleBase.variableProperties) {
652 for config, props := range configToProps {
653 // GetArchVariantProperties is creating an instance of the requested type
654 // and productVariablesValues expects an interface, so no need to cast
655 productVariableValues(
656 productVariablesProperty,
657 props,
658 "",
659 config,
660 &productConfigProperties)
661 }
662 }
Liz Kammera060c452021-03-24 10:14:47 -0400663 }
664
Jingwen Chena47f28d2021-11-02 16:43:57 +0000665 if m, ok := module.(Bazelable); ok && m.namespacedVariableProps() != nil {
Jingwen Chen84817de2021-11-17 10:57:35 +0000666 for namespace, namespacedVariableProps := range m.namespacedVariableProps() {
667 for _, namespacedVariableProp := range namespacedVariableProps {
668 productVariableValues(
669 soongconfig.SoongConfigProperty,
670 namespacedVariableProp,
671 namespace,
672 "",
673 &productConfigProperties)
674 }
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -0400675 }
Liz Kammere3e4a5f2021-05-10 11:39:53 -0400676 }
677
Jingwen Chen58ff6802021-11-17 12:14:41 +0000678 productConfigProperties.zeroValuesForNamespacedVariables()
679
Liz Kammere3e4a5f2021-05-10 11:39:53 -0400680 return productConfigProperties
681}
682
Jingwen Chen58ff6802021-11-17 12:14:41 +0000683// zeroValuesForNamespacedVariables ensures that selects that contain __only__
684// conditions default values have zero values set for the other non-default
685// values for that select statement.
686//
687// If the ProductConfigProperties map contains these items, as parsed from the .bp file:
688//
689// library_linking_strategy: {
690// prefer_static: {
691// static_libs: [
692// "lib_a",
693// "lib_b",
694// ],
695// },
696// conditions_default: {
697// shared_libs: [
698// "lib_a",
699// "lib_b",
700// ],
701// },
702// },
703//
704// Static_libs {Library_linking_strategy ANDROID prefer_static} [lib_a lib_b]
705// Shared_libs {Library_linking_strategy ANDROID conditions_default} [lib_a lib_b]
706//
707// We need to add this:
708//
709// Shared_libs {Library_linking_strategy ANDROID prefer_static} []
710//
711// so that the following gets generated for the "dynamic_deps" attribute,
712// instead of putting lib_a and lib_b directly into dynamic_deps without a
713// select:
714//
715// dynamic_deps = select({
716// "//build/bazel/product_variables:android__library_linking_strategy__prefer_static": [],
717// "//conditions:default": [
718// "//foo/bar:lib_a",
719// "//foo/bar:lib_b",
720// ],
721// }),
722func (props *ProductConfigProperties) zeroValuesForNamespacedVariables() {
723 // A map of product config properties to the zero values of their respective
724 // property value.
725 zeroValues := make(map[ProductConfigProperty]interface{})
726
727 // A map of prop names (e.g. cflags) to product config properties where the
728 // (prop name, ProductConfigProperty) tuple contains a non-conditions_default key.
729 //
730 // e.g.
731 //
732 // prefer_static: {
733 // static_libs: [
734 // "lib_a",
735 // "lib_b",
736 // ],
737 // },
738 // conditions_default: {
739 // shared_libs: [
740 // "lib_a",
741 // "lib_b",
742 // ],
743 // },
744 //
745 // The tuple of ("static_libs", prefer_static) would be in this map.
746 hasNonDefaultValue := make(map[string]map[ProductConfigProperty]bool)
747
748 // Iterate over all added soong config variables.
749 for propName, v := range *props {
750 for p, intf := range v {
751 if p.Namespace == "" {
752 // If there's no namespace, this isn't a soong config variable,
753 // i.e. this is a product variable. product variables have no
754 // conditions_defaults, so skip them.
755 continue
756 }
757 if p.FullConfig == bazel.ConditionsDefaultConfigKey {
758 // Skip conditions_defaults.
759 continue
760 }
761 if hasNonDefaultValue[propName] == nil {
762 hasNonDefaultValue[propName] = make(map[ProductConfigProperty]bool)
763 hasNonDefaultValue[propName][p] = false
764 }
765 // Create the zero value of the variable.
766 if _, exists := zeroValues[p]; !exists {
767 zeroValue := reflect.Zero(reflect.ValueOf(intf).Type()).Interface()
768 if zeroValue == nil {
769 panic(fmt.Errorf("Expected non-nil zero value for product/config variable %+v\n", intf))
770 }
771 zeroValues[p] = zeroValue
772 }
773 hasNonDefaultValue[propName][p] = true
774 }
775 }
776
777 for propName := range *props {
778 for p, zeroValue := range zeroValues {
779 // Ignore variables that already have a non-default value for that axis
780 if exists, _ := hasNonDefaultValue[propName][p]; !exists {
781 // fmt.Println(propName, p.Namespace, p.Name, p.FullConfig, zeroValue)
782 // Insert the zero value for this propname + product config value.
783 props.AddProductConfigProperty(
784 propName,
785 p.Namespace,
786 p.Name,
787 p.FullConfig,
788 zeroValue,
789 )
790 }
791 }
792 }
793}
794
Jingwen Chena47f28d2021-11-02 16:43:57 +0000795func (p *ProductConfigProperties) AddProductConfigProperty(
796 propertyName, namespace, productVariableName, config string, property interface{}) {
797 if (*p)[propertyName] == nil {
Jingwen Chen25825ca2021-11-15 12:28:43 +0000798 (*p)[propertyName] = make(map[ProductConfigProperty]interface{})
Jingwen Chena47f28d2021-11-02 16:43:57 +0000799 }
800
Jingwen Chen25825ca2021-11-15 12:28:43 +0000801 productConfigProp := ProductConfigProperty{
802 Namespace: namespace, // e.g. acme, android
803 Name: productVariableName, // e.g. size, feature1, feature2, FEATURE3, board
804 FullConfig: config, // e.g. size, feature1-x86, size__conditions_default
Jingwen Chena47f28d2021-11-02 16:43:57 +0000805 }
Jingwen Chen25825ca2021-11-15 12:28:43 +0000806
Jingwen Chen84817de2021-11-17 10:57:35 +0000807 if existing, ok := (*p)[propertyName][productConfigProp]; ok && namespace != "" {
808 switch dst := existing.(type) {
809 case []string:
810 if src, ok := property.([]string); ok {
811 dst = append(dst, src...)
812 (*p)[propertyName][productConfigProp] = dst
813 }
814 default:
Jingwen Chen58ff6802021-11-17 12:14:41 +0000815 panic(fmt.Errorf("TODO: handle merging value %s", existing))
Jingwen Chen84817de2021-11-17 10:57:35 +0000816 }
817 } else {
818 (*p)[propertyName][productConfigProp] = property
819 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000820}
821
822var (
823 conditionsDefaultField string = proptools.FieldNameForProperty(bazel.ConditionsDefaultConfigKey)
824)
825
826// maybeExtractConfigVarProp attempts to read this value as a config var struct
827// wrapped by interfaces and ptrs. If it's not the right type, the second return
828// value is false.
829func maybeExtractConfigVarProp(v reflect.Value) (reflect.Value, bool) {
830 if v.Kind() == reflect.Interface {
831 // The conditions_default value can be either
832 // 1) an ptr to an interface of a struct (bool config variables and product variables)
833 // 2) an interface of 1) (config variables with nested structs, like string vars)
834 v = v.Elem()
835 }
836 if v.Kind() != reflect.Ptr {
837 return v, false
838 }
839 v = reflect.Indirect(v)
840 if v.Kind() == reflect.Interface {
841 // Extract the struct from the interface
842 v = v.Elem()
843 }
844
845 if !v.IsValid() {
846 return v, false
847 }
848
849 if v.Kind() != reflect.Struct {
850 return v, false
851 }
852 return v, true
853}
854
Jingwen Chen84817de2021-11-17 10:57:35 +0000855func (productConfigProperties *ProductConfigProperties) AddProductConfigProperties(namespace, suffix string, variableValues reflect.Value) {
856 // variableValues can either be a product_variables or
857 // soong_config_variables struct.
858 //
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 // },
871 //
872 // Example of soong_config_variables:
873 //
874 // soong_config_variables: {
875 // feature1: {
876 // conditions_default: {
877 // ...
878 // },
879 // cflags: ...
880 // },
881 // feature2: {
882 // cflags: ...
883 // conditions_default: {
884 // ...
885 // },
886 // },
887 // board: {
888 // soc_a: {
889 // ...
890 // },
891 // soc_a: {
892 // ...
893 // },
894 // soc_c: {},
895 // conditions_default: {
896 // ...
897 // },
898 // },
899 // }
Liz Kammera060c452021-03-24 10:14:47 -0400900 for i := 0; i < variableValues.NumField(); i++ {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000901 // e.g. Platform_sdk_version, Unbundled_build, Malloc_not_svelte, etc.
902 productVariableName := variableValues.Type().Field(i).Name
903
Liz Kammera060c452021-03-24 10:14:47 -0400904 variableValue := variableValues.Field(i)
905 // Check if any properties were set for the module
906 if variableValue.IsZero() {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000907 // e.g. feature1: {}, malloc_not_svelte: {}
Liz Kammera060c452021-03-24 10:14:47 -0400908 continue
909 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000910
911 // Unlike product variables, config variables require a few more
912 // indirections to extract the struct from the reflect.Value.
913 if v, ok := maybeExtractConfigVarProp(variableValue); ok {
914 variableValue = v
915 }
916
Liz Kammera060c452021-03-24 10:14:47 -0400917 for j := 0; j < variableValue.NumField(); j++ {
918 property := variableValue.Field(j)
919 // If the property wasn't set, no need to pass it along
920 if property.IsZero() {
921 continue
922 }
923
924 // e.g. Asflags, Cflags, Enabled, etc.
925 propertyName := variableValue.Type().Field(j).Name
Jingwen Chena47f28d2021-11-02 16:43:57 +0000926
927 if v, ok := maybeExtractConfigVarProp(property); ok {
928 // The field is a struct, which is used by:
929 // 1) soong_config_string_variables
930 //
931 // soc_a: {
932 // cflags: ...,
933 // }
934 //
935 // soc_b: {
936 // cflags: ...,
937 // }
938 //
939 // 2) conditions_default structs for all soong config variable types.
940 //
941 // conditions_default: {
942 // cflags: ...,
943 // static_libs: ...
944 // }
945 field := v
946 for k := 0; k < field.NumField(); k++ {
947 // Iterate over fields of this struct prop.
948 if field.Field(k).IsZero() {
949 continue
950 }
Jingwen Chen25825ca2021-11-15 12:28:43 +0000951 // config can also be "conditions_default".
952 config := proptools.PropertyNameForField(propertyName)
Jingwen Chena47f28d2021-11-02 16:43:57 +0000953 actualPropertyName := field.Type().Field(k).Name
954
955 productConfigProperties.AddProductConfigProperty(
956 actualPropertyName, // e.g. cflags, static_libs
957 namespace, // e.g. acme, android
958 productVariableName, // e.g. size, feature1, FEATURE2, board
959 config,
960 field.Field(k).Interface(), // e.g. ["-DDEFAULT"], ["foo", "bar"]
961 )
962 }
Jingwen Chen58ff6802021-11-17 12:14:41 +0000963 } else if property.Kind() != reflect.Interface {
964 // If not an interface, then this is not a conditions_default or
965 // a struct prop. That is, this is a regular product variable,
966 // or a bool/value config variable.
Jingwen Chena47f28d2021-11-02 16:43:57 +0000967 config := productVariableName + suffix
Jingwen Chena47f28d2021-11-02 16:43:57 +0000968 productConfigProperties.AddProductConfigProperty(
969 propertyName,
970 namespace,
971 productVariableName,
972 config,
973 property.Interface(),
974 )
Liz Kammer47535c52021-06-02 16:02:22 -0400975 }
Liz Kammera060c452021-03-24 10:14:47 -0400976 }
977 }
Liz Kammera060c452021-03-24 10:14:47 -0400978}
979
Jingwen Chen84817de2021-11-17 10:57:35 +0000980// productVariableValues uses reflection to convert a property struct for
981// product_variables and soong_config_variables to structs that can be generated
982// as select statements.
983func productVariableValues(
984 fieldName string, variableProps interface{}, namespace, suffix string, productConfigProperties *ProductConfigProperties) {
985 if suffix != "" {
986 suffix = "-" + suffix
987 }
988
989 // variableValues represent the product_variables or soong_config_variables struct.
990 variableValues := reflect.ValueOf(variableProps).Elem().FieldByName(fieldName)
991 productConfigProperties.AddProductConfigProperties(namespace, suffix, variableValues)
992}
993
Colin Crosseabaedd2020-02-06 17:01:55 -0800994func VariableMutator(mctx BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700995 var module Module
Colin Cross7f64b6d2015-07-09 13:57:48 -0700996 var ok bool
Colin Cross635c3b02016-05-18 15:37:25 -0700997 if module, ok = mctx.Module().(Module); !ok {
Colin Cross7f64b6d2015-07-09 13:57:48 -0700998 return
999 }
1000
1001 // TODO: depend on config variable, create variants, propagate variants up tree
1002 a := module.base()
Colin Cross18c46802019-09-24 22:19:02 -07001003
1004 if a.variableProperties == nil {
1005 return
1006 }
1007
1008 variableValues := reflect.ValueOf(a.variableProperties).Elem().FieldByName("Product_variables")
Colin Cross7f64b6d2015-07-09 13:57:48 -07001009
Colin Cross0cec3122021-01-20 11:27:32 -08001010 productVariables := reflect.ValueOf(mctx.Config().productVariables)
1011
Colin Cross7f64b6d2015-07-09 13:57:48 -07001012 for i := 0; i < variableValues.NumField(); i++ {
1013 variableValue := variableValues.Field(i)
Colin Cross485e5722015-08-27 13:28:01 -07001014 name := variableValues.Type().Field(i).Name
1015 property := "product_variables." + proptools.PropertyNameForField(name)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001016
Colin Crossa6bc19e2015-09-16 13:53:42 -07001017 // Check that the variable was set for the product
Colin Cross0cec3122021-01-20 11:27:32 -08001018 val := productVariables.FieldByName(name)
Colin Crossa6bc19e2015-09-16 13:53:42 -07001019 if !val.IsValid() || val.Kind() != reflect.Ptr || val.IsNil() {
1020 continue
Colin Cross7f64b6d2015-07-09 13:57:48 -07001021 }
Colin Crossa6bc19e2015-09-16 13:53:42 -07001022
1023 val = val.Elem()
1024
1025 // For bools, check that the value is true
1026 if val.Kind() == reflect.Bool && val.Bool() == false {
1027 continue
1028 }
1029
1030 // Check if any properties were set for the module
Colin Cross6961a492020-02-06 16:57:45 -08001031 if variableValue.IsZero() {
Colin Crossa6bc19e2015-09-16 13:53:42 -07001032 continue
1033 }
Colin Crossa6bc19e2015-09-16 13:53:42 -07001034 a.setVariableProperties(mctx, property, variableValue, val.Interface())
Colin Cross7f64b6d2015-07-09 13:57:48 -07001035 }
1036}
1037
Colin Cross4157e882019-06-06 16:57:04 -07001038func (m *ModuleBase) setVariableProperties(ctx BottomUpMutatorContext,
Colin Cross7f64b6d2015-07-09 13:57:48 -07001039 prefix string, productVariablePropertyValue reflect.Value, variableValue interface{}) {
1040
Colin Cross7e0eaf12017-05-05 16:16:24 -07001041 printfIntoProperties(ctx, prefix, productVariablePropertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001042
Usta851a3272022-01-05 23:42:33 -05001043 err := proptools.AppendMatchingProperties(m.GetProperties(),
Colin Cross06a931b2015-10-28 17:23:31 -07001044 productVariablePropertyValue.Addr().Interface(), nil)
1045 if err != nil {
1046 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1047 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1048 } else {
1049 panic(err)
1050 }
1051 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001052}
1053
Colin Cross7e0eaf12017-05-05 16:16:24 -07001054func printfIntoPropertiesError(ctx BottomUpMutatorContext, prefix string,
1055 productVariablePropertyValue reflect.Value, i int, err error) {
1056
1057 field := productVariablePropertyValue.Type().Field(i).Name
1058 property := prefix + "." + proptools.PropertyNameForField(field)
1059 ctx.PropertyErrorf(property, "%s", err)
1060}
1061
1062func printfIntoProperties(ctx BottomUpMutatorContext, prefix string,
1063 productVariablePropertyValue reflect.Value, variableValue interface{}) {
1064
Colin Cross7f64b6d2015-07-09 13:57:48 -07001065 for i := 0; i < productVariablePropertyValue.NumField(); i++ {
1066 propertyValue := productVariablePropertyValue.Field(i)
Colin Crossdd0dbe62015-12-02 15:24:38 -08001067 kind := propertyValue.Kind()
1068 if kind == reflect.Ptr {
1069 if propertyValue.IsNil() {
1070 continue
1071 }
1072 propertyValue = propertyValue.Elem()
1073 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001074 switch propertyValue.Kind() {
1075 case reflect.String:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001076 err := printfIntoProperty(propertyValue, variableValue)
1077 if err != nil {
1078 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
1079 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001080 case reflect.Slice:
1081 for j := 0; j < propertyValue.Len(); j++ {
Colin Cross7e0eaf12017-05-05 16:16:24 -07001082 err := printfIntoProperty(propertyValue.Index(j), variableValue)
1083 if err != nil {
1084 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
1085 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001086 }
Colin Crossdd0dbe62015-12-02 15:24:38 -08001087 case reflect.Bool:
1088 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -07001089 case reflect.Struct:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001090 printfIntoProperties(ctx, prefix, propertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001091 default:
1092 panic(fmt.Errorf("unsupported field kind %q", propertyValue.Kind()))
1093 }
1094 }
1095}
1096
Colin Cross7e0eaf12017-05-05 16:16:24 -07001097func printfIntoProperty(propertyValue reflect.Value, variableValue interface{}) error {
Colin Cross7f64b6d2015-07-09 13:57:48 -07001098 s := propertyValue.String()
Colin Cross7e0eaf12017-05-05 16:16:24 -07001099
1100 count := strings.Count(s, "%")
1101 if count == 0 {
1102 return nil
1103 }
1104
1105 if count > 1 {
1106 return fmt.Errorf("product variable properties only support a single '%%'")
1107 }
1108
Colin Cross7f64b6d2015-07-09 13:57:48 -07001109 if strings.Contains(s, "%d") {
1110 switch v := variableValue.(type) {
1111 case int:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001112 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -07001113 case bool:
1114 if v {
Colin Cross7e0eaf12017-05-05 16:16:24 -07001115 variableValue = 1
1116 } else {
1117 variableValue = 0
Colin Cross7f64b6d2015-07-09 13:57:48 -07001118 }
1119 default:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001120 return fmt.Errorf("unsupported type %T for %%d", variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001121 }
Colin Cross7e0eaf12017-05-05 16:16:24 -07001122 } else if strings.Contains(s, "%s") {
1123 switch variableValue.(type) {
1124 case string:
1125 // Nothing
1126 default:
1127 return fmt.Errorf("unsupported type %T for %%s", variableValue)
1128 }
1129 } else {
1130 return fmt.Errorf("unsupported %% in product variable property")
Colin Cross7f64b6d2015-07-09 13:57:48 -07001131 }
Colin Cross7e0eaf12017-05-05 16:16:24 -07001132
1133 propertyValue.Set(reflect.ValueOf(fmt.Sprintf(s, variableValue)))
1134
1135 return nil
Colin Cross7f64b6d2015-07-09 13:57:48 -07001136}
Colin Cross18c46802019-09-24 22:19:02 -07001137
1138var variablePropTypeMap OncePer
1139
1140// sliceToTypeArray takes a slice of property structs and returns a reflection created array containing the
1141// reflect.Types of each property struct. The result can be used as a key in a map.
1142func sliceToTypeArray(s []interface{}) interface{} {
1143 // Create an array using reflection whose length is the length of the input slice
1144 ret := reflect.New(reflect.ArrayOf(len(s), reflect.TypeOf(reflect.TypeOf(0)))).Elem()
1145 for i, e := range s {
1146 ret.Index(i).Set(reflect.ValueOf(reflect.TypeOf(e)))
1147 }
1148 return ret.Interface()
1149}
1150
Colin Crosseabaedd2020-02-06 17:01:55 -08001151func initProductVariableModule(m Module) {
1152 base := m.base()
1153
1154 // Allow tests to override the default product variables
1155 if base.variableProperties == nil {
1156 base.variableProperties = defaultProductVariables
1157 }
1158 // Filter the product variables properties to the ones that exist on this module
1159 base.variableProperties = createVariableProperties(m.GetProperties(), base.variableProperties)
1160 if base.variableProperties != nil {
1161 m.AddProperties(base.variableProperties)
1162 }
1163}
1164
Colin Cross18c46802019-09-24 22:19:02 -07001165// createVariableProperties takes the list of property structs for a module and returns a property struct that
1166// contains the product variable properties that exist in the property structs, or nil if there are none. It
1167// caches the result.
1168func createVariableProperties(moduleTypeProps []interface{}, productVariables interface{}) interface{} {
1169 // Convert the moduleTypeProps to an array of reflect.Types that can be used as a key in the OncePer.
1170 key := sliceToTypeArray(moduleTypeProps)
1171
1172 // Use the variablePropTypeMap OncePer to cache the result for each set of property struct types.
1173 typ, _ := variablePropTypeMap.Once(NewCustomOnceKey(key), func() interface{} {
1174 // Compute the filtered property struct type.
1175 return createVariablePropertiesType(moduleTypeProps, productVariables)
1176 }).(reflect.Type)
1177
1178 if typ == nil {
1179 return nil
1180 }
1181
1182 // Create a new pointer to a filtered property struct.
1183 return reflect.New(typ).Interface()
1184}
1185
1186// createVariablePropertiesType creates a new type that contains only the product variable properties that exist in
1187// a list of property structs.
1188func createVariablePropertiesType(moduleTypeProps []interface{}, productVariables interface{}) reflect.Type {
1189 typ, _ := proptools.FilterPropertyStruct(reflect.TypeOf(productVariables),
1190 func(field reflect.StructField, prefix string) (bool, reflect.StructField) {
1191 // Filter function, returns true if the field should be in the resulting struct
1192 if prefix == "" {
1193 // Keep the top level Product_variables field
1194 return true, field
1195 }
1196 _, rest := splitPrefix(prefix)
1197 if rest == "" {
1198 // Keep the 2nd level field (i.e. Product_variables.Eng)
1199 return true, field
1200 }
1201
1202 // Strip off the first 2 levels of the prefix
1203 _, prefix = splitPrefix(rest)
1204
1205 for _, p := range moduleTypeProps {
1206 if fieldExistsByNameRecursive(reflect.TypeOf(p).Elem(), prefix, field.Name) {
1207 // Keep any fields that exist in one of the property structs
1208 return true, field
1209 }
1210 }
1211
1212 return false, field
1213 })
1214 return typ
1215}
1216
1217func splitPrefix(prefix string) (first, rest string) {
1218 index := strings.IndexByte(prefix, '.')
1219 if index == -1 {
1220 return prefix, ""
1221 }
1222 return prefix[:index], prefix[index+1:]
1223}
1224
1225func fieldExistsByNameRecursive(t reflect.Type, prefix, name string) bool {
1226 if t.Kind() != reflect.Struct {
1227 panic(fmt.Errorf("fieldExistsByNameRecursive can only be called on a reflect.Struct"))
1228 }
1229
1230 if prefix != "" {
1231 split := strings.SplitN(prefix, ".", 2)
1232 firstPrefix := split[0]
1233 rest := ""
1234 if len(split) > 1 {
1235 rest = split[1]
1236 }
1237 f, exists := t.FieldByName(firstPrefix)
1238 if !exists {
1239 return false
1240 }
1241 ft := f.Type
1242 if ft.Kind() == reflect.Ptr {
1243 ft = ft.Elem()
1244 }
1245 if ft.Kind() != reflect.Struct {
1246 panic(fmt.Errorf("field %q in %q is not a struct", firstPrefix, t))
1247 }
1248 return fieldExistsByNameRecursive(ft, rest, name)
1249 } else {
1250 _, exists := t.FieldByName(name)
1251 return exists
1252 }
1253}