blob: 373891ae4a63079598cccc8db6b6c81b8330a1cd [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"`
Anton Hansson97d0bae2022-02-16 16:15:10 +0000194 Platform_base_sdk_extension_version *int `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700195 Platform_version_active_codenames []string `json:",omitempty"`
Colin Cross092c9da2019-04-02 22:56:43 -0700196 Platform_vndk_version *string `json:",omitempty"`
197 Platform_systemsdk_versions []string `json:",omitempty"`
198 Platform_security_patch *string `json:",omitempty"`
199 Platform_preview_sdk_version *string `json:",omitempty"`
200 Platform_min_supported_target_sdk_version *string `json:",omitempty"`
201 Platform_base_os *string `json:",omitempty"`
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900202 Platform_version_last_stable *string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700203
Jeongik Cha219141c2020-08-06 23:00:37 +0900204 DeviceName *string `json:",omitempty"`
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000205 DeviceProduct *string `json:",omitempty"`
Jeongik Cha219141c2020-08-06 23:00:37 +0900206 DeviceArch *string `json:",omitempty"`
207 DeviceArchVariant *string `json:",omitempty"`
208 DeviceCpuVariant *string `json:",omitempty"`
209 DeviceAbi []string `json:",omitempty"`
210 DeviceVndkVersion *string `json:",omitempty"`
211 DeviceCurrentApiLevelForVendorModules *string `json:",omitempty"`
212 DeviceSystemSdkVersions []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700213
Jose Galmes6f843bc2020-12-11 13:36:29 -0800214 RecoverySnapshotVersion *string `json:",omitempty"`
215
Colin Crossa74ca042019-01-31 14:31:51 -0800216 DeviceSecondaryArch *string `json:",omitempty"`
217 DeviceSecondaryArchVariant *string `json:",omitempty"`
218 DeviceSecondaryCpuVariant *string `json:",omitempty"`
219 DeviceSecondaryAbi []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700220
dimitry8d6dde82019-07-11 10:23:53 +0200221 NativeBridgeArch *string `json:",omitempty"`
222 NativeBridgeArchVariant *string `json:",omitempty"`
223 NativeBridgeCpuVariant *string `json:",omitempty"`
224 NativeBridgeAbi []string `json:",omitempty"`
225 NativeBridgeRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100226
dimitry8d6dde82019-07-11 10:23:53 +0200227 NativeBridgeSecondaryArch *string `json:",omitempty"`
228 NativeBridgeSecondaryArchVariant *string `json:",omitempty"`
229 NativeBridgeSecondaryCpuVariant *string `json:",omitempty"`
230 NativeBridgeSecondaryAbi []string `json:",omitempty"`
231 NativeBridgeSecondaryRelativePath *string `json:",omitempty"`
dimitry1f33e402019-03-26 12:39:31 +0100232
Colin Cross4225f652015-09-17 14:33:42 -0700233 HostArch *string `json:",omitempty"`
234 HostSecondaryArch *string `json:",omitempty"`
Colin Cross528d67e2021-07-23 22:23:07 +0000235 HostMusl *bool `json:",omitempty"`
Dan Willemsen490fd492015-11-24 17:53:15 -0800236
237 CrossHost *string `json:",omitempty"`
238 CrossHostArch *string `json:",omitempty"`
239 CrossHostSecondaryArch *string `json:",omitempty"`
Colin Cross83163192015-12-01 16:31:16 -0800240
Jeongik Chacee5ba92021-02-19 12:11:51 +0900241 DeviceResourceOverlays []string `json:",omitempty"`
242 ProductResourceOverlays []string `json:",omitempty"`
243 EnforceRROTargets []string `json:",omitempty"`
Colin Crossa74ca042019-01-31 14:31:51 -0800244 EnforceRROExcludedOverlays []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700245
Colin Crossa74ca042019-01-31 14:31:51 -0800246 AAPTCharacteristics *string `json:",omitempty"`
247 AAPTConfig []string `json:",omitempty"`
248 AAPTPreferredConfig *string `json:",omitempty"`
249 AAPTPrebuiltDPI []string `json:",omitempty"`
Colin Crossface4e42017-10-30 17:32:15 -0700250
Colin Cross61ae0b72017-12-01 17:16:02 -0800251 DefaultAppCertificate *string `json:",omitempty"`
252
Colin Crossface4e42017-10-30 17:32:15 -0700253 AppsDefaultVersionName *string `json:",omitempty"`
254
Cole Faust701ca252021-11-23 19:02:08 -0800255 Allow_missing_dependencies *bool `json:",omitempty"`
256 Unbundled_build *bool `json:",omitempty"`
257 Unbundled_build_apps []string `json:",omitempty"`
258 Unbundled_build_image *bool `json:",omitempty"`
259 Always_use_prebuilt_sdks *bool `json:",omitempty"`
260 Skip_boot_jars_check *bool `json:",omitempty"`
261 Malloc_not_svelte *bool `json:",omitempty"`
262 Malloc_zero_contents *bool `json:",omitempty"`
263 Malloc_pattern_fill_contents *bool `json:",omitempty"`
264 Safestack *bool `json:",omitempty"`
265 HostStaticBinaries *bool `json:",omitempty"`
266 Binder32bit *bool `json:",omitempty"`
267 UseGoma *bool `json:",omitempty"`
268 UseRBE *bool `json:",omitempty"`
269 UseRBEJAVAC *bool `json:",omitempty"`
270 UseRBER8 *bool `json:",omitempty"`
271 UseRBED8 *bool `json:",omitempty"`
272 Debuggable *bool `json:",omitempty"`
273 Eng *bool `json:",omitempty"`
274 Treble_linker_namespaces *bool `json:",omitempty"`
275 Enforce_vintf_manifest *bool `json:",omitempty"`
276 Uml *bool `json:",omitempty"`
277 Arc *bool `json:",omitempty"`
278 MinimizeJavaDebugInfo *bool `json:",omitempty"`
Colin Cross16b23492016-01-06 14:41:07 -0800279
Logan Chien4fcea3d2018-11-20 11:59:08 +0800280 Check_elf_files *bool `json:",omitempty"`
281
Colin Cross5a0dcd52018-10-05 14:20:06 -0700282 UncompressPrivAppDex *bool `json:",omitempty"`
283 ModulesLoadedByPrivilegedModules []string `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800284
satayevd604b212021-07-21 14:23:52 +0100285 BootJars ConfiguredJarList `json:",omitempty"`
286 ApexBootJars ConfiguredJarList `json:",omitempty"`
Vladimir Markoe8b00d62018-12-21 15:54:16 +0000287
Colin Crossa74ca042019-01-31 14:31:51 -0800288 IntegerOverflowExcludePaths []string `json:",omitempty"`
Ivan Lozano5f595532017-07-13 14:46:05 -0700289
Colin Crossa74ca042019-01-31 14:31:51 -0800290 EnableCFI *bool `json:",omitempty"`
291 CFIExcludePaths []string `json:",omitempty"`
292 CFIIncludePaths []string `json:",omitempty"`
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -0700293
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -0800294 DisableScudo *bool `json:",omitempty"`
295
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -0800296 MemtagHeapExcludePaths []string `json:",omitempty"`
297 MemtagHeapAsyncIncludePaths []string `json:",omitempty"`
298 MemtagHeapSyncIncludePaths []string `json:",omitempty"`
299
Justin Yund5f6c822019-06-25 16:47:17 +0900300 VendorPath *string `json:",omitempty"`
301 OdmPath *string `json:",omitempty"`
302 ProductPath *string `json:",omitempty"`
303 SystemExtPath *string `json:",omitempty"`
Dan Willemsen4353bc42016-12-05 17:16:02 -0800304
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700305 ClangTidy *bool `json:",omitempty"`
306 TidyChecks *string `json:",omitempty"`
307
Roland Levillainada12702020-06-09 13:07:36 +0100308 JavaCoveragePaths []string `json:",omitempty"`
309 JavaCoverageExcludePaths []string `json:",omitempty"`
310
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -0800311 GcovCoverage *bool `json:",omitempty"`
312 ClangCoverage *bool `json:",omitempty"`
313 NativeCoveragePaths []string `json:",omitempty"`
314 NativeCoverageExcludePaths []string `json:",omitempty"`
315 ClangCoverageContinuousMode *bool `json:",omitempty"`
Dan Willemsen581341d2017-02-09 16:16:31 -0800316
Colin Cross1a6acd42020-06-16 17:51:46 -0700317 // Set by NewConfig
Liz Kammer09f947d2021-05-12 14:51:49 -0400318 Native_coverage *bool `json:",omitempty"`
Colin Cross1a6acd42020-06-16 17:51:46 -0700319
Colin Cross23ae82a2016-11-02 14:34:39 -0700320 SanitizeHost []string `json:",omitempty"`
321 SanitizeDevice []string `json:",omitempty"`
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700322 SanitizeDeviceDiag []string `json:",omitempty"`
Colin Cross23ae82a2016-11-02 14:34:39 -0700323 SanitizeDeviceArch []string `json:",omitempty"`
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800324
325 ArtUseReadBarrier *bool `json:",omitempty"`
Jack He8cc71432016-12-08 15:45:07 -0800326
327 BtConfigIncludeDir *string `json:",omitempty"`
Colin Cross95436422017-05-04 13:57:05 -0700328
329 Override_rs_driver *string `json:",omitempty"`
Jiyong Parkd773eb32017-07-03 13:18:12 +0900330
331 DeviceKernelHeaders []string `json:",omitempty"`
Justin Yun71549282017-11-17 12:10:28 +0900332
333 ExtraVndkVersions []string `json:",omitempty"`
Jeff Gaston088e29e2017-11-29 16:47:17 -0800334
335 NamespacesToExport []string `json:",omitempty"`
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -0800336
Yi Kongeb8efc92021-12-09 18:06:29 +0800337 AfdoAdditionalProfileDirs []string `json:",omitempty"`
338 PgoAdditionalProfileDirs []string `json:",omitempty"`
Dan Willemsen0fe78662018-03-26 12:41:18 -0700339
Inseob Kimae553032019-05-14 18:52:49 +0900340 VndkUseCoreVariant *bool `json:",omitempty"`
341 VndkSnapshotBuildArtifacts *bool `json:",omitempty"`
Vic Yangefd249e2018-11-12 20:19:56 -0800342
Inseob Kim7cf14652021-01-06 23:06:52 +0900343 DirectedVendorSnapshot bool `json:",omitempty"`
344 VendorSnapshotModules map[string]bool `json:",omitempty"`
345
Jose Galmes4c6895e2021-02-09 07:44:30 -0800346 DirectedRecoverySnapshot bool `json:",omitempty"`
347 RecoverySnapshotModules map[string]bool `json:",omitempty"`
348
Justin DeMartino383bfb32021-02-24 10:49:43 -0800349 VendorSnapshotDirsIncluded []string `json:",omitempty"`
350 VendorSnapshotDirsExcluded []string `json:",omitempty"`
351 RecoverySnapshotDirsExcluded []string `json:",omitempty"`
352 RecoverySnapshotDirsIncluded []string `json:",omitempty"`
Rob Seymour925aa092021-08-10 20:42:03 +0000353 HostFakeSnapshotEnabled bool `json:",omitempty"`
Justin DeMartino383bfb32021-02-24 10:49:43 -0800354
Inseob Kim0f46e7c2021-12-15 22:48:14 +0900355 BoardVendorSepolicyDirs []string `json:",omitempty"`
356 BoardOdmSepolicyDirs []string `json:",omitempty"`
357 BoardReqdMaskPolicy []string `json:",omitempty"`
358 BoardPlatVendorPolicy []string `json:",omitempty"`
359 BoardSystemExtPublicPrebuiltDirs []string `json:",omitempty"`
360 BoardSystemExtPrivatePrebuiltDirs []string `json:",omitempty"`
361 BoardProductPublicPrebuiltDirs []string `json:",omitempty"`
362 BoardProductPrivatePrebuiltDirs []string `json:",omitempty"`
363 SystemExtPublicSepolicyDirs []string `json:",omitempty"`
364 SystemExtPrivateSepolicyDirs []string `json:",omitempty"`
365 BoardSepolicyM4Defs []string `json:",omitempty"`
Tri Vo35a51432018-03-25 20:00:00 -0700366
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900367 BoardSepolicyVers *string `json:",omitempty"`
368 PlatformSepolicyVersion *string `json:",omitempty"`
Inseob Kima10ef272021-09-15 03:04:53 +0000369 TotSepolicyVersion *string `json:",omitempty"`
Inseob Kim16ebd5a2020-12-09 23:08:17 +0900370
Inseob Kim1a0afcc2022-02-14 23:10:51 +0900371 SystemExtSepolicyPrebuiltApiDir *string `json:",omitempty"`
372 ProductSepolicyPrebuiltApiDir *string `json:",omitempty"`
373
Inseob Kim843f6642022-01-07 09:11:23 +0900374 PlatformSepolicyCompatVersions []string `json:",omitempty"`
375
Dan Willemsen0fe78662018-03-26 12:41:18 -0700376 VendorVars map[string]map[string]string `json:",omitempty"`
Colin Cross395f2cf2018-10-24 16:10:32 -0700377
Dan Albertd05ba002021-04-13 15:55:47 -0700378 Ndk_abis *bool `json:",omitempty"`
Jiyong Park8fd61922018-11-08 02:50:25 +0900379
Jiyong Park4da07972021-01-05 21:01:11 +0900380 Flatten_apex *bool `json:",omitempty"`
381 ForceApexSymlinkOptimization *bool `json:",omitempty"`
382 CompressedApex *bool `json:",omitempty"`
383 Aml_abis *bool `json:",omitempty"`
Colin Cross43f08db2018-11-12 10:13:39 -0800384
385 DexpreoptGlobalConfig *string `json:",omitempty"`
Jiyong Park7f67f482019-01-05 12:57:48 +0900386
Inseob Kim7b85eeb2021-03-23 20:52:24 +0900387 WithDexpreopt bool `json:",omitempty"`
388
Jiyong Park7f67f482019-01-05 12:57:48 +0900389 ManifestPackageNameOverrides []string `json:",omitempty"`
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800390 CertificateOverrides []string `json:",omitempty"`
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800391 PackageNameOverrides []string `json:",omitempty"`
Jeongik Chac9464142019-01-07 12:07:27 +0900392
Albert Martineefabcf2022-03-21 20:11:16 +0000393 ApexGlobalMinSdkVersionOverride *string `json:",omitempty"`
394
Jeongik Chac9464142019-01-07 12:07:27 +0900395 EnforceSystemCertificate *bool `json:",omitempty"`
Colin Cross440e0d02020-06-11 11:32:11 -0700396 EnforceSystemCertificateAllowList []string `json:",omitempty"`
Colin Cross8faf8fc2019-01-16 15:15:52 -0800397
Colin Crossf24a22a2019-01-31 14:12:44 -0800398 ProductHiddenAPIStubs []string `json:",omitempty"`
399 ProductHiddenAPIStubsSystem []string `json:",omitempty"`
400 ProductHiddenAPIStubsTest []string `json:",omitempty"`
Dan Willemsen71c74602019-04-10 12:27:35 -0700401
Inseob Kim0866b002019-04-15 20:21:29 +0900402 ProductPublicSepolicyDirs []string `json:",omitempty"`
403 ProductPrivateSepolicyDirs []string `json:",omitempty"`
Inseob Kim0866b002019-04-15 20:21:29 +0900404
Justin Yun5f7f7e82019-11-18 19:52:14 +0900405 ProductVndkVersion *string `json:",omitempty"`
406
Dan Willemsen54879d12019-04-18 10:08:46 -0700407 TargetFSConfigGen []string `json:",omitempty"`
Colin Cross50ddcc42019-05-16 12:28:22 -0700408
409 MissingUsesLibraries []string `json:",omitempty"`
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900410
411 EnforceProductPartitionInterface *bool `json:",omitempty"`
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900412
JaeMan Parkff715562020-10-19 17:25:58 +0900413 EnforceInterPartitionJavaSdkLibrary *bool `json:",omitempty"`
414 InterPartitionJavaLibraryAllowList []string `json:",omitempty"`
415
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900416 InstallExtraFlattenedApexes *bool `json:",omitempty"`
Yifan Hong82db7352020-01-21 16:12:26 -0800417
418 BoardUsesRecoveryAsBoot *bool `json:",omitempty"`
Yifan Hong97365ee2020-07-29 09:51:57 -0700419
Yifan Hong42bef8d2020-08-05 14:36:09 -0700420 BoardKernelBinaries []string `json:",omitempty"`
421 BoardKernelModuleInterfaceVersions []string `json:",omitempty"`
Yifan Hongdd8dacc2020-10-21 15:40:17 -0700422
423 BoardMoveRecoveryResourcesToVendorBoot *bool `json:",omitempty"`
Bill Peckhambae47492021-01-08 09:34:44 -0800424
425 PrebuiltHiddenApiDir *string `json:",omitempty"`
Inseob Kim60c32f02020-12-21 22:53:05 +0900426
427 ShippingApiLevel *string `json:",omitempty"`
Inseob Kim0cac7b42021-02-03 18:16:46 +0900428
Liz Kammer619be462022-01-28 15:13:39 -0500429 BuildBrokenEnforceSyspropOwner bool `json:",omitempty"`
430 BuildBrokenTrebleSyspropNeverallow bool `json:",omitempty"`
431 BuildBrokenVendorPropertyNamespace bool `json:",omitempty"`
432 BuildBrokenInputDirModules []string `json:",omitempty"`
Inseob Kim67e5add2021-03-17 18:05:33 +0900433
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -0700434 BuildDebugfsRestrictionsEnabled bool `json:",omitempty"`
435
Inseob Kim67e5add2021-03-17 18:05:33 +0900436 RequiresInsecureExecmemForSwiftshader bool `json:",omitempty"`
437
438 SelinuxIgnoreNeverallows bool `json:",omitempty"`
439
440 SepolicySplit bool `json:",omitempty"`
Inseob Kima10ef272021-09-15 03:04:53 +0000441
442 SepolicyFreezeTestExtraDirs []string `json:",omitempty"`
443 SepolicyFreezeTestExtraPrebuiltDirs []string `json:",omitempty"`
Jiyong Parkd163d4d2021-10-12 16:47:43 +0900444
445 GenerateAidlNdkPlatformBackend bool `json:",omitempty"`
Colin Crossa6bc19e2015-09-16 13:53:42 -0700446}
447
448func boolPtr(v bool) *bool {
449 return &v
Colin Cross485e5722015-08-27 13:28:01 -0700450}
451
Dan Willemsen47cf66b2015-09-16 16:48:54 -0700452func intPtr(v int) *int {
453 return &v
454}
455
Colin Cross4225f652015-09-17 14:33:42 -0700456func stringPtr(v string) *string {
457 return &v
458}
459
Colin Cross27385972015-09-18 10:57:10 -0700460func (v *productVariables) SetDefaultConfig() {
461 *v = productVariables{
Colin Cross2a2e0db2020-02-21 16:55:46 -0800462 BuildNumberFile: stringPtr("build_number.txt"),
Dan Willemsenb6d171b2019-04-07 09:41:44 -0700463
Jiyong Park84d8a7e2020-09-25 13:44:51 +0900464 Platform_version_name: stringPtr("S"),
465 Platform_sdk_version: intPtr(30),
466 Platform_sdk_codename: stringPtr("S"),
Dan Willemsenb6d171b2019-04-07 09:41:44 -0700467 Platform_sdk_final: boolPtr(false),
Jiyong Park84d8a7e2020-09-25 13:44:51 +0900468 Platform_version_active_codenames: []string{"S"},
469 Platform_vndk_version: stringPtr("S"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800470
Colin Cross4225f652015-09-17 14:33:42 -0700471 HostArch: stringPtr("x86_64"),
472 HostSecondaryArch: stringPtr("x86"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800473 DeviceName: stringPtr("generic_arm64"),
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000474 DeviceProduct: stringPtr("aosp_arm-eng"),
Colin Cross4225f652015-09-17 14:33:42 -0700475 DeviceArch: stringPtr("arm64"),
Dan Willemsena91d1272016-03-29 22:06:05 -0700476 DeviceArchVariant: stringPtr("armv8-a"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800477 DeviceCpuVariant: stringPtr("generic"),
Colin Crossa74ca042019-01-31 14:31:51 -0800478 DeviceAbi: []string{"arm64-v8a"},
Colin Cross4225f652015-09-17 14:33:42 -0700479 DeviceSecondaryArch: stringPtr("arm"),
Dan Willemsencbf9e822017-11-13 14:34:56 -0800480 DeviceSecondaryArchVariant: stringPtr("armv8-a"),
481 DeviceSecondaryCpuVariant: stringPtr("generic"),
Colin Crossa74ca042019-01-31 14:31:51 -0800482 DeviceSecondaryAbi: []string{"armeabi-v7a", "armeabi"},
Colin Crossface4e42017-10-30 17:32:15 -0700483
Colin Crossa74ca042019-01-31 14:31:51 -0800484 AAPTConfig: []string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700485 AAPTPreferredConfig: stringPtr("xhdpi"),
486 AAPTCharacteristics: stringPtr("nosdcard"),
Colin Crossa74ca042019-01-31 14:31:51 -0800487 AAPTPrebuiltDPI: []string{"xhdpi", "xxhdpi"},
Colin Crossface4e42017-10-30 17:32:15 -0700488
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700489 Malloc_not_svelte: boolPtr(true),
Steven Morelandd1342012020-07-30 20:38:49 +0000490 Malloc_zero_contents: boolPtr(true),
Evgenii Stepanov19ff3c92020-04-29 14:57:30 -0700491 Malloc_pattern_fill_contents: boolPtr(false),
492 Safestack: boolPtr(false),
Lukacs T. Berki720b3962021-03-17 13:34:30 +0100493
satayevd604b212021-07-21 14:23:52 +0100494 BootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
495 ApexBootJars: ConfiguredJarList{apexes: []string{}, jars: []string{}},
Colin Cross485e5722015-08-27 13:28:01 -0700496 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800497
498 if runtime.GOOS == "linux" {
499 v.CrossHost = stringPtr("windows")
500 v.CrossHostArch = stringPtr("x86")
Dan Willemsen07cd0512016-02-03 23:16:33 -0800501 v.CrossHostSecondaryArch = stringPtr("x86_64")
Dan Willemsen490fd492015-11-24 17:53:15 -0800502 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700503}
504
Liz Kammera060c452021-03-24 10:14:47 -0400505// ProductConfigContext requires the access to the Module to get product config properties.
506type ProductConfigContext interface {
507 Module() Module
508}
509
510// ProductConfigProperty contains the information for a single property (may be a struct) paired
511// with the appropriate ProductConfigVariable.
512type ProductConfigProperty struct {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000513 // The name of the product variable, e.g. "safestack", "malloc_not_svelte",
514 // "board"
Jingwen Chen25825ca2021-11-15 12:28:43 +0000515 Name string
Jingwen Chena47f28d2021-11-02 16:43:57 +0000516
517 // Namespace of the variable, if this is a soong_config_module_type variable
Jingwen Chen25825ca2021-11-15 12:28:43 +0000518 // e.g. "acme", "ANDROID", "vendor_name"
519 Namespace string
Jingwen Chena47f28d2021-11-02 16:43:57 +0000520
521 // Unique configuration to identify this product config property (i.e. a
522 // primary key), as just using the product variable name is not sufficient.
523 //
524 // For product variables, this is the product variable name + optional
525 // archvariant information. e.g.
526 //
527 // product_variables: {
528 // foo: {
529 // cflags: ["-Dfoo"],
530 // },
531 // },
532 //
533 // FullConfig would be "foo".
534 //
535 // target: {
536 // android: {
537 // product_variables: {
538 // foo: {
539 // cflags: ["-Dfoo-android"],
540 // },
541 // },
542 // },
543 // },
544 //
545 // FullConfig would be "foo-android".
546 //
547 // For soong config variables, this is the namespace + product variable name
548 // + value of the variable, if applicable. The value can also be
549 // conditions_default.
550 //
551 // e.g.
552 //
553 // soong_config_variables: {
554 // feature1: {
555 // conditions_default: {
556 // cflags: ["-DDEFAULT1"],
557 // },
558 // cflags: ["-DFEATURE1"],
559 // },
560 // }
561 //
562 // where feature1 is created in the "acme" namespace, so FullConfig would be
563 // "acme__feature1" and "acme__feature1__conditions_default".
564 //
565 // e.g.
566 //
567 // soong_config_variables: {
568 // board: {
569 // soc_a: {
570 // cflags: ["-DSOC_A"],
571 // },
572 // soc_b: {
573 // cflags: ["-DSOC_B"],
574 // },
575 // soc_c: {},
576 // conditions_default: {
577 // cflags: ["-DSOC_DEFAULT"]
578 // },
579 // },
580 // }
581 //
582 // where board is created in the "acme" namespace, so FullConfig would be
583 // "acme__board__soc_a", "acme__board__soc_b", and
584 // "acme__board__conditions_default"
585 FullConfig string
Liz Kammera060c452021-03-24 10:14:47 -0400586}
587
Jingwen Chen58ff6802021-11-17 12:14:41 +0000588func (p *ProductConfigProperty) AlwaysEmit() bool {
589 return p.Namespace != ""
590}
591
Jingwen Chena47f28d2021-11-02 16:43:57 +0000592func (p *ProductConfigProperty) ConfigurationAxis() bazel.ConfigurationAxis {
593 if p.Namespace == "" {
594 return bazel.ProductVariableConfigurationAxis(p.FullConfig)
595 } else {
596 // Soong config variables can be uniquely identified by the namespace
597 // (e.g. acme, android) and the product variable name (e.g. board, size)
Jingwen Chen25825ca2021-11-15 12:28:43 +0000598 return bazel.ProductVariableConfigurationAxis(p.Namespace + "__" + p.Name)
Jingwen Chena47f28d2021-11-02 16:43:57 +0000599 }
600}
601
Jingwen Chen25825ca2021-11-15 12:28:43 +0000602// SelectKey returns the literal string that represents this variable in a BUILD
603// select statement.
604func (p *ProductConfigProperty) SelectKey() string {
605 if p.Namespace == "" {
606 return strings.ToLower(p.FullConfig)
607 }
608
609 if p.FullConfig == bazel.ConditionsDefaultConfigKey {
610 return bazel.ConditionsDefaultConfigKey
611 }
612
613 value := p.FullConfig
614 if value == p.Name {
Sam Delmerico0e33c9d2022-01-07 20:39:21 +0000615 value = ""
Jingwen Chen25825ca2021-11-15 12:28:43 +0000616 }
Sam Delmerico0e33c9d2022-01-07 20:39:21 +0000617
618 // e.g. acme__feature1, android__board__soc_a
619 selectKey := strings.ToLower(strings.Join([]string{p.Namespace, p.Name}, "__"))
620 if value != "" {
621 selectKey = strings.ToLower(strings.Join([]string{selectKey, value}, "__"))
622 }
623
624 return selectKey
Jingwen Chen25825ca2021-11-15 12:28:43 +0000625}
626
627// ProductConfigProperties is a map of maps to group property values according
628// their property name and the product config variable they're set under.
629//
630// The outer map key is the name of the property, like "cflags".
631//
632// The inner map key is a ProductConfigProperty, which is a struct of product
633// variable name, namespace, and the "full configuration" of the product
634// variable.
635//
636// e.g. product variable name: board, namespace: acme, full config: vendor_chip_foo
637//
638// The value of the map is the interface{} representing the value of the
639// property, like ["-DDEFINES"] for cflags.
640type ProductConfigProperties map[string]map[ProductConfigProperty]interface{}
Liz Kammera060c452021-03-24 10:14:47 -0400641
642// ProductVariableProperties returns a ProductConfigProperties containing only the properties which
643// have been set for the module in the given context.
Jingwen Chen55bc8202021-11-02 06:40:51 +0000644func ProductVariableProperties(ctx BazelConversionPathContext) ProductConfigProperties {
Liz Kammera060c452021-03-24 10:14:47 -0400645 module := ctx.Module()
646 moduleBase := module.base()
647
648 productConfigProperties := ProductConfigProperties{}
649
Jingwen Chena47f28d2021-11-02 16:43:57 +0000650 if moduleBase.variableProperties != nil {
651 productVariablesProperty := proptools.FieldNameForProperty("product_variables")
652 productVariableValues(
653 productVariablesProperty,
654 moduleBase.variableProperties,
655 "",
656 "",
657 &productConfigProperties)
658
659 for _, configToProps := range moduleBase.GetArchVariantProperties(ctx, moduleBase.variableProperties) {
660 for config, props := range configToProps {
661 // GetArchVariantProperties is creating an instance of the requested type
662 // and productVariablesValues expects an interface, so no need to cast
663 productVariableValues(
664 productVariablesProperty,
665 props,
666 "",
667 config,
668 &productConfigProperties)
669 }
670 }
Liz Kammera060c452021-03-24 10:14:47 -0400671 }
672
Jingwen Chena47f28d2021-11-02 16:43:57 +0000673 if m, ok := module.(Bazelable); ok && m.namespacedVariableProps() != nil {
Jingwen Chen84817de2021-11-17 10:57:35 +0000674 for namespace, namespacedVariableProps := range m.namespacedVariableProps() {
675 for _, namespacedVariableProp := range namespacedVariableProps {
676 productVariableValues(
677 soongconfig.SoongConfigProperty,
678 namespacedVariableProp,
679 namespace,
680 "",
681 &productConfigProperties)
682 }
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -0400683 }
Liz Kammere3e4a5f2021-05-10 11:39:53 -0400684 }
685
Jingwen Chen58ff6802021-11-17 12:14:41 +0000686 productConfigProperties.zeroValuesForNamespacedVariables()
687
Liz Kammere3e4a5f2021-05-10 11:39:53 -0400688 return productConfigProperties
689}
690
Jingwen Chen58ff6802021-11-17 12:14:41 +0000691// zeroValuesForNamespacedVariables ensures that selects that contain __only__
692// conditions default values have zero values set for the other non-default
693// values for that select statement.
694//
695// If the ProductConfigProperties map contains these items, as parsed from the .bp file:
696//
697// library_linking_strategy: {
698// prefer_static: {
699// static_libs: [
700// "lib_a",
701// "lib_b",
702// ],
703// },
704// conditions_default: {
705// shared_libs: [
706// "lib_a",
707// "lib_b",
708// ],
709// },
710// },
711//
712// Static_libs {Library_linking_strategy ANDROID prefer_static} [lib_a lib_b]
713// Shared_libs {Library_linking_strategy ANDROID conditions_default} [lib_a lib_b]
714//
715// We need to add this:
716//
717// Shared_libs {Library_linking_strategy ANDROID prefer_static} []
718//
719// so that the following gets generated for the "dynamic_deps" attribute,
720// instead of putting lib_a and lib_b directly into dynamic_deps without a
721// select:
722//
723// dynamic_deps = select({
724// "//build/bazel/product_variables:android__library_linking_strategy__prefer_static": [],
725// "//conditions:default": [
726// "//foo/bar:lib_a",
727// "//foo/bar:lib_b",
728// ],
729// }),
730func (props *ProductConfigProperties) zeroValuesForNamespacedVariables() {
731 // A map of product config properties to the zero values of their respective
732 // property value.
733 zeroValues := make(map[ProductConfigProperty]interface{})
734
735 // A map of prop names (e.g. cflags) to product config properties where the
736 // (prop name, ProductConfigProperty) tuple contains a non-conditions_default key.
737 //
738 // e.g.
739 //
740 // prefer_static: {
741 // static_libs: [
742 // "lib_a",
743 // "lib_b",
744 // ],
745 // },
746 // conditions_default: {
747 // shared_libs: [
748 // "lib_a",
749 // "lib_b",
750 // ],
751 // },
752 //
753 // The tuple of ("static_libs", prefer_static) would be in this map.
754 hasNonDefaultValue := make(map[string]map[ProductConfigProperty]bool)
755
756 // Iterate over all added soong config variables.
757 for propName, v := range *props {
758 for p, intf := range v {
759 if p.Namespace == "" {
760 // If there's no namespace, this isn't a soong config variable,
761 // i.e. this is a product variable. product variables have no
762 // conditions_defaults, so skip them.
763 continue
764 }
765 if p.FullConfig == bazel.ConditionsDefaultConfigKey {
766 // Skip conditions_defaults.
767 continue
768 }
769 if hasNonDefaultValue[propName] == nil {
770 hasNonDefaultValue[propName] = make(map[ProductConfigProperty]bool)
771 hasNonDefaultValue[propName][p] = false
772 }
773 // Create the zero value of the variable.
774 if _, exists := zeroValues[p]; !exists {
775 zeroValue := reflect.Zero(reflect.ValueOf(intf).Type()).Interface()
776 if zeroValue == nil {
777 panic(fmt.Errorf("Expected non-nil zero value for product/config variable %+v\n", intf))
778 }
779 zeroValues[p] = zeroValue
780 }
781 hasNonDefaultValue[propName][p] = true
782 }
783 }
784
785 for propName := range *props {
786 for p, zeroValue := range zeroValues {
787 // Ignore variables that already have a non-default value for that axis
788 if exists, _ := hasNonDefaultValue[propName][p]; !exists {
789 // fmt.Println(propName, p.Namespace, p.Name, p.FullConfig, zeroValue)
790 // Insert the zero value for this propname + product config value.
791 props.AddProductConfigProperty(
792 propName,
793 p.Namespace,
794 p.Name,
795 p.FullConfig,
796 zeroValue,
797 )
798 }
799 }
800 }
801}
802
Jingwen Chena47f28d2021-11-02 16:43:57 +0000803func (p *ProductConfigProperties) AddProductConfigProperty(
804 propertyName, namespace, productVariableName, config string, property interface{}) {
805 if (*p)[propertyName] == nil {
Jingwen Chen25825ca2021-11-15 12:28:43 +0000806 (*p)[propertyName] = make(map[ProductConfigProperty]interface{})
Jingwen Chena47f28d2021-11-02 16:43:57 +0000807 }
808
Jingwen Chen25825ca2021-11-15 12:28:43 +0000809 productConfigProp := ProductConfigProperty{
810 Namespace: namespace, // e.g. acme, android
811 Name: productVariableName, // e.g. size, feature1, feature2, FEATURE3, board
812 FullConfig: config, // e.g. size, feature1-x86, size__conditions_default
Jingwen Chena47f28d2021-11-02 16:43:57 +0000813 }
Jingwen Chen25825ca2021-11-15 12:28:43 +0000814
Jingwen Chen84817de2021-11-17 10:57:35 +0000815 if existing, ok := (*p)[propertyName][productConfigProp]; ok && namespace != "" {
816 switch dst := existing.(type) {
817 case []string:
818 if src, ok := property.([]string); ok {
819 dst = append(dst, src...)
820 (*p)[propertyName][productConfigProp] = dst
821 }
822 default:
Jingwen Chen58ff6802021-11-17 12:14:41 +0000823 panic(fmt.Errorf("TODO: handle merging value %s", existing))
Jingwen Chen84817de2021-11-17 10:57:35 +0000824 }
825 } else {
826 (*p)[propertyName][productConfigProp] = property
827 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000828}
829
830var (
831 conditionsDefaultField string = proptools.FieldNameForProperty(bazel.ConditionsDefaultConfigKey)
832)
833
834// maybeExtractConfigVarProp attempts to read this value as a config var struct
835// wrapped by interfaces and ptrs. If it's not the right type, the second return
836// value is false.
837func maybeExtractConfigVarProp(v reflect.Value) (reflect.Value, bool) {
838 if v.Kind() == reflect.Interface {
839 // The conditions_default value can be either
840 // 1) an ptr to an interface of a struct (bool config variables and product variables)
841 // 2) an interface of 1) (config variables with nested structs, like string vars)
842 v = v.Elem()
843 }
844 if v.Kind() != reflect.Ptr {
845 return v, false
846 }
847 v = reflect.Indirect(v)
848 if v.Kind() == reflect.Interface {
849 // Extract the struct from the interface
850 v = v.Elem()
851 }
852
853 if !v.IsValid() {
854 return v, false
855 }
856
857 if v.Kind() != reflect.Struct {
858 return v, false
859 }
860 return v, true
861}
862
Jingwen Chen84817de2021-11-17 10:57:35 +0000863func (productConfigProperties *ProductConfigProperties) AddProductConfigProperties(namespace, suffix string, variableValues reflect.Value) {
864 // variableValues can either be a product_variables or
865 // soong_config_variables struct.
866 //
Jingwen Chena47f28d2021-11-02 16:43:57 +0000867 // Example of product_variables:
868 //
869 // product_variables: {
870 // malloc_not_svelte: {
871 // shared_libs: ["malloc_not_svelte_shared_lib"],
872 // whole_static_libs: ["malloc_not_svelte_whole_static_lib"],
873 // exclude_static_libs: [
874 // "malloc_not_svelte_static_lib_excludes",
875 // "malloc_not_svelte_whole_static_lib_excludes",
876 // ],
877 // },
878 // },
879 //
880 // Example of soong_config_variables:
881 //
882 // soong_config_variables: {
883 // feature1: {
884 // conditions_default: {
885 // ...
886 // },
887 // cflags: ...
888 // },
889 // feature2: {
890 // cflags: ...
891 // conditions_default: {
892 // ...
893 // },
894 // },
895 // board: {
896 // soc_a: {
897 // ...
898 // },
899 // soc_a: {
900 // ...
901 // },
902 // soc_c: {},
903 // conditions_default: {
904 // ...
905 // },
906 // },
907 // }
Liz Kammera060c452021-03-24 10:14:47 -0400908 for i := 0; i < variableValues.NumField(); i++ {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000909 // e.g. Platform_sdk_version, Unbundled_build, Malloc_not_svelte, etc.
910 productVariableName := variableValues.Type().Field(i).Name
911
Liz Kammera060c452021-03-24 10:14:47 -0400912 variableValue := variableValues.Field(i)
913 // Check if any properties were set for the module
914 if variableValue.IsZero() {
Jingwen Chena47f28d2021-11-02 16:43:57 +0000915 // e.g. feature1: {}, malloc_not_svelte: {}
Liz Kammera060c452021-03-24 10:14:47 -0400916 continue
917 }
Jingwen Chena47f28d2021-11-02 16:43:57 +0000918
919 // Unlike product variables, config variables require a few more
920 // indirections to extract the struct from the reflect.Value.
921 if v, ok := maybeExtractConfigVarProp(variableValue); ok {
922 variableValue = v
923 }
924
Liz Kammera060c452021-03-24 10:14:47 -0400925 for j := 0; j < variableValue.NumField(); j++ {
926 property := variableValue.Field(j)
927 // If the property wasn't set, no need to pass it along
928 if property.IsZero() {
929 continue
930 }
931
932 // e.g. Asflags, Cflags, Enabled, etc.
933 propertyName := variableValue.Type().Field(j).Name
Jingwen Chena47f28d2021-11-02 16:43:57 +0000934
935 if v, ok := maybeExtractConfigVarProp(property); ok {
936 // The field is a struct, which is used by:
937 // 1) soong_config_string_variables
938 //
939 // soc_a: {
940 // cflags: ...,
941 // }
942 //
943 // soc_b: {
944 // cflags: ...,
945 // }
946 //
947 // 2) conditions_default structs for all soong config variable types.
948 //
949 // conditions_default: {
950 // cflags: ...,
951 // static_libs: ...
952 // }
953 field := v
954 for k := 0; k < field.NumField(); k++ {
955 // Iterate over fields of this struct prop.
956 if field.Field(k).IsZero() {
957 continue
958 }
Jingwen Chen25825ca2021-11-15 12:28:43 +0000959 // config can also be "conditions_default".
960 config := proptools.PropertyNameForField(propertyName)
Jingwen Chena47f28d2021-11-02 16:43:57 +0000961 actualPropertyName := field.Type().Field(k).Name
962
963 productConfigProperties.AddProductConfigProperty(
964 actualPropertyName, // e.g. cflags, static_libs
965 namespace, // e.g. acme, android
966 productVariableName, // e.g. size, feature1, FEATURE2, board
967 config,
968 field.Field(k).Interface(), // e.g. ["-DDEFAULT"], ["foo", "bar"]
969 )
970 }
Jingwen Chen58ff6802021-11-17 12:14:41 +0000971 } else if property.Kind() != reflect.Interface {
972 // If not an interface, then this is not a conditions_default or
973 // a struct prop. That is, this is a regular product variable,
974 // or a bool/value config variable.
Jingwen Chena47f28d2021-11-02 16:43:57 +0000975 config := productVariableName + suffix
Jingwen Chena47f28d2021-11-02 16:43:57 +0000976 productConfigProperties.AddProductConfigProperty(
977 propertyName,
978 namespace,
979 productVariableName,
980 config,
981 property.Interface(),
982 )
Liz Kammer47535c52021-06-02 16:02:22 -0400983 }
Liz Kammera060c452021-03-24 10:14:47 -0400984 }
985 }
Liz Kammera060c452021-03-24 10:14:47 -0400986}
987
Jingwen Chen84817de2021-11-17 10:57:35 +0000988// productVariableValues uses reflection to convert a property struct for
989// product_variables and soong_config_variables to structs that can be generated
990// as select statements.
991func productVariableValues(
992 fieldName string, variableProps interface{}, namespace, suffix string, productConfigProperties *ProductConfigProperties) {
993 if suffix != "" {
994 suffix = "-" + suffix
995 }
996
997 // variableValues represent the product_variables or soong_config_variables struct.
998 variableValues := reflect.ValueOf(variableProps).Elem().FieldByName(fieldName)
999 productConfigProperties.AddProductConfigProperties(namespace, suffix, variableValues)
1000}
1001
Colin Crosseabaedd2020-02-06 17:01:55 -08001002func VariableMutator(mctx BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -07001003 var module Module
Colin Cross7f64b6d2015-07-09 13:57:48 -07001004 var ok bool
Colin Cross635c3b02016-05-18 15:37:25 -07001005 if module, ok = mctx.Module().(Module); !ok {
Colin Cross7f64b6d2015-07-09 13:57:48 -07001006 return
1007 }
1008
1009 // TODO: depend on config variable, create variants, propagate variants up tree
1010 a := module.base()
Colin Cross18c46802019-09-24 22:19:02 -07001011
1012 if a.variableProperties == nil {
1013 return
1014 }
1015
1016 variableValues := reflect.ValueOf(a.variableProperties).Elem().FieldByName("Product_variables")
Colin Cross7f64b6d2015-07-09 13:57:48 -07001017
Colin Cross0cec3122021-01-20 11:27:32 -08001018 productVariables := reflect.ValueOf(mctx.Config().productVariables)
1019
Colin Cross7f64b6d2015-07-09 13:57:48 -07001020 for i := 0; i < variableValues.NumField(); i++ {
1021 variableValue := variableValues.Field(i)
Colin Cross485e5722015-08-27 13:28:01 -07001022 name := variableValues.Type().Field(i).Name
1023 property := "product_variables." + proptools.PropertyNameForField(name)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001024
Colin Crossa6bc19e2015-09-16 13:53:42 -07001025 // Check that the variable was set for the product
Colin Cross0cec3122021-01-20 11:27:32 -08001026 val := productVariables.FieldByName(name)
Colin Crossa6bc19e2015-09-16 13:53:42 -07001027 if !val.IsValid() || val.Kind() != reflect.Ptr || val.IsNil() {
1028 continue
Colin Cross7f64b6d2015-07-09 13:57:48 -07001029 }
Colin Crossa6bc19e2015-09-16 13:53:42 -07001030
1031 val = val.Elem()
1032
1033 // For bools, check that the value is true
1034 if val.Kind() == reflect.Bool && val.Bool() == false {
1035 continue
1036 }
1037
1038 // Check if any properties were set for the module
Colin Cross6961a492020-02-06 16:57:45 -08001039 if variableValue.IsZero() {
Colin Crossa6bc19e2015-09-16 13:53:42 -07001040 continue
1041 }
Colin Crossa6bc19e2015-09-16 13:53:42 -07001042 a.setVariableProperties(mctx, property, variableValue, val.Interface())
Colin Cross7f64b6d2015-07-09 13:57:48 -07001043 }
1044}
1045
Colin Cross4157e882019-06-06 16:57:04 -07001046func (m *ModuleBase) setVariableProperties(ctx BottomUpMutatorContext,
Colin Cross7f64b6d2015-07-09 13:57:48 -07001047 prefix string, productVariablePropertyValue reflect.Value, variableValue interface{}) {
1048
Colin Cross7e0eaf12017-05-05 16:16:24 -07001049 printfIntoProperties(ctx, prefix, productVariablePropertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001050
Usta851a3272022-01-05 23:42:33 -05001051 err := proptools.AppendMatchingProperties(m.GetProperties(),
Colin Cross06a931b2015-10-28 17:23:31 -07001052 productVariablePropertyValue.Addr().Interface(), nil)
1053 if err != nil {
1054 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1055 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1056 } else {
1057 panic(err)
1058 }
1059 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001060}
1061
Colin Cross7e0eaf12017-05-05 16:16:24 -07001062func printfIntoPropertiesError(ctx BottomUpMutatorContext, prefix string,
1063 productVariablePropertyValue reflect.Value, i int, err error) {
1064
1065 field := productVariablePropertyValue.Type().Field(i).Name
1066 property := prefix + "." + proptools.PropertyNameForField(field)
1067 ctx.PropertyErrorf(property, "%s", err)
1068}
1069
1070func printfIntoProperties(ctx BottomUpMutatorContext, prefix string,
1071 productVariablePropertyValue reflect.Value, variableValue interface{}) {
1072
Colin Cross7f64b6d2015-07-09 13:57:48 -07001073 for i := 0; i < productVariablePropertyValue.NumField(); i++ {
1074 propertyValue := productVariablePropertyValue.Field(i)
Colin Crossdd0dbe62015-12-02 15:24:38 -08001075 kind := propertyValue.Kind()
1076 if kind == reflect.Ptr {
1077 if propertyValue.IsNil() {
1078 continue
1079 }
1080 propertyValue = propertyValue.Elem()
1081 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001082 switch propertyValue.Kind() {
1083 case reflect.String:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001084 err := printfIntoProperty(propertyValue, variableValue)
1085 if err != nil {
1086 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
1087 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001088 case reflect.Slice:
1089 for j := 0; j < propertyValue.Len(); j++ {
Colin Cross7e0eaf12017-05-05 16:16:24 -07001090 err := printfIntoProperty(propertyValue.Index(j), variableValue)
1091 if err != nil {
1092 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
1093 }
Colin Cross7f64b6d2015-07-09 13:57:48 -07001094 }
Colin Crossdd0dbe62015-12-02 15:24:38 -08001095 case reflect.Bool:
1096 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -07001097 case reflect.Struct:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001098 printfIntoProperties(ctx, prefix, propertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001099 default:
1100 panic(fmt.Errorf("unsupported field kind %q", propertyValue.Kind()))
1101 }
1102 }
1103}
1104
Colin Cross7e0eaf12017-05-05 16:16:24 -07001105func printfIntoProperty(propertyValue reflect.Value, variableValue interface{}) error {
Colin Cross7f64b6d2015-07-09 13:57:48 -07001106 s := propertyValue.String()
Colin Cross7e0eaf12017-05-05 16:16:24 -07001107
1108 count := strings.Count(s, "%")
1109 if count == 0 {
1110 return nil
1111 }
1112
1113 if count > 1 {
1114 return fmt.Errorf("product variable properties only support a single '%%'")
1115 }
1116
Colin Cross7f64b6d2015-07-09 13:57:48 -07001117 if strings.Contains(s, "%d") {
1118 switch v := variableValue.(type) {
1119 case int:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001120 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -07001121 case bool:
1122 if v {
Colin Cross7e0eaf12017-05-05 16:16:24 -07001123 variableValue = 1
1124 } else {
1125 variableValue = 0
Colin Cross7f64b6d2015-07-09 13:57:48 -07001126 }
1127 default:
Colin Cross7e0eaf12017-05-05 16:16:24 -07001128 return fmt.Errorf("unsupported type %T for %%d", variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -07001129 }
Colin Cross7e0eaf12017-05-05 16:16:24 -07001130 } else if strings.Contains(s, "%s") {
1131 switch variableValue.(type) {
1132 case string:
1133 // Nothing
1134 default:
1135 return fmt.Errorf("unsupported type %T for %%s", variableValue)
1136 }
1137 } else {
1138 return fmt.Errorf("unsupported %% in product variable property")
Colin Cross7f64b6d2015-07-09 13:57:48 -07001139 }
Colin Cross7e0eaf12017-05-05 16:16:24 -07001140
1141 propertyValue.Set(reflect.ValueOf(fmt.Sprintf(s, variableValue)))
1142
1143 return nil
Colin Cross7f64b6d2015-07-09 13:57:48 -07001144}
Colin Cross18c46802019-09-24 22:19:02 -07001145
1146var variablePropTypeMap OncePer
1147
1148// sliceToTypeArray takes a slice of property structs and returns a reflection created array containing the
1149// reflect.Types of each property struct. The result can be used as a key in a map.
1150func sliceToTypeArray(s []interface{}) interface{} {
1151 // Create an array using reflection whose length is the length of the input slice
1152 ret := reflect.New(reflect.ArrayOf(len(s), reflect.TypeOf(reflect.TypeOf(0)))).Elem()
1153 for i, e := range s {
1154 ret.Index(i).Set(reflect.ValueOf(reflect.TypeOf(e)))
1155 }
1156 return ret.Interface()
1157}
1158
Colin Crosseabaedd2020-02-06 17:01:55 -08001159func initProductVariableModule(m Module) {
1160 base := m.base()
1161
1162 // Allow tests to override the default product variables
1163 if base.variableProperties == nil {
1164 base.variableProperties = defaultProductVariables
1165 }
1166 // Filter the product variables properties to the ones that exist on this module
1167 base.variableProperties = createVariableProperties(m.GetProperties(), base.variableProperties)
1168 if base.variableProperties != nil {
1169 m.AddProperties(base.variableProperties)
1170 }
1171}
1172
Colin Cross18c46802019-09-24 22:19:02 -07001173// createVariableProperties takes the list of property structs for a module and returns a property struct that
1174// contains the product variable properties that exist in the property structs, or nil if there are none. It
1175// caches the result.
1176func createVariableProperties(moduleTypeProps []interface{}, productVariables interface{}) interface{} {
1177 // Convert the moduleTypeProps to an array of reflect.Types that can be used as a key in the OncePer.
1178 key := sliceToTypeArray(moduleTypeProps)
1179
1180 // Use the variablePropTypeMap OncePer to cache the result for each set of property struct types.
1181 typ, _ := variablePropTypeMap.Once(NewCustomOnceKey(key), func() interface{} {
1182 // Compute the filtered property struct type.
1183 return createVariablePropertiesType(moduleTypeProps, productVariables)
1184 }).(reflect.Type)
1185
1186 if typ == nil {
1187 return nil
1188 }
1189
1190 // Create a new pointer to a filtered property struct.
1191 return reflect.New(typ).Interface()
1192}
1193
1194// createVariablePropertiesType creates a new type that contains only the product variable properties that exist in
1195// a list of property structs.
1196func createVariablePropertiesType(moduleTypeProps []interface{}, productVariables interface{}) reflect.Type {
1197 typ, _ := proptools.FilterPropertyStruct(reflect.TypeOf(productVariables),
1198 func(field reflect.StructField, prefix string) (bool, reflect.StructField) {
1199 // Filter function, returns true if the field should be in the resulting struct
1200 if prefix == "" {
1201 // Keep the top level Product_variables field
1202 return true, field
1203 }
1204 _, rest := splitPrefix(prefix)
1205 if rest == "" {
1206 // Keep the 2nd level field (i.e. Product_variables.Eng)
1207 return true, field
1208 }
1209
1210 // Strip off the first 2 levels of the prefix
1211 _, prefix = splitPrefix(rest)
1212
1213 for _, p := range moduleTypeProps {
1214 if fieldExistsByNameRecursive(reflect.TypeOf(p).Elem(), prefix, field.Name) {
1215 // Keep any fields that exist in one of the property structs
1216 return true, field
1217 }
1218 }
1219
1220 return false, field
1221 })
1222 return typ
1223}
1224
1225func splitPrefix(prefix string) (first, rest string) {
1226 index := strings.IndexByte(prefix, '.')
1227 if index == -1 {
1228 return prefix, ""
1229 }
1230 return prefix[:index], prefix[index+1:]
1231}
1232
1233func fieldExistsByNameRecursive(t reflect.Type, prefix, name string) bool {
1234 if t.Kind() != reflect.Struct {
1235 panic(fmt.Errorf("fieldExistsByNameRecursive can only be called on a reflect.Struct"))
1236 }
1237
1238 if prefix != "" {
1239 split := strings.SplitN(prefix, ".", 2)
1240 firstPrefix := split[0]
1241 rest := ""
1242 if len(split) > 1 {
1243 rest = split[1]
1244 }
1245 f, exists := t.FieldByName(firstPrefix)
1246 if !exists {
1247 return false
1248 }
1249 ft := f.Type
1250 if ft.Kind() == reflect.Ptr {
1251 ft = ft.Elem()
1252 }
1253 if ft.Kind() != reflect.Struct {
1254 panic(fmt.Errorf("field %q in %q is not a struct", firstPrefix, t))
1255 }
1256 return fieldExistsByNameRecursive(ft, rest, name)
1257 } else {
1258 _, exists := t.FieldByName(name)
1259 return exists
1260 }
1261}