blob: 382a7dfd0cdc1df54690844f0c260b16d5c3ea30 [file] [log] [blame]
Colin Cross3f40fa42015-01-30 17:27:36 -08001// 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 Cross3f40fa42015-01-30 17:27:36 -080016
17import (
Colin Cross74ba9622019-02-11 15:11:14 -080018 "encoding"
Colin Cross3f40fa42015-01-30 17:27:36 -080019 "fmt"
20 "reflect"
21 "runtime"
22 "strings"
Colin Crossf6566ed2015-03-24 11:13:38 -070023
Colin Crosscb0ac952021-07-20 13:17:15 -070024 "android/soong/bazel"
Liz Kammere8303bd2022-02-16 09:02:48 -050025 "android/soong/starlark_fmt"
Colin Crosscb0ac952021-07-20 13:17:15 -070026
Colin Cross0f7d2ef2019-10-16 11:03:10 -070027 "github.com/google/blueprint"
Colin Cross617b88a2020-08-24 18:04:09 -070028 "github.com/google/blueprint/bootstrap"
Colin Crossf6566ed2015-03-24 11:13:38 -070029 "github.com/google/blueprint/proptools"
Colin Cross3f40fa42015-01-30 17:27:36 -080030)
31
Colin Cross3f40fa42015-01-30 17:27:36 -080032/*
33Example blueprints file containing all variant property groups, with comment listing what type
34of variants get properties in that group:
35
36module {
37 arch: {
38 arm: {
39 // Host or device variants with arm architecture
40 },
41 arm64: {
42 // Host or device variants with arm64 architecture
43 },
Colin Cross3f40fa42015-01-30 17:27:36 -080044 x86: {
45 // Host or device variants with x86 architecture
46 },
47 x86_64: {
48 // Host or device variants with x86_64 architecture
49 },
50 },
51 multilib: {
52 lib32: {
53 // Host or device variants for 32-bit architectures
54 },
55 lib64: {
56 // Host or device variants for 64-bit architectures
57 },
58 },
59 target: {
60 android: {
Martin Stjernholme284b482020-09-23 21:03:27 +010061 // Device variants (implies Bionic)
Colin Cross3f40fa42015-01-30 17:27:36 -080062 },
63 host: {
64 // Host variants
65 },
Martin Stjernholme284b482020-09-23 21:03:27 +010066 bionic: {
67 // Bionic (device and host) variants
68 },
69 linux_bionic: {
70 // Bionic host variants
71 },
72 linux: {
73 // Bionic (device and host) and Linux glibc variants
74 },
Dan Willemsen5746bd42017-10-02 19:42:01 -070075 linux_glibc: {
Martin Stjernholme284b482020-09-23 21:03:27 +010076 // Linux host variants (using non-Bionic libc)
Colin Cross3f40fa42015-01-30 17:27:36 -080077 },
78 darwin: {
79 // Darwin host variants
80 },
81 windows: {
82 // Windows host variants
83 },
84 not_windows: {
85 // Non-windows host variants
86 },
Martin Stjernholme284b482020-09-23 21:03:27 +010087 android_arm: {
88 // Any <os>_<arch> combination restricts to that os and arch
89 },
Colin Cross3f40fa42015-01-30 17:27:36 -080090 },
91}
92*/
Colin Cross7d5136f2015-05-11 13:39:40 -070093
Colin Cross3f40fa42015-01-30 17:27:36 -080094// An Arch indicates a single CPU architecture.
95type Arch struct {
Colin Crossa6845402020-11-16 15:08:19 -080096 // The type of the architecture (arm, arm64, x86, or x86_64).
97 ArchType ArchType
98
99 // The variant of the architecture, for example "armv7-a" or "armv7-a-neon" for arm.
100 ArchVariant string
101
102 // The variant of the CPU, for example "cortex-a53" for arm64.
103 CpuVariant string
104
105 // The list of Android app ABIs supported by the CPU architecture, for example "arm64-v8a".
106 Abi []string
107
108 // The list of arch-specific features supported by the CPU architecture, for example "neon".
Colin Crossc5c24ad2015-11-20 15:35:00 -0800109 ArchFeatures []string
Colin Cross3f40fa42015-01-30 17:27:36 -0800110}
111
Colin Crossa6845402020-11-16 15:08:19 -0800112// String returns the Arch as a string. The value is used as the name of the variant created
113// by archMutator.
Colin Cross3f40fa42015-01-30 17:27:36 -0800114func (a Arch) String() string {
Colin Crossd3ba0392015-05-07 14:11:29 -0700115 s := a.ArchType.String()
Colin Cross3f40fa42015-01-30 17:27:36 -0800116 if a.ArchVariant != "" {
117 s += "_" + a.ArchVariant
118 }
119 if a.CpuVariant != "" {
120 s += "_" + a.CpuVariant
121 }
122 return s
123}
124
Colin Crossa6845402020-11-16 15:08:19 -0800125// ArchType is used to define the 4 supported architecture types (arm, arm64, x86, x86_64), as
126// well as the "common" architecture used for modules that support multiple architectures, for
127// example Java modules.
Colin Cross3f40fa42015-01-30 17:27:36 -0800128type ArchType struct {
Colin Crossa6845402020-11-16 15:08:19 -0800129 // Name is the name of the architecture type, "arm", "arm64", "x86", or "x86_64".
130 Name string
131
132 // Field is the name of the field used in properties that refer to the architecture, e.g. "Arm64".
133 Field string
134
135 // Multilib is either "lib32" or "lib64" for 32-bit or 64-bit architectures.
Colin Crossec193632015-07-06 17:49:43 -0700136 Multilib string
Colin Cross3f40fa42015-01-30 17:27:36 -0800137}
138
Colin Crossa6845402020-11-16 15:08:19 -0800139// String returns the name of the ArchType.
140func (a ArchType) String() string {
141 return a.Name
142}
143
144const COMMON_VARIANT = "common"
145
146var (
147 archTypeList []ArchType
148
149 Arm = newArch("arm", "lib32")
150 Arm64 = newArch("arm64", "lib64")
151 X86 = newArch("x86", "lib32")
152 X86_64 = newArch("x86_64", "lib64")
153
154 Common = ArchType{
155 Name: COMMON_VARIANT,
156 }
157)
158
159var archTypeMap = map[string]ArchType{}
160
Colin Crossec193632015-07-06 17:49:43 -0700161func newArch(name, multilib string) ArchType {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700162 archType := ArchType{
Colin Crossec193632015-07-06 17:49:43 -0700163 Name: name,
Dan Willemsenb1957a52016-06-23 23:44:54 -0700164 Field: proptools.FieldNameForProperty(name),
Colin Crossec193632015-07-06 17:49:43 -0700165 Multilib: multilib,
Colin Cross3f40fa42015-01-30 17:27:36 -0800166 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700167 archTypeList = append(archTypeList, archType)
Colin Crossa6845402020-11-16 15:08:19 -0800168 archTypeMap[name] = archType
Dan Willemsenb1957a52016-06-23 23:44:54 -0700169 return archType
Colin Cross3f40fa42015-01-30 17:27:36 -0800170}
171
Ustaeabf0f32021-12-06 15:17:23 -0500172// ArchTypeList returns a slice copy of the 4 supported ArchTypes for arm,
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000173// arm64, x86 and x86_64.
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700174func ArchTypeList() []ArchType {
175 return append([]ArchType(nil), archTypeList...)
176}
177
Colin Crossa6845402020-11-16 15:08:19 -0800178// MarshalText allows an ArchType to be serialized through any encoder that supports
179// encoding.TextMarshaler.
Colin Cross74ba9622019-02-11 15:11:14 -0800180func (a ArchType) MarshalText() ([]byte, error) {
Jeongik Chabec4d032021-04-15 08:55:38 +0900181 return []byte(a.String()), nil
Colin Cross74ba9622019-02-11 15:11:14 -0800182}
183
Colin Crossa6845402020-11-16 15:08:19 -0800184var _ encoding.TextMarshaler = ArchType{}
Colin Cross74ba9622019-02-11 15:11:14 -0800185
Colin Crossa6845402020-11-16 15:08:19 -0800186// UnmarshalText allows an ArchType to be deserialized through any decoder that supports
187// encoding.TextUnmarshaler.
Colin Cross74ba9622019-02-11 15:11:14 -0800188func (a *ArchType) UnmarshalText(text []byte) error {
189 if u, ok := archTypeMap[string(text)]; ok {
190 *a = u
191 return nil
192 }
193
194 return fmt.Errorf("unknown ArchType %q", text)
195}
196
Colin Crossa6845402020-11-16 15:08:19 -0800197var _ encoding.TextUnmarshaler = &ArchType{}
Colin Crossa1ad8d12016-06-01 17:09:44 -0700198
Colin Crossa6845402020-11-16 15:08:19 -0800199// OsClass is an enum that describes whether a variant of a module runs on the host, on the device,
200// or is generic.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700201type OsClass int
202
203const (
Colin Crossa6845402020-11-16 15:08:19 -0800204 // Generic is used for variants of modules that are not OS-specific.
Dan Willemsen0e2d97b2016-11-28 17:50:06 -0800205 Generic OsClass = iota
Colin Crossa6845402020-11-16 15:08:19 -0800206 // Device is used for variants of modules that run on the device.
Dan Willemsen0e2d97b2016-11-28 17:50:06 -0800207 Device
Colin Crossa6845402020-11-16 15:08:19 -0800208 // Host is used for variants of modules that run on the host.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700209 Host
Colin Crossa1ad8d12016-06-01 17:09:44 -0700210)
211
Colin Crossa6845402020-11-16 15:08:19 -0800212// String returns the OsClass as a string.
Colin Cross67a5c132017-05-09 13:45:28 -0700213func (class OsClass) String() string {
214 switch class {
215 case Generic:
216 return "generic"
217 case Device:
218 return "device"
219 case Host:
220 return "host"
Colin Cross67a5c132017-05-09 13:45:28 -0700221 default:
222 panic(fmt.Errorf("unknown class %d", class))
223 }
224}
225
Colin Crossa6845402020-11-16 15:08:19 -0800226// OsType describes an OS variant of a module.
227type OsType struct {
228 // Name is the name of the OS. It is also used as the name of the property in Android.bp
229 // files.
230 Name string
231
232 // Field is the name of the OS converted to an exported field name, i.e. with the first
233 // character capitalized.
234 Field string
235
236 // Class is the OsClass of the OS.
237 Class OsClass
238
239 // DefaultDisabled is set when the module variants for the OS should not be created unless
240 // the module explicitly requests them. This is used to limit Windows cross compilation to
241 // only modules that need it.
242 DefaultDisabled bool
243}
244
245// String returns the name of the OsType.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700246func (os OsType) String() string {
247 return os.Name
Colin Cross54c71122016-06-01 17:09:44 -0700248}
249
Colin Crossa6845402020-11-16 15:08:19 -0800250// Bionic returns true if the OS uses the Bionic libc runtime, i.e. if the OS is Android or
251// is Linux with Bionic.
Dan Willemsen866b5632017-09-22 12:28:24 -0700252func (os OsType) Bionic() bool {
253 return os == Android || os == LinuxBionic
254}
255
Colin Crossa6845402020-11-16 15:08:19 -0800256// Linux returns true if the OS uses the Linux kernel, i.e. if the OS is Android or is Linux
257// with or without the Bionic libc runtime.
Dan Willemsen866b5632017-09-22 12:28:24 -0700258func (os OsType) Linux() bool {
Colin Cross528d67e2021-07-23 22:23:07 +0000259 return os == Android || os == Linux || os == LinuxBionic || os == LinuxMusl
Dan Willemsen866b5632017-09-22 12:28:24 -0700260}
261
Colin Crossa6845402020-11-16 15:08:19 -0800262// newOsType constructs an OsType and adds it to the global lists.
263func newOsType(name string, class OsClass, defDisabled bool, archTypes ...ArchType) OsType {
264 checkCalledFromInit()
Colin Crossa1ad8d12016-06-01 17:09:44 -0700265 os := OsType{
266 Name: name,
Colin Crossa6845402020-11-16 15:08:19 -0800267 Field: proptools.FieldNameForProperty(name),
Colin Crossa1ad8d12016-06-01 17:09:44 -0700268 Class: class,
Dan Willemsen0a37a2a2016-11-13 10:16:05 -0800269
270 DefaultDisabled: defDisabled,
Colin Cross54c71122016-06-01 17:09:44 -0700271 }
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000272 osTypeList = append(osTypeList, os)
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800273
274 if _, found := commonTargetMap[name]; found {
275 panic(fmt.Errorf("Found Os type duplicate during OsType registration: %q", name))
276 } else {
Colin Crosse9fe2942020-11-10 18:12:15 -0800277 commonTargetMap[name] = Target{Os: os, Arch: CommonArch}
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800278 }
Colin Crossa6845402020-11-16 15:08:19 -0800279 osArchTypeMap[os] = archTypes
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800280
Colin Crossa1ad8d12016-06-01 17:09:44 -0700281 return os
282}
283
Colin Crossa6845402020-11-16 15:08:19 -0800284// osByName returns the OsType that has the given name, or NoOsType if none match.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700285func osByName(name string) OsType {
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000286 for _, os := range osTypeList {
Colin Crossa1ad8d12016-06-01 17:09:44 -0700287 if os.Name == name {
288 return os
289 }
290 }
291
292 return NoOsType
Dan Willemsen490fd492015-11-24 17:53:15 -0800293}
294
Colin Crossa6845402020-11-16 15:08:19 -0800295var (
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000296 // osTypeList contains a list of all the supported OsTypes, including ones not supported
Colin Crossa6845402020-11-16 15:08:19 -0800297 // by the current build host or the target device.
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000298 osTypeList []OsType
Colin Crossa6845402020-11-16 15:08:19 -0800299 // commonTargetMap maps names of OsTypes to the corresponding common Target, i.e. the
300 // Target with the same OsType and the common ArchType.
301 commonTargetMap = make(map[string]Target)
302 // osArchTypeMap maps OsTypes to the list of supported ArchTypes for that OS.
303 osArchTypeMap = map[OsType][]ArchType{}
304
305 // NoOsType is a placeholder for when no OS is needed.
306 NoOsType OsType
307 // Linux is the OS for the Linux kernel plus the glibc runtime.
308 Linux = newOsType("linux_glibc", Host, false, X86, X86_64)
Colin Cross528d67e2021-07-23 22:23:07 +0000309 // LinuxMusl is the OS for the Linux kernel plus the musl runtime.
Colin Crossa9b2aac2022-06-15 17:25:51 -0700310 LinuxMusl = newOsType("linux_musl", Host, false, X86, X86_64, Arm64, Arm)
Colin Crossa6845402020-11-16 15:08:19 -0800311 // Darwin is the OS for MacOS/Darwin host machines.
Dan Willemsen8528f4e2021-10-19 00:22:06 -0700312 Darwin = newOsType("darwin", Host, false, Arm64, X86_64)
Colin Crossa6845402020-11-16 15:08:19 -0800313 // LinuxBionic is the OS for the Linux kernel plus the Bionic libc runtime, but without the
314 // rest of Android.
315 LinuxBionic = newOsType("linux_bionic", Host, false, Arm64, X86_64)
316 // Windows the OS for Windows host machines.
317 Windows = newOsType("windows", Host, true, X86, X86_64)
318 // Android is the OS for target devices that run all of Android, including the Linux kernel
319 // and the Bionic libc runtime.
320 Android = newOsType("android", Device, false, Arm, Arm64, X86, X86_64)
Colin Crossa6845402020-11-16 15:08:19 -0800321
322 // CommonOS is a pseudo OSType for a common OS variant, which is OsType agnostic and which
323 // has dependencies on all the OS variants.
324 CommonOS = newOsType("common_os", Generic, false)
Colin Crosse9fe2942020-11-10 18:12:15 -0800325
326 // CommonArch is the Arch for all modules that are os-specific but not arch specific,
327 // for example most Java modules.
328 CommonArch = Arch{ArchType: Common}
dimitry1f33e402019-03-26 12:39:31 +0100329)
330
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000331// OsTypeList returns a slice copy of the supported OsTypes.
332func OsTypeList() []OsType {
333 return append([]OsType(nil), osTypeList...)
334}
335
Colin Crossa6845402020-11-16 15:08:19 -0800336// Target specifies the OS and architecture that a module is being compiled for.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700337type Target struct {
Colin Crossa6845402020-11-16 15:08:19 -0800338 // Os the OS that the module is being compiled for (e.g. "linux_glibc", "android").
339 Os OsType
340 // Arch is the architecture that the module is being compiled for.
341 Arch Arch
342 // NativeBridge is NativeBridgeEnabled if the architecture is supported using NativeBridge
343 // (i.e. arm on x86) for this device.
344 NativeBridge NativeBridgeSupport
345 // NativeBridgeHostArchName is the name of the real architecture that is used to implement
346 // the NativeBridge architecture. For example, for arm on x86 this would be "x86".
dimitry8d6dde82019-07-11 10:23:53 +0200347 NativeBridgeHostArchName string
Colin Crossa6845402020-11-16 15:08:19 -0800348 // NativeBridgeRelativePath is the name of the subdirectory that will contain NativeBridge
349 // libraries and binaries.
dimitry8d6dde82019-07-11 10:23:53 +0200350 NativeBridgeRelativePath string
Jiyong Park1613e552020-09-14 19:43:17 +0900351
352 // HostCross is true when the target cannot run natively on the current build host.
353 // For example, linux_glibc_x86 returns true on a regular x86/i686/Linux machines, but returns false
354 // on Mac (different OS), or on 64-bit only i686/Linux machines (unsupported arch).
355 HostCross bool
Colin Crossd3ba0392015-05-07 14:11:29 -0700356}
357
Colin Crossa6845402020-11-16 15:08:19 -0800358// NativeBridgeSupport is an enum that specifies if a Target supports NativeBridge.
359type NativeBridgeSupport bool
360
361const (
362 NativeBridgeDisabled NativeBridgeSupport = false
363 NativeBridgeEnabled NativeBridgeSupport = true
364)
365
366// String returns the OS and arch variations used for the Target.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700367func (target Target) String() string {
Colin Crossa195f912019-10-16 11:07:20 -0700368 return target.OsVariation() + "_" + target.ArchVariation()
369}
370
Colin Crossa6845402020-11-16 15:08:19 -0800371// OsVariation returns the name of the variation used by the osMutator for the Target.
Colin Crossa195f912019-10-16 11:07:20 -0700372func (target Target) OsVariation() string {
373 return target.Os.String()
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700374}
375
Colin Crossa6845402020-11-16 15:08:19 -0800376// ArchVariation returns the name of the variation used by the archMutator for the Target.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700377func (target Target) ArchVariation() string {
378 var variation string
dimitry1f33e402019-03-26 12:39:31 +0100379 if target.NativeBridge {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700380 variation = "native_bridge_"
dimitry1f33e402019-03-26 12:39:31 +0100381 }
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700382 variation += target.Arch.String()
383
Colin Crossa195f912019-10-16 11:07:20 -0700384 return variation
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700385}
386
Colin Crossa6845402020-11-16 15:08:19 -0800387// Variations returns a list of blueprint.Variations for the osMutator and archMutator for the
388// Target.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700389func (target Target) Variations() []blueprint.Variation {
390 return []blueprint.Variation{
Colin Crossa195f912019-10-16 11:07:20 -0700391 {Mutator: "os", Variation: target.OsVariation()},
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700392 {Mutator: "arch", Variation: target.ArchVariation()},
393 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800394}
395
Liz Kammer4562a3b2021-04-21 18:15:34 -0400396func registerBp2buildArchPathDepsMutator(ctx RegisterMutatorsContext) {
397 ctx.BottomUp("bp2build-arch-pathdeps", bp2buildArchPathDepsMutator).Parallel()
398}
399
400// add dependencies for architecture specific properties tagged with `android:"path"`
401func bp2buildArchPathDepsMutator(ctx BottomUpMutatorContext) {
402 var module Module
403 module = ctx.Module()
404
405 m := module.base()
406 if !m.ArchSpecific() {
407 return
408 }
409
410 // addPathDepsForProps does not descend into sub structs, so we need to descend into the
411 // arch-specific properties ourselves
Ustaeabf0f32021-12-06 15:17:23 -0500412 var properties []interface{}
Liz Kammer4562a3b2021-04-21 18:15:34 -0400413 for _, archProperties := range m.archProperties {
414 for _, archProps := range archProperties {
415 archPropValues := reflect.ValueOf(archProps).Elem()
416 // there are three "arch" variations, descend into each
417 for _, variant := range []string{"Arch", "Multilib", "Target"} {
418 // The properties are an interface, get the value (a pointer) that it points to
419 archProps := archPropValues.FieldByName(variant).Elem()
420 if archProps.IsNil() {
421 continue
422 }
423 // And then a pointer to a struct
424 archProps = archProps.Elem()
425 for i := 0; i < archProps.NumField(); i += 1 {
426 f := archProps.Field(i)
427 // If the value of the field is a struct (as opposed to a pointer to a struct) then step
428 // into the BlueprintEmbed field.
429 if f.Kind() == reflect.Struct {
430 f = f.FieldByName("BlueprintEmbed")
431 }
432 if f.IsZero() {
433 continue
434 }
435 props := f.Interface().(interface{})
436 properties = append(properties, props)
437 }
438 }
439 }
440 }
441 addPathDepsForProps(ctx, properties)
442}
443
Colin Crossa6845402020-11-16 15:08:19 -0800444// osMutator splits an arch-specific module into a variant for each OS that is enabled for the
445// module. It uses the HostOrDevice value passed to InitAndroidArchModule and the
446// device_supported and host_supported properties to determine which OsTypes are enabled for this
447// module, then searches through the Targets to determine which have enabled Targets for this
448// module.
Colin Cross617b88a2020-08-24 18:04:09 -0700449func osMutator(bpctx blueprint.BottomUpMutatorContext) {
Colin Crossa195f912019-10-16 11:07:20 -0700450 var module Module
451 var ok bool
Colin Cross617b88a2020-08-24 18:04:09 -0700452 if module, ok = bpctx.Module().(Module); !ok {
Colin Crossa6845402020-11-16 15:08:19 -0800453 // The module is not a Soong module, it is a Blueprint module.
Colin Cross617b88a2020-08-24 18:04:09 -0700454 if bootstrap.IsBootstrapModule(bpctx.Module()) {
455 // Bootstrap Go modules are always the build OS or linux bionic.
456 config := bpctx.Config().(Config)
457 osNames := []string{config.BuildOSTarget.OsVariation()}
458 for _, hostCrossTarget := range config.Targets[LinuxBionic] {
459 if hostCrossTarget.Arch.ArchType == config.BuildOSTarget.Arch.ArchType {
460 osNames = append(osNames, hostCrossTarget.OsVariation())
461 }
462 }
463 osNames = FirstUniqueStrings(osNames)
464 bpctx.CreateVariations(osNames...)
465 }
Colin Crossa195f912019-10-16 11:07:20 -0700466 return
467 }
468
Colin Cross617b88a2020-08-24 18:04:09 -0700469 // Bootstrap Go module support above requires this mutator to be a
470 // blueprint.BottomUpMutatorContext because android.BottomUpMutatorContext
471 // filters out non-Soong modules. Now that we've handled them, create a
472 // normal android.BottomUpMutatorContext.
Liz Kammer356f7d42021-01-26 09:18:53 -0500473 mctx := bottomUpMutatorContextFactory(bpctx, module, false, false)
Colin Cross617b88a2020-08-24 18:04:09 -0700474
Colin Crossa195f912019-10-16 11:07:20 -0700475 base := module.base()
476
Colin Crossa6845402020-11-16 15:08:19 -0800477 // Nothing to do for modules that are not architecture specific (e.g. a genrule).
Colin Crossa195f912019-10-16 11:07:20 -0700478 if !base.ArchSpecific() {
479 return
480 }
481
Colin Crossa6845402020-11-16 15:08:19 -0800482 // Collect a list of OSTypes supported by this module based on the HostOrDevice value
483 // passed to InitAndroidArchModule and the device_supported and host_supported properties.
Colin Crossa195f912019-10-16 11:07:20 -0700484 var moduleOSList []OsType
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000485 for _, os := range osTypeList {
Jiyong Park1613e552020-09-14 19:43:17 +0900486 for _, t := range mctx.Config().Targets[os] {
Colin Cross08d6f8f2020-11-19 02:33:19 +0000487 if base.supportsTarget(t) {
Jiyong Park1613e552020-09-14 19:43:17 +0900488 moduleOSList = append(moduleOSList, os)
489 break
Colin Crossa195f912019-10-16 11:07:20 -0700490 }
491 }
Colin Crossa195f912019-10-16 11:07:20 -0700492 }
493
Colin Crossa6845402020-11-16 15:08:19 -0800494 // If there are no supported OSes then disable the module.
Colin Crossa195f912019-10-16 11:07:20 -0700495 if len(moduleOSList) == 0 {
Inseob Kimeec88e12020-01-22 11:11:29 +0900496 base.Disable()
Colin Crossa195f912019-10-16 11:07:20 -0700497 return
498 }
499
Colin Crossa6845402020-11-16 15:08:19 -0800500 // Convert the list of supported OsTypes to the variation names.
Colin Crossa195f912019-10-16 11:07:20 -0700501 osNames := make([]string, len(moduleOSList))
Colin Crossa195f912019-10-16 11:07:20 -0700502 for i, os := range moduleOSList {
503 osNames[i] = os.String()
504 }
505
Paul Duffin1356d8c2020-02-25 19:26:33 +0000506 createCommonOSVariant := base.commonProperties.CreateCommonOSVariant
507 if createCommonOSVariant {
Colin Crossa6845402020-11-16 15:08:19 -0800508 // A CommonOS variant was requested so add it to the list of OS variants to
Paul Duffin1356d8c2020-02-25 19:26:33 +0000509 // create. It needs to be added to the end because it needs to depend on the
510 // the other variants in the list returned by CreateVariations(...) and inter
511 // variant dependencies can only be created from a later variant in that list to
512 // an earlier one. That is because variants are always processed in the order in
513 // which they are returned from CreateVariations(...).
514 osNames = append(osNames, CommonOS.Name)
515 moduleOSList = append(moduleOSList, CommonOS)
Colin Crossa195f912019-10-16 11:07:20 -0700516 }
517
Colin Crossa6845402020-11-16 15:08:19 -0800518 // Create the variations, annotate each one with which OS it was created for, and
519 // squash the appropriate OS-specific properties into the top level properties.
Paul Duffin1356d8c2020-02-25 19:26:33 +0000520 modules := mctx.CreateVariations(osNames...)
521 for i, m := range modules {
522 m.base().commonProperties.CompileOS = moduleOSList[i]
523 m.base().setOSProperties(mctx)
524 }
525
526 if createCommonOSVariant {
527 // A CommonOS variant was requested so add dependencies from it (the last one in
528 // the list) to the OS type specific variants.
529 last := len(modules) - 1
530 commonOSVariant := modules[last]
531 commonOSVariant.base().commonProperties.CommonOSVariant = true
532 for _, module := range modules[0:last] {
533 // Ignore modules that are enabled. Note, this will only avoid adding
534 // dependencies on OsType variants that are explicitly disabled in their
535 // properties. The CommonOS variant will still depend on disabled variants
536 // if they are disabled afterwards, e.g. in archMutator if
537 if module.Enabled() {
538 mctx.AddInterVariantDependency(commonOsToOsSpecificVariantTag, commonOSVariant, module)
539 }
540 }
541 }
542}
543
Colin Crossc179ea62020-10-09 10:54:15 -0700544type archDepTag struct {
545 blueprint.BaseDependencyTag
546 name string
547}
Paul Duffin1356d8c2020-02-25 19:26:33 +0000548
Colin Crossc179ea62020-10-09 10:54:15 -0700549// Identifies the dependency from CommonOS variant to the os specific variants.
550var commonOsToOsSpecificVariantTag = archDepTag{name: "common os to os specific"}
551
Paul Duffin1356d8c2020-02-25 19:26:33 +0000552// Get the OsType specific variants for the current CommonOS variant.
553//
554// The returned list will only contain enabled OsType specific variants of the
555// module referenced in the supplied context. An empty list is returned if there
556// are no enabled variants or the supplied context is not for an CommonOS
557// variant.
558func GetOsSpecificVariantsOfCommonOSVariant(mctx BaseModuleContext) []Module {
559 var variants []Module
560 mctx.VisitDirectDeps(func(m Module) {
561 if mctx.OtherModuleDependencyTag(m) == commonOsToOsSpecificVariantTag {
562 if m.Enabled() {
563 variants = append(variants, m)
564 }
565 }
566 })
Paul Duffin1356d8c2020-02-25 19:26:33 +0000567 return variants
Colin Crossa195f912019-10-16 11:07:20 -0700568}
569
Dan Willemsen47450072021-10-19 20:24:49 -0700570var DarwinUniversalVariantTag = archDepTag{name: "darwin universal binary"}
571
Colin Crossee0bc3b2018-10-02 22:01:37 -0700572// archMutator splits a module into a variant for each Target requested by the module. Target selection
Colin Crossa6845402020-11-16 15:08:19 -0800573// for a module is in three levels, OsClass, multilib, and then Target.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700574// OsClass selection is determined by:
575// - The HostOrDeviceSupported value passed in to InitAndroidArchModule by the module type factory, which selects
576// whether the module type can compile for host, device or both.
577// - The host_supported and device_supported properties on the module.
Roland Levillainf5b635d2019-06-05 14:42:57 +0100578// If host is supported for the module, the Host and HostCross OsClasses are selected. If device is supported
Colin Crossee0bc3b2018-10-02 22:01:37 -0700579// for the module, the Device OsClass is selected.
580// Within each selected OsClass, the multilib selection is determined by:
Jaewoong Jung02b2d4d2019-06-06 15:19:57 -0700581// - The compile_multilib property if it set (which may be overridden by target.android.compile_multilib or
Colin Crossee0bc3b2018-10-02 22:01:37 -0700582// target.host.compile_multilib).
583// - The default multilib passed to InitAndroidArchModule if compile_multilib was not set.
584// Valid multilib values include:
585// "both": compile for all Targets supported by the OsClass (generally x86_64 and x86, or arm64 and arm).
586// "first": compile for only a single preferred Target supported by the OsClass. This is generally x86_64 or arm64,
Elliott Hughes79ae3412020-04-17 15:49:49 -0700587// but may be arm for a 32-bit only build.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700588// "32": compile for only a single 32-bit Target supported by the OsClass.
589// "64": compile for only a single 64-bit Target supported by the OsClass.
Colin Crossa6845402020-11-16 15:08:19 -0800590// "common": compile a for a single Target that will work on all Targets supported by the OsClass (for example Java).
591// "common_first": compile a for a Target that will work on all Targets supported by the OsClass
592// (same as "common"), plus a second Target for the preferred Target supported by the OsClass
593// (same as "first"). This is used for java_binary that produces a common .jar and a wrapper
594// executable script.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700595//
596// Once the list of Targets is determined, the module is split into a variant for each Target.
597//
598// Modules can be initialized with InitAndroidMultiTargetsArchModule, in which case they will be split by OsClass,
599// but will have a common Target that is expected to handle all other selected Targets via ctx.MultiTargets().
Colin Cross617b88a2020-08-24 18:04:09 -0700600func archMutator(bpctx blueprint.BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700601 var module Module
Colin Cross3f40fa42015-01-30 17:27:36 -0800602 var ok bool
Colin Cross617b88a2020-08-24 18:04:09 -0700603 if module, ok = bpctx.Module().(Module); !ok {
604 if bootstrap.IsBootstrapModule(bpctx.Module()) {
605 // Bootstrap Go modules are always the build architecture.
606 bpctx.CreateVariations(bpctx.Config().(Config).BuildOSTarget.ArchVariation())
607 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800608 return
609 }
610
Colin Cross617b88a2020-08-24 18:04:09 -0700611 // Bootstrap Go module support above requires this mutator to be a
612 // blueprint.BottomUpMutatorContext because android.BottomUpMutatorContext
613 // filters out non-Soong modules. Now that we've handled them, create a
614 // normal android.BottomUpMutatorContext.
Liz Kammer356f7d42021-01-26 09:18:53 -0500615 mctx := bottomUpMutatorContextFactory(bpctx, module, false, false)
Colin Cross617b88a2020-08-24 18:04:09 -0700616
Colin Cross5eca7cb2018-10-02 14:02:10 -0700617 base := module.base()
618
619 if !base.ArchSpecific() {
Colin Crossb9db4802016-06-03 01:50:47 +0000620 return
621 }
622
Colin Crossa195f912019-10-16 11:07:20 -0700623 os := base.commonProperties.CompileOS
Paul Duffin1356d8c2020-02-25 19:26:33 +0000624 if os == CommonOS {
625 // Make sure that the target related properties are initialized for the
626 // CommonOS variant.
627 addTargetProperties(module, commonTargetMap[os.Name], nil, true)
628
629 // Do not create arch specific variants for the CommonOS variant.
630 return
631 }
632
Colin Crossa195f912019-10-16 11:07:20 -0700633 osTargets := mctx.Config().Targets[os]
Colin Crossfb0c16e2019-11-20 17:12:35 -0800634 image := base.commonProperties.ImageVariation
Colin Crossa6845402020-11-16 15:08:19 -0800635 // Filter NativeBridge targets unless they are explicitly supported.
636 // Skip creating native bridge variants for non-core modules.
Paul Duffine3d1ae42021-09-03 17:47:17 +0100637 if os == Android && !(base.IsNativeBridgeSupported() && image == CoreVariation) {
Colin Cross83bead42019-12-18 10:45:46 -0800638
Colin Crossa195f912019-10-16 11:07:20 -0700639 var targets []Target
640 for _, t := range osTargets {
641 if !t.NativeBridge {
642 targets = append(targets, t)
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700643 }
644 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700645
Colin Crossa195f912019-10-16 11:07:20 -0700646 osTargets = targets
647 }
Colin Crossee0bc3b2018-10-02 22:01:37 -0700648
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700649 // only the primary arch in the ramdisk / vendor_ramdisk / recovery partition
Inseob Kim08758f02021-04-08 21:13:22 +0900650 if os == Android && (module.InstallInRecovery() || module.InstallInRamdisk() || module.InstallInVendorRamdisk() || module.InstallInDebugRamdisk()) {
Colin Crossa195f912019-10-16 11:07:20 -0700651 osTargets = []Target{osTargets[0]}
652 }
dimitry1f33e402019-03-26 12:39:31 +0100653
Jaewoong Jung003d8082021-02-24 17:39:54 -0800654 // Windows builds always prefer 32-bit
655 prefer32 := os == Windows
dimitry1f33e402019-03-26 12:39:31 +0100656
Colin Crossa6845402020-11-16 15:08:19 -0800657 // Determine the multilib selection for this module.
Dan Willemsen47450072021-10-19 20:24:49 -0700658 multilib, extraMultilib := decodeMultilib(base, os)
Colin Crossa6845402020-11-16 15:08:19 -0800659
660 // Convert the multilib selection into a list of Targets.
Colin Crossa195f912019-10-16 11:07:20 -0700661 targets, err := decodeMultilibTargets(multilib, osTargets, prefer32)
662 if err != nil {
663 mctx.ModuleErrorf("%s", err.Error())
664 }
Colin Cross5eca7cb2018-10-02 14:02:10 -0700665
Colin Crossa6845402020-11-16 15:08:19 -0800666 // If the module is using extraMultilib, decode the extraMultilib selection into
667 // a separate list of Targets.
Colin Crossa195f912019-10-16 11:07:20 -0700668 var multiTargets []Target
669 if extraMultilib != "" {
670 multiTargets, err = decodeMultilibTargets(extraMultilib, osTargets, prefer32)
Colin Crossa1ad8d12016-06-01 17:09:44 -0700671 if err != nil {
672 mctx.ModuleErrorf("%s", err.Error())
673 }
Colin Crossb9db4802016-06-03 01:50:47 +0000674 }
675
Colin Crossa6845402020-11-16 15:08:19 -0800676 // Recovery is always the primary architecture, filter out any other architectures.
Inseob Kim20fb5d42021-02-02 20:07:58 +0900677 // Common arch is also allowed
Colin Crossfb0c16e2019-11-20 17:12:35 -0800678 if image == RecoveryVariation {
679 primaryArch := mctx.Config().DevicePrimaryArchType()
Inseob Kim20fb5d42021-02-02 20:07:58 +0900680 targets = filterToArch(targets, primaryArch, Common)
681 multiTargets = filterToArch(multiTargets, primaryArch, Common)
Colin Crossfb0c16e2019-11-20 17:12:35 -0800682 }
683
Colin Crossa6845402020-11-16 15:08:19 -0800684 // If there are no supported targets disable the module.
Colin Crossa195f912019-10-16 11:07:20 -0700685 if len(targets) == 0 {
Inseob Kimeec88e12020-01-22 11:11:29 +0900686 base.Disable()
Dan Willemsen3f32f032016-07-11 14:36:48 -0700687 return
688 }
689
Colin Crossa6845402020-11-16 15:08:19 -0800690 // Convert the targets into a list of arch variation names.
Colin Crossa195f912019-10-16 11:07:20 -0700691 targetNames := make([]string, len(targets))
Colin Crossa195f912019-10-16 11:07:20 -0700692 for i, target := range targets {
693 targetNames[i] = target.ArchVariation()
Colin Crossa1ad8d12016-06-01 17:09:44 -0700694 }
695
Colin Crossa6845402020-11-16 15:08:19 -0800696 // Create the variations, annotate each one with which Target it was created for, and
697 // squash the appropriate arch-specific properties into the top level properties.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700698 modules := mctx.CreateVariations(targetNames...)
Colin Cross3f40fa42015-01-30 17:27:36 -0800699 for i, m := range modules {
Paul Duffin1356d8c2020-02-25 19:26:33 +0000700 addTargetProperties(m, targets[i], multiTargets, i == 0)
Colin Cross617b88a2020-08-24 18:04:09 -0700701 m.base().setArchProperties(mctx)
Dan Willemsen8528f4e2021-10-19 00:22:06 -0700702
703 // Install support doesn't understand Darwin+Arm64
704 if os == Darwin && targets[i].HostCross {
705 m.base().commonProperties.SkipInstall = true
706 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800707 }
Dan Willemsen47450072021-10-19 20:24:49 -0700708
709 // Create a dependency for Darwin Universal binaries from the primary to secondary
710 // architecture. The module itself will be responsible for calling lipo to merge the outputs.
711 if os == Darwin {
712 if multilib == "darwin_universal" && len(modules) == 2 {
713 mctx.AddInterVariantDependency(DarwinUniversalVariantTag, modules[1], modules[0])
714 } else if multilib == "darwin_universal_common_first" && len(modules) == 3 {
715 mctx.AddInterVariantDependency(DarwinUniversalVariantTag, modules[2], modules[1])
716 }
717 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800718}
719
Colin Crossa6845402020-11-16 15:08:19 -0800720// addTargetProperties annotates a variant with the Target is is being compiled for, the list
721// of additional Targets it is supporting (if any), and whether it is the primary Target for
722// the module.
Paul Duffin1356d8c2020-02-25 19:26:33 +0000723func addTargetProperties(m Module, target Target, multiTargets []Target, primaryTarget bool) {
724 m.base().commonProperties.CompileTarget = target
725 m.base().commonProperties.CompileMultiTargets = multiTargets
726 m.base().commonProperties.CompilePrimary = primaryTarget
727}
728
Colin Crossa6845402020-11-16 15:08:19 -0800729// decodeMultilib returns the appropriate compile_multilib property for the module, or the default
730// multilib from the factory's call to InitAndroidArchModule if none was set. For modules that
731// called InitAndroidMultiTargetsArchModule it always returns "common" for multilib, and returns
732// the actual multilib in extraMultilib.
Dan Willemsen47450072021-10-19 20:24:49 -0700733func decodeMultilib(base *ModuleBase, os OsType) (multilib, extraMultilib string) {
Colin Crossa6845402020-11-16 15:08:19 -0800734 // First check the "android.compile_multilib" or "host.compile_multilib" properties.
Dan Willemsen47450072021-10-19 20:24:49 -0700735 switch os.Class {
Colin Crossee0bc3b2018-10-02 22:01:37 -0700736 case Device:
737 multilib = String(base.commonProperties.Target.Android.Compile_multilib)
Jiyong Park1613e552020-09-14 19:43:17 +0900738 case Host:
Colin Crossee0bc3b2018-10-02 22:01:37 -0700739 multilib = String(base.commonProperties.Target.Host.Compile_multilib)
740 }
Colin Crossa6845402020-11-16 15:08:19 -0800741
742 // If those aren't set, try the "compile_multilib" property.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700743 if multilib == "" {
744 multilib = String(base.commonProperties.Compile_multilib)
745 }
Colin Crossa6845402020-11-16 15:08:19 -0800746
747 // If that wasn't set, use the default multilib set by the factory.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700748 if multilib == "" {
749 multilib = base.commonProperties.Default_multilib
750 }
751
752 if base.commonProperties.UseTargetVariants {
Dan Willemsen47450072021-10-19 20:24:49 -0700753 // Darwin has the concept of "universal binaries" which is implemented in Soong by
754 // building both x86_64 and arm64 variants, and having select module types know how to
755 // merge the outputs of their corresponding variants together into a final binary. Most
756 // module types don't need to understand this logic, as we only build a small portion
757 // of the tree for Darwin, and only module types writing macho files need to do the
758 // merging.
759 //
760 // This logic is not enabled for:
761 // "common", as it's not an arch-specific variant
762 // "32", as Darwin never has a 32-bit variant
763 // !UseTargetVariants, as the module has opted into handling the arch-specific logic on
764 // its own.
765 if os == Darwin && multilib != "common" && multilib != "32" {
766 if multilib == "common_first" {
767 multilib = "darwin_universal_common_first"
768 } else {
769 multilib = "darwin_universal"
770 }
771 }
772
Colin Crossee0bc3b2018-10-02 22:01:37 -0700773 return multilib, ""
774 } else {
775 // For app modules a single arch variant will be created per OS class which is expected to handle all the
776 // selected arches. Return the common-type as multilib and any Android.bp provided multilib as extraMultilib
777 if multilib == base.commonProperties.Default_multilib {
778 multilib = "first"
779 }
780 return base.commonProperties.Default_multilib, multilib
781 }
782}
783
Colin Crossa6845402020-11-16 15:08:19 -0800784// filterToArch takes a list of Targets and an ArchType, and returns a modified list that contains
Inseob Kim20fb5d42021-02-02 20:07:58 +0900785// only Targets that have the specified ArchTypes.
786func filterToArch(targets []Target, archs ...ArchType) []Target {
Colin Crossfb0c16e2019-11-20 17:12:35 -0800787 for i := 0; i < len(targets); i++ {
Inseob Kim20fb5d42021-02-02 20:07:58 +0900788 found := false
789 for _, arch := range archs {
790 if targets[i].Arch.ArchType == arch {
791 found = true
792 break
793 }
794 }
795 if !found {
Colin Crossfb0c16e2019-11-20 17:12:35 -0800796 targets = append(targets[:i], targets[i+1:]...)
797 i--
798 }
799 }
800 return targets
801}
802
Colin Crossa6845402020-11-16 15:08:19 -0800803// archPropRoot is a struct type used as the top level of the arch-specific properties. It
804// contains the "arch", "multilib", and "target" property structs. It is used to split up the
805// property structs to limit how much is allocated when a single arch-specific property group is
806// used. The types are interface{} because they will hold instances of runtime-created types.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800807type archPropRoot struct {
808 Arch, Multilib, Target interface{}
809}
810
Colin Crossa6845402020-11-16 15:08:19 -0800811// archPropTypeDesc holds the runtime-created types for the property structs to instantiate to
812// create an archPropRoot property struct.
813type archPropTypeDesc struct {
814 arch, multilib, target reflect.Type
815}
816
Colin Crosscbbd13f2020-01-17 14:08:22 -0800817// createArchPropTypeDesc takes a reflect.Type that is either a struct or a pointer to a struct, and
818// returns lists of reflect.Types that contains the arch-variant properties inside structs for each
819// arch, multilib and target property.
Colin Crossa6845402020-11-16 15:08:19 -0800820//
821// This is a relatively expensive operation, so the results are cached in the global
822// archPropTypeMap. It is constructed entirely based on compile-time data, so there is no need
823// to isolate the results between multiple tests running in parallel.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800824func createArchPropTypeDesc(props reflect.Type) []archPropTypeDesc {
Colin Crossb1d8c992020-01-21 11:43:29 -0800825 // Each property struct shard will be nested many times under the runtime generated arch struct,
826 // which can hit the limit of 64kB for the name of runtime generated structs. They are nested
827 // 97 times now, which may grow in the future, plus there is some overhead for the containing
828 // type. This number may need to be reduced if too many are added, but reducing it too far
829 // could cause problems if a single deeply nested property no longer fits in the name.
830 const maxArchTypeNameSize = 500
831
Colin Crossa6845402020-11-16 15:08:19 -0800832 // Convert the type to a new set of types that contains only the arch-specific properties
Usta Shrestha0b52d832022-02-04 21:37:39 -0500833 // (those that are tagged with `android:"arch_variant"`), and sharded into multiple types
Colin Crossa6845402020-11-16 15:08:19 -0800834 // to keep the runtime-generated names under the limit.
Colin Crossb1d8c992020-01-21 11:43:29 -0800835 propShards, _ := proptools.FilterPropertyStructSharded(props, maxArchTypeNameSize, filterArchStruct)
Colin Crossa6845402020-11-16 15:08:19 -0800836
837 // If the type has no arch-specific properties there is nothing to do.
Colin Crosscb988072019-01-24 14:58:11 -0800838 if len(propShards) == 0 {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700839 return nil
840 }
841
Colin Crosscbbd13f2020-01-17 14:08:22 -0800842 var ret []archPropTypeDesc
Colin Crossc17727d2018-10-24 12:42:09 -0700843 for _, props := range propShards {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700844
Colin Crossa6845402020-11-16 15:08:19 -0800845 // variantFields takes a list of variant property field names and returns a list the
846 // StructFields with the names and the type of the current shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700847 variantFields := func(names []string) []reflect.StructField {
848 ret := make([]reflect.StructField, len(names))
Dan Willemsenb1957a52016-06-23 23:44:54 -0700849
Colin Crossc17727d2018-10-24 12:42:09 -0700850 for i, name := range names {
851 ret[i].Name = name
852 ret[i].Type = props
Dan Willemsen866b5632017-09-22 12:28:24 -0700853 }
Colin Crossc17727d2018-10-24 12:42:09 -0700854
855 return ret
856 }
857
Colin Crossa6845402020-11-16 15:08:19 -0800858 // Create a type that contains the properties in this shard repeated for each
859 // architecture, architecture variant, and architecture feature.
Colin Crossc17727d2018-10-24 12:42:09 -0700860 archFields := make([]reflect.StructField, len(archTypeList))
861 for i, arch := range archTypeList {
Colin Crossa6845402020-11-16 15:08:19 -0800862 var variants []string
Colin Crossc17727d2018-10-24 12:42:09 -0700863
864 for _, archVariant := range archVariants[arch] {
865 archVariant := variantReplacer.Replace(archVariant)
866 variants = append(variants, proptools.FieldNameForProperty(archVariant))
867 }
Liz Kammer2c2afe22022-02-11 11:35:03 -0500868 for _, cpuVariant := range cpuVariants[arch] {
869 cpuVariant := variantReplacer.Replace(cpuVariant)
870 variants = append(variants, proptools.FieldNameForProperty(cpuVariant))
871 }
Colin Crossc17727d2018-10-24 12:42:09 -0700872 for _, feature := range archFeatures[arch] {
873 feature := variantReplacer.Replace(feature)
874 variants = append(variants, proptools.FieldNameForProperty(feature))
875 }
876
Colin Crossa6845402020-11-16 15:08:19 -0800877 // Create the StructFields for each architecture variant architecture feature
878 // (e.g. "arch.arm.cortex-a53" or "arch.arm.neon").
Colin Crossc17727d2018-10-24 12:42:09 -0700879 fields := variantFields(variants)
880
Colin Crossa6845402020-11-16 15:08:19 -0800881 // Create the StructField for the architecture itself (e.g. "arch.arm"). The special
882 // "BlueprintEmbed" name is used by Blueprint to put the properties in the
883 // parent struct.
Colin Crossc17727d2018-10-24 12:42:09 -0700884 fields = append([]reflect.StructField{{
885 Name: "BlueprintEmbed",
886 Type: props,
887 Anonymous: true,
888 }}, fields...)
889
890 archFields[i] = reflect.StructField{
891 Name: arch.Field,
892 Type: reflect.StructOf(fields),
893 }
894 }
Colin Crossa6845402020-11-16 15:08:19 -0800895
896 // Create the type of the "arch" property struct for this shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700897 archType := reflect.StructOf(archFields)
898
Colin Crossa6845402020-11-16 15:08:19 -0800899 // Create the type for the "multilib" property struct for this shard, containing the
900 // "multilib.lib32" and "multilib.lib64" property structs.
Colin Crossc17727d2018-10-24 12:42:09 -0700901 multilibType := reflect.StructOf(variantFields([]string{"Lib32", "Lib64"}))
902
Colin Crossa6845402020-11-16 15:08:19 -0800903 // Start with a list of the special targets
Colin Crossc17727d2018-10-24 12:42:09 -0700904 targets := []string{
905 "Host",
906 "Android64",
907 "Android32",
908 "Bionic",
Colin Cross528d67e2021-07-23 22:23:07 +0000909 "Glibc",
910 "Musl",
Colin Crossc17727d2018-10-24 12:42:09 -0700911 "Linux",
Colin Crossa98d36d2022-03-07 14:39:49 -0800912 "Host_linux",
Colin Crossc17727d2018-10-24 12:42:09 -0700913 "Not_windows",
914 "Arm_on_x86",
915 "Arm_on_x86_64",
Victor Khimenkoc26fcf42020-05-07 22:16:33 +0200916 "Native_bridge",
Colin Crossc17727d2018-10-24 12:42:09 -0700917 }
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000918 for _, os := range osTypeList {
Colin Crossa6845402020-11-16 15:08:19 -0800919 // Add all the OSes.
Colin Crossc17727d2018-10-24 12:42:09 -0700920 targets = append(targets, os.Field)
921
Colin Crossa6845402020-11-16 15:08:19 -0800922 // Add the OS/Arch combinations, e.g. "android_arm64".
Colin Crossc17727d2018-10-24 12:42:09 -0700923 for _, archType := range osArchTypeMap[os] {
Liz Kammer9abd62d2021-05-21 08:37:59 -0400924 targets = append(targets, GetCompoundTargetField(os, archType))
Colin Crossc17727d2018-10-24 12:42:09 -0700925
Colin Cross1aa45b02022-02-10 10:33:10 -0800926 // Also add the special "linux_<arch>", "bionic_<arch>" , "glibc_<arch>", and
927 // "musl_<arch>" property structs.
Colin Crossc17727d2018-10-24 12:42:09 -0700928 if os.Linux() {
929 target := "Linux_" + archType.Name
930 if !InList(target, targets) {
931 targets = append(targets, target)
932 }
933 }
Colin Crossa98d36d2022-03-07 14:39:49 -0800934 if os.Linux() && os.Class == Host {
935 target := "Host_linux_" + archType.Name
936 if !InList(target, targets) {
937 targets = append(targets, target)
938 }
939 }
Colin Crossc17727d2018-10-24 12:42:09 -0700940 if os.Bionic() {
941 target := "Bionic_" + archType.Name
942 if !InList(target, targets) {
943 targets = append(targets, target)
944 }
Dan Willemsen866b5632017-09-22 12:28:24 -0700945 }
Colin Cross1aa45b02022-02-10 10:33:10 -0800946 if os == Linux {
947 target := "Glibc_" + archType.Name
948 if !InList(target, targets) {
949 targets = append(targets, target)
950 }
951 }
952 if os == LinuxMusl {
953 target := "Musl_" + archType.Name
954 if !InList(target, targets) {
955 targets = append(targets, target)
956 }
957 }
Dan Willemsen866b5632017-09-22 12:28:24 -0700958 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700959 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700960
Colin Crossa6845402020-11-16 15:08:19 -0800961 // Create the type for the "target" property struct for this shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700962 targetType := reflect.StructOf(variantFields(targets))
Colin Crosscbbd13f2020-01-17 14:08:22 -0800963
Colin Crossa6845402020-11-16 15:08:19 -0800964 // Return a descriptor of the 3 runtime-created types.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800965 ret = append(ret, archPropTypeDesc{
966 arch: reflect.PtrTo(archType),
967 multilib: reflect.PtrTo(multilibType),
968 target: reflect.PtrTo(targetType),
969 })
Colin Crossc17727d2018-10-24 12:42:09 -0700970 }
971 return ret
Dan Willemsenb1957a52016-06-23 23:44:54 -0700972}
973
Colin Crossa6845402020-11-16 15:08:19 -0800974// variantReplacer converts architecture variant or architecture feature names into names that
975// are valid for an Android.bp file.
976var variantReplacer = strings.NewReplacer("-", "_", ".", "_")
977
978// filterArchStruct returns true if the given field is an architecture specific property.
Colin Cross74449102019-09-25 11:26:40 -0700979func filterArchStruct(field reflect.StructField, prefix string) (bool, reflect.StructField) {
980 if proptools.HasTag(field, "android", "arch_variant") {
981 // The arch_variant field isn't necessary past this point
982 // Instead of wasting space, just remove it. Go also has a
983 // 16-bit limit on structure name length. The name is constructed
984 // based on the Go source representation of the structure, so
985 // the tag names count towards that length.
Colin Crossb4fecbf2020-01-21 11:38:47 -0800986
987 androidTag := field.Tag.Get("android")
988 values := strings.Split(androidTag, ",")
989
990 if string(field.Tag) != `android:"`+strings.Join(values, ",")+`"` {
991 panic(fmt.Errorf("unexpected tag format %q", field.Tag))
Colin Cross74449102019-09-25 11:26:40 -0700992 }
Liz Kammer4562a3b2021-04-21 18:15:34 -0400993 // don't delete path tag as it is needed for bp2build
Colin Crossb4fecbf2020-01-21 11:38:47 -0800994 // these tags don't need to be present in the runtime generated struct type.
Liz Kammer4562a3b2021-04-21 18:15:34 -0400995 values = RemoveListFromList(values, []string{"arch_variant", "variant_prepend"})
996 if len(values) > 0 && values[0] != "path" {
Colin Crossb4fecbf2020-01-21 11:38:47 -0800997 panic(fmt.Errorf("unknown tags %q in field %q", values, prefix+field.Name))
Liz Kammer4562a3b2021-04-21 18:15:34 -0400998 } else if len(values) == 1 {
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxfd0c03c2021-09-21 15:17:48 +0000999 // FIXME(b/200678898): This assumes that the only tag type when there's
1000 // `android:"arch_variant"` is `android` itself and thus clobbers others
Liz Kammer4562a3b2021-04-21 18:15:34 -04001001 field.Tag = reflect.StructTag(`android:"` + strings.Join(values, ",") + `"`)
1002 } else {
1003 field.Tag = ``
Colin Crossb4fecbf2020-01-21 11:38:47 -08001004 }
1005
Colin Cross74449102019-09-25 11:26:40 -07001006 return true, field
1007 }
1008 return false, field
1009}
1010
Colin Crossa6845402020-11-16 15:08:19 -08001011// archPropTypeMap contains a cache of the results of createArchPropTypeDesc for each type. It is
1012// shared across all Contexts, but is constructed based only on compile-time information so there
1013// is no risk of contaminating one Context with data from another.
Dan Willemsenb1957a52016-06-23 23:44:54 -07001014var archPropTypeMap OncePer
1015
Colin Crossa6845402020-11-16 15:08:19 -08001016// initArchModule adds the architecture-specific property structs to a Module.
1017func initArchModule(m Module) {
Colin Cross3f40fa42015-01-30 17:27:36 -08001018
1019 base := m.base()
1020
Ustaeabf0f32021-12-06 15:17:23 -05001021 if len(base.archProperties) != 0 {
1022 panic(fmt.Errorf("module %s already has archProperties", m.Name()))
1023 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001024
Ustaeabf0f32021-12-06 15:17:23 -05001025 getStructType := func(properties interface{}) reflect.Type {
Colin Cross3f40fa42015-01-30 17:27:36 -08001026 propertiesValue := reflect.ValueOf(properties)
Colin Cross62496a02016-08-08 15:49:17 -07001027 t := propertiesValue.Type()
Colin Cross3f40fa42015-01-30 17:27:36 -08001028 if propertiesValue.Kind() != reflect.Ptr {
Colin Crossca860ac2016-01-04 14:34:37 -08001029 panic(fmt.Errorf("properties must be a pointer to a struct, got %T",
1030 propertiesValue.Interface()))
Colin Cross3f40fa42015-01-30 17:27:36 -08001031 }
1032
1033 propertiesValue = propertiesValue.Elem()
1034 if propertiesValue.Kind() != reflect.Struct {
Ustaeabf0f32021-12-06 15:17:23 -05001035 panic(fmt.Errorf("properties must be a pointer to a struct, got a pointer to %T",
Colin Crossca860ac2016-01-04 14:34:37 -08001036 propertiesValue.Interface()))
Colin Cross3f40fa42015-01-30 17:27:36 -08001037 }
Ustaeabf0f32021-12-06 15:17:23 -05001038 return t
1039 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001040
Usta851a3272022-01-05 23:42:33 -05001041 for _, properties := range m.GetProperties() {
Ustaeabf0f32021-12-06 15:17:23 -05001042 t := getStructType(properties)
Colin Crossa6845402020-11-16 15:08:19 -08001043 // Get or create the arch-specific property struct types for this property struct type.
Colin Cross571cccf2019-02-04 11:22:08 -08001044 archPropTypes := archPropTypeMap.Once(NewCustomOnceKey(t), func() interface{} {
Colin Crosscbbd13f2020-01-17 14:08:22 -08001045 return createArchPropTypeDesc(t)
1046 }).([]archPropTypeDesc)
Colin Cross3f40fa42015-01-30 17:27:36 -08001047
Colin Crossa6845402020-11-16 15:08:19 -08001048 // Instantiate one of each arch-specific property struct type and add it to the
1049 // properties for the Module.
Colin Crossc17727d2018-10-24 12:42:09 -07001050 var archProperties []interface{}
1051 for _, t := range archPropTypes {
Colin Crosscbbd13f2020-01-17 14:08:22 -08001052 archProperties = append(archProperties, &archPropRoot{
1053 Arch: reflect.Zero(t.arch).Interface(),
1054 Multilib: reflect.Zero(t.multilib).Interface(),
1055 Target: reflect.Zero(t.target).Interface(),
1056 })
Dan Willemsenb1957a52016-06-23 23:44:54 -07001057 }
Colin Crossc17727d2018-10-24 12:42:09 -07001058 base.archProperties = append(base.archProperties, archProperties)
1059 m.AddProperties(archProperties...)
Colin Cross3f40fa42015-01-30 17:27:36 -08001060 }
1061
Colin Cross3f40fa42015-01-30 17:27:36 -08001062}
1063
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001064func maybeBlueprintEmbed(src reflect.Value) reflect.Value {
Colin Crossa6845402020-11-16 15:08:19 -08001065 // If the value of the field is a struct (as opposed to a pointer to a struct) then step
1066 // into the BlueprintEmbed field.
Dan Willemsenb1957a52016-06-23 23:44:54 -07001067 if src.Kind() == reflect.Struct {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001068 return src.FieldByName("BlueprintEmbed")
1069 } else {
1070 return src
Colin Cross06a931b2015-10-28 17:23:31 -07001071 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001072}
1073
1074// Merges the property struct in srcValue into dst.
Liz Kammerb6dbc872021-05-14 15:14:40 -04001075func mergePropertyStruct(ctx ArchVariantContext, dst interface{}, srcValue reflect.Value) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001076 src := maybeBlueprintEmbed(srcValue).Interface()
Colin Cross06a931b2015-10-28 17:23:31 -07001077
Colin Crossa6845402020-11-16 15:08:19 -08001078 // order checks the `android:"variant_prepend"` tag to handle properties where the
1079 // arch-specific value needs to come before the generic value, for example for lists of
1080 // include directories.
Colin Cross6ee75b62016-05-05 15:57:15 -07001081 order := func(property string,
1082 dstField, srcField reflect.StructField,
1083 dstValue, srcValue interface{}) (proptools.Order, error) {
1084 if proptools.HasTag(dstField, "android", "variant_prepend") {
1085 return proptools.Prepend, nil
1086 } else {
1087 return proptools.Append, nil
1088 }
1089 }
1090
Colin Crossa6845402020-11-16 15:08:19 -08001091 // Squash the located property struct into the destination property struct.
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001092 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src, nil, order)
Colin Cross06a931b2015-10-28 17:23:31 -07001093 if err != nil {
1094 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1095 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1096 } else {
1097 panic(err)
1098 }
1099 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001100}
Colin Cross85a88972015-11-23 13:29:51 -08001101
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001102// Returns the immediate child of the input property struct that corresponds to
1103// the sub-property "field".
Liz Kammerb6dbc872021-05-14 15:14:40 -04001104func getChildPropertyStruct(ctx ArchVariantContext,
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001105 src reflect.Value, field, userFriendlyField string) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001106
1107 // Step into non-nil pointers to structs in the src value.
1108 if src.Kind() == reflect.Ptr {
1109 if src.IsNil() {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001110 return reflect.Value{}, false
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001111 }
1112 src = src.Elem()
1113 }
1114
1115 // Find the requested field in the src struct.
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001116 child := src.FieldByName(proptools.FieldNameForProperty(field))
1117 if !child.IsValid() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001118 ctx.ModuleErrorf("field %q does not exist", userFriendlyField)
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001119 return reflect.Value{}, false
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001120 }
1121
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001122 if child.IsZero() {
1123 return reflect.Value{}, false
1124 }
1125
1126 return child, true
Colin Cross06a931b2015-10-28 17:23:31 -07001127}
1128
Colin Crossa6845402020-11-16 15:08:19 -08001129// Squash the appropriate OS-specific property structs into the matching top level property structs
1130// based on the CompileOS value that was annotated on the variant.
Colin Crossa195f912019-10-16 11:07:20 -07001131func (m *ModuleBase) setOSProperties(ctx BottomUpMutatorContext) {
1132 os := m.commonProperties.CompileOS
1133
Ustadca02192021-12-20 12:56:46 -05001134 for i := range m.archProperties {
Usta851a3272022-01-05 23:42:33 -05001135 genProps := m.GetProperties()[i]
Colin Crossa195f912019-10-16 11:07:20 -07001136 if m.archProperties[i] == nil {
1137 continue
1138 }
1139 for _, archProperties := range m.archProperties[i] {
1140 archPropValues := reflect.ValueOf(archProperties).Elem()
1141
Colin Crosscbbd13f2020-01-17 14:08:22 -08001142 targetProp := archPropValues.FieldByName("Target").Elem()
Colin Crossa195f912019-10-16 11:07:20 -07001143
1144 // Handle host-specific properties in the form:
1145 // target: {
1146 // host: {
1147 // key: value,
1148 // },
1149 // },
Jiyong Park1613e552020-09-14 19:43:17 +09001150 if os.Class == Host {
Colin Crossa195f912019-10-16 11:07:20 -07001151 field := "Host"
1152 prefix := "target.host"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001153 if hostProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1154 mergePropertyStruct(ctx, genProps, hostProperties)
1155 }
Colin Crossa195f912019-10-16 11:07:20 -07001156 }
1157
1158 // Handle target OS generalities of the form:
1159 // target: {
1160 // bionic: {
1161 // key: value,
1162 // },
1163 // }
1164 if os.Linux() {
1165 field := "Linux"
1166 prefix := "target.linux"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001167 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1168 mergePropertyStruct(ctx, genProps, linuxProperties)
1169 }
Colin Crossa195f912019-10-16 11:07:20 -07001170 }
1171
Colin Crossa98d36d2022-03-07 14:39:49 -08001172 if os.Linux() && os.Class == Host {
1173 field := "Host_linux"
1174 prefix := "target.host_linux"
1175 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1176 mergePropertyStruct(ctx, genProps, linuxProperties)
1177 }
1178 }
1179
Colin Crossa195f912019-10-16 11:07:20 -07001180 if os.Bionic() {
1181 field := "Bionic"
1182 prefix := "target.bionic"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001183 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1184 mergePropertyStruct(ctx, genProps, bionicProperties)
1185 }
Colin Crossa195f912019-10-16 11:07:20 -07001186 }
1187
Colin Cross528d67e2021-07-23 22:23:07 +00001188 if os == Linux {
1189 field := "Glibc"
1190 prefix := "target.glibc"
1191 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1192 mergePropertyStruct(ctx, genProps, bionicProperties)
1193 }
1194 }
1195
1196 if os == LinuxMusl {
1197 field := "Musl"
1198 prefix := "target.musl"
1199 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1200 mergePropertyStruct(ctx, genProps, bionicProperties)
1201 }
Colin Cross528d67e2021-07-23 22:23:07 +00001202 }
1203
Colin Crossa195f912019-10-16 11:07:20 -07001204 // Handle target OS properties in the form:
1205 // target: {
1206 // linux_glibc: {
1207 // key: value,
1208 // },
1209 // not_windows: {
1210 // key: value,
1211 // },
1212 // android {
1213 // key: value,
1214 // },
1215 // },
1216 field := os.Field
1217 prefix := "target." + os.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001218 if osProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1219 mergePropertyStruct(ctx, genProps, osProperties)
1220 }
Colin Crossa195f912019-10-16 11:07:20 -07001221
Jiyong Park1613e552020-09-14 19:43:17 +09001222 if os.Class == Host && os != Windows {
Colin Crossa195f912019-10-16 11:07:20 -07001223 field := "Not_windows"
1224 prefix := "target.not_windows"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001225 if notWindowsProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1226 mergePropertyStruct(ctx, genProps, notWindowsProperties)
1227 }
Colin Crossa195f912019-10-16 11:07:20 -07001228 }
1229
1230 // Handle 64-bit device properties in the form:
1231 // target {
1232 // android64 {
1233 // key: value,
1234 // },
1235 // android32 {
1236 // key: value,
1237 // },
1238 // },
1239 // WARNING: this is probably not what you want to use in your blueprints file, it selects
1240 // options for all targets on a device that supports 64-bit binaries, not just the targets
1241 // that are being compiled for 64-bit. Its expected use case is binaries like linker and
1242 // debuggerd that need to know when they are a 32-bit process running on a 64-bit device
1243 if os.Class == Device {
1244 if ctx.Config().Android64() {
1245 field := "Android64"
1246 prefix := "target.android64"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001247 if android64Properties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1248 mergePropertyStruct(ctx, genProps, android64Properties)
1249 }
Colin Crossa195f912019-10-16 11:07:20 -07001250 } else {
1251 field := "Android32"
1252 prefix := "target.android32"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001253 if android32Properties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1254 mergePropertyStruct(ctx, genProps, android32Properties)
1255 }
Colin Crossa195f912019-10-16 11:07:20 -07001256 }
1257 }
1258 }
1259 }
1260}
1261
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001262// Returns the struct containing the properties specific to the given
1263// architecture type. These look like this in Blueprint files:
1264// arch: {
1265// arm64: {
1266// key: value,
1267// },
1268// },
1269// This struct will also contain sub-structs containing to the architecture/CPU
1270// variants and features that themselves contain properties specific to those.
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001271func getArchTypeStruct(ctx ArchVariantContext, archProperties interface{}, archType ArchType) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001272 archPropValues := reflect.ValueOf(archProperties).Elem()
1273 archProp := archPropValues.FieldByName("Arch").Elem()
1274 prefix := "arch." + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001275 return getChildPropertyStruct(ctx, archProp, archType.Name, prefix)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001276}
1277
1278// Returns the struct containing the properties specific to a given multilib
1279// value. These look like this in the Blueprint file:
1280// multilib: {
1281// lib32: {
1282// key: value,
1283// },
1284// },
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001285func getMultilibStruct(ctx ArchVariantContext, archProperties interface{}, archType ArchType) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001286 archPropValues := reflect.ValueOf(archProperties).Elem()
1287 multilibProp := archPropValues.FieldByName("Multilib").Elem()
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001288 return getChildPropertyStruct(ctx, multilibProp, archType.Multilib, "multilib."+archType.Multilib)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001289}
1290
Liz Kammer9abd62d2021-05-21 08:37:59 -04001291func GetCompoundTargetField(os OsType, arch ArchType) string {
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04001292 return os.Field + "_" + arch.Name
1293}
1294
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001295// Returns the structs corresponding to the properties specific to the given
1296// architecture and OS in archProperties.
1297func getArchProperties(ctx BaseMutatorContext, archProperties interface{}, arch Arch, os OsType, nativeBridgeEnabled bool) []reflect.Value {
1298 result := make([]reflect.Value, 0)
1299 archPropValues := reflect.ValueOf(archProperties).Elem()
1300
1301 targetProp := archPropValues.FieldByName("Target").Elem()
1302
1303 archType := arch.ArchType
1304
1305 if arch.ArchType != Common {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001306 archStruct, ok := getArchTypeStruct(ctx, archProperties, arch.ArchType)
1307 if ok {
1308 result = append(result, archStruct)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001309
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001310 // Handle arch-variant-specific properties in the form:
1311 // arch: {
1312 // arm: {
1313 // variant: {
1314 // key: value,
1315 // },
1316 // },
1317 // },
1318 v := variantReplacer.Replace(arch.ArchVariant)
1319 if v != "" {
1320 prefix := "arch." + archType.Name + "." + v
1321 if variantProperties, ok := getChildPropertyStruct(ctx, archStruct, v, prefix); ok {
1322 result = append(result, variantProperties)
1323 }
1324 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001325
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001326 // Handle cpu-variant-specific properties in the form:
1327 // arch: {
1328 // arm: {
1329 // variant: {
1330 // key: value,
1331 // },
1332 // },
1333 // },
1334 if arch.CpuVariant != arch.ArchVariant {
1335 c := variantReplacer.Replace(arch.CpuVariant)
1336 if c != "" {
1337 prefix := "arch." + archType.Name + "." + c
1338 if cpuVariantProperties, ok := getChildPropertyStruct(ctx, archStruct, c, prefix); ok {
1339 result = append(result, cpuVariantProperties)
1340 }
1341 }
1342 }
1343
1344 // Handle arch-feature-specific properties in the form:
1345 // arch: {
1346 // arm: {
1347 // feature: {
1348 // key: value,
1349 // },
1350 // },
1351 // },
1352 for _, feature := range arch.ArchFeatures {
1353 prefix := "arch." + archType.Name + "." + feature
1354 if featureProperties, ok := getChildPropertyStruct(ctx, archStruct, feature, prefix); ok {
1355 result = append(result, featureProperties)
1356 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001357 }
1358 }
1359
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001360 if multilibProperties, ok := getMultilibStruct(ctx, archProperties, archType); ok {
1361 result = append(result, multilibProperties)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001362 }
1363
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001364 // Handle combined OS-feature and arch specific properties in the form:
1365 // target: {
1366 // bionic_x86: {
1367 // key: value,
1368 // },
1369 // }
1370 if os.Linux() {
1371 field := "Linux_" + arch.ArchType.Name
1372 userFriendlyField := "target.linux_" + arch.ArchType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001373 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1374 result = append(result, linuxProperties)
1375 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001376 }
1377
1378 if os.Bionic() {
1379 field := "Bionic_" + archType.Name
1380 userFriendlyField := "target.bionic_" + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001381 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1382 result = append(result, bionicProperties)
1383 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001384 }
1385
1386 // Handle combined OS and arch specific properties in the form:
1387 // target: {
1388 // linux_glibc_x86: {
1389 // key: value,
1390 // },
1391 // linux_glibc_arm: {
1392 // key: value,
1393 // },
1394 // android_arm {
1395 // key: value,
1396 // },
1397 // android_x86 {
1398 // key: value,
1399 // },
1400 // },
Liz Kammer9abd62d2021-05-21 08:37:59 -04001401 field := GetCompoundTargetField(os, archType)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001402 userFriendlyField := "target." + os.Name + "_" + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001403 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1404 result = append(result, osArchProperties)
1405 }
Colin Cross528d67e2021-07-23 22:23:07 +00001406
Colin Cross1aa45b02022-02-10 10:33:10 -08001407 if os == Linux {
1408 field := "Glibc_" + archType.Name
1409 userFriendlyField := "target.glibc_" + "_" + archType.Name
1410 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1411 result = append(result, osArchProperties)
1412 }
1413 }
1414
Colin Cross528d67e2021-07-23 22:23:07 +00001415 if os == LinuxMusl {
Colin Cross1aa45b02022-02-10 10:33:10 -08001416 field := "Musl_" + archType.Name
1417 userFriendlyField := "target.musl_" + "_" + archType.Name
1418 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1419 result = append(result, osArchProperties)
1420 }
Colin Cross528d67e2021-07-23 22:23:07 +00001421 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001422 }
1423
1424 // Handle arm on x86 properties in the form:
1425 // target {
1426 // arm_on_x86 {
1427 // key: value,
1428 // },
1429 // arm_on_x86_64 {
1430 // key: value,
1431 // },
1432 // },
1433 if os.Class == Device {
1434 if arch.ArchType == X86 && (hasArmAbi(arch) ||
1435 hasArmAndroidArch(ctx.Config().Targets[Android])) {
1436 field := "Arm_on_x86"
1437 userFriendlyField := "target.arm_on_x86"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001438 if armOnX86Properties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1439 result = append(result, armOnX86Properties)
1440 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001441 }
1442 if arch.ArchType == X86_64 && (hasArmAbi(arch) ||
1443 hasArmAndroidArch(ctx.Config().Targets[Android])) {
1444 field := "Arm_on_x86_64"
1445 userFriendlyField := "target.arm_on_x86_64"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001446 if armOnX8664Properties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1447 result = append(result, armOnX8664Properties)
1448 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001449 }
1450 if os == Android && nativeBridgeEnabled {
1451 userFriendlyField := "Native_bridge"
1452 prefix := "target.native_bridge"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001453 if nativeBridgeProperties, ok := getChildPropertyStruct(ctx, targetProp, userFriendlyField, prefix); ok {
1454 result = append(result, nativeBridgeProperties)
1455 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001456 }
1457 }
1458
1459 return result
1460}
1461
Colin Crossa6845402020-11-16 15:08:19 -08001462// Squash the appropriate arch-specific property structs into the matching top level property
1463// structs based on the CompileTarget value that was annotated on the variant.
Colin Cross4157e882019-06-06 16:57:04 -07001464func (m *ModuleBase) setArchProperties(ctx BottomUpMutatorContext) {
1465 arch := m.Arch()
1466 os := m.Os()
Colin Crossd3ba0392015-05-07 14:11:29 -07001467
Ustadca02192021-12-20 12:56:46 -05001468 for i := range m.archProperties {
Usta851a3272022-01-05 23:42:33 -05001469 genProps := m.GetProperties()[i]
Colin Cross4157e882019-06-06 16:57:04 -07001470 if m.archProperties[i] == nil {
Dan Willemsenb1957a52016-06-23 23:44:54 -07001471 continue
1472 }
Dan Willemsenb1957a52016-06-23 23:44:54 -07001473
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001474 propStructs := make([]reflect.Value, 0)
1475 for _, archProperty := range m.archProperties[i] {
1476 propStructShard := getArchProperties(ctx, archProperty, arch, os, m.Target().NativeBridge == NativeBridgeEnabled)
1477 propStructs = append(propStructs, propStructShard...)
1478 }
Dan Willemsenb1957a52016-06-23 23:44:54 -07001479
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001480 for _, propStruct := range propStructs {
1481 mergePropertyStruct(ctx, genProps, propStruct)
Colin Crossbb2e2b72016-12-08 17:23:53 -08001482 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001483 }
1484}
1485
Colin Cross0c66bc62021-07-20 09:47:41 -07001486// determineBuildOS stores the OS and architecture used for host targets used during the build into
Colin Cross528d67e2021-07-23 22:23:07 +00001487// config based on the runtime OS and architecture determined by Go and the product configuration.
Colin Cross0c66bc62021-07-20 09:47:41 -07001488func determineBuildOS(config *config) {
1489 config.BuildOS = func() OsType {
1490 switch runtime.GOOS {
1491 case "linux":
Colin Cross528d67e2021-07-23 22:23:07 +00001492 if Bool(config.productVariables.HostMusl) {
1493 return LinuxMusl
1494 }
Colin Cross0c66bc62021-07-20 09:47:41 -07001495 return Linux
1496 case "darwin":
1497 return Darwin
1498 default:
1499 panic(fmt.Sprintf("unsupported OS: %s", runtime.GOOS))
1500 }
1501 }()
1502
1503 config.BuildArch = func() ArchType {
1504 switch runtime.GOARCH {
1505 case "amd64":
1506 return X86_64
1507 default:
1508 panic(fmt.Sprintf("unsupported Arch: %s", runtime.GOARCH))
1509 }
1510 }()
1511
1512}
1513
Colin Crossa6845402020-11-16 15:08:19 -08001514// Convert the arch product variables into a list of targets for each OsType.
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001515func decodeTargetProductVariables(config *config) (map[OsType][]Target, error) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001516 variables := config.productVariables
Dan Willemsen490fd492015-11-24 17:53:15 -08001517
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001518 targets := make(map[OsType][]Target)
Colin Crossa1ad8d12016-06-01 17:09:44 -07001519 var targetErr error
1520
Liz Kammerb7f33662022-02-28 14:16:16 -05001521 type targetConfig struct {
1522 os OsType
1523 archName string
1524 archVariant *string
1525 cpuVariant *string
1526 abi []string
1527 nativeBridgeEnabled NativeBridgeSupport
1528 nativeBridgeHostArchName *string
1529 nativeBridgeRelativePath *string
1530 }
1531
1532 addTarget := func(target targetConfig) {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001533 if targetErr != nil {
1534 return
Dan Willemsen490fd492015-11-24 17:53:15 -08001535 }
Colin Crossa1ad8d12016-06-01 17:09:44 -07001536
Liz Kammerb7f33662022-02-28 14:16:16 -05001537 arch, err := decodeArch(target.os, target.archName, target.archVariant, target.cpuVariant, target.abi)
Colin Crossa1ad8d12016-06-01 17:09:44 -07001538 if err != nil {
1539 targetErr = err
1540 return
1541 }
Liz Kammerb7f33662022-02-28 14:16:16 -05001542 nativeBridgeRelativePathStr := String(target.nativeBridgeRelativePath)
1543 nativeBridgeHostArchNameStr := String(target.nativeBridgeHostArchName)
dimitry8d6dde82019-07-11 10:23:53 +02001544
1545 // Use guest arch as relative install path by default
Liz Kammerb7f33662022-02-28 14:16:16 -05001546 if target.nativeBridgeEnabled && nativeBridgeRelativePathStr == "" {
dimitry8d6dde82019-07-11 10:23:53 +02001547 nativeBridgeRelativePathStr = arch.ArchType.String()
1548 }
Colin Crossa1ad8d12016-06-01 17:09:44 -07001549
Jiyong Park1613e552020-09-14 19:43:17 +09001550 // A target is considered as HostCross if it's a host target which can't run natively on
1551 // the currently configured build machine (either because the OS is different or because of
1552 // the unsupported arch)
1553 hostCross := false
Liz Kammerb7f33662022-02-28 14:16:16 -05001554 if target.os.Class == Host {
Jiyong Park1613e552020-09-14 19:43:17 +09001555 var osSupported bool
Liz Kammerb7f33662022-02-28 14:16:16 -05001556 if target.os == config.BuildOS {
Jiyong Park1613e552020-09-14 19:43:17 +09001557 osSupported = true
Liz Kammerb7f33662022-02-28 14:16:16 -05001558 } else if config.BuildOS.Linux() && target.os.Linux() {
Jiyong Park1613e552020-09-14 19:43:17 +09001559 // LinuxBionic and Linux are compatible
1560 osSupported = true
1561 } else {
1562 osSupported = false
1563 }
1564
1565 var archSupported bool
1566 if arch.ArchType == Common {
1567 archSupported = true
1568 } else if arch.ArchType.Name == *variables.HostArch {
1569 archSupported = true
1570 } else if variables.HostSecondaryArch != nil && arch.ArchType.Name == *variables.HostSecondaryArch {
1571 archSupported = true
1572 } else {
1573 archSupported = false
1574 }
1575 if !osSupported || !archSupported {
1576 hostCross = true
1577 }
1578 }
1579
Liz Kammerb7f33662022-02-28 14:16:16 -05001580 targets[target.os] = append(targets[target.os],
Colin Crossa1ad8d12016-06-01 17:09:44 -07001581 Target{
Liz Kammerb7f33662022-02-28 14:16:16 -05001582 Os: target.os,
dimitry8d6dde82019-07-11 10:23:53 +02001583 Arch: arch,
Liz Kammerb7f33662022-02-28 14:16:16 -05001584 NativeBridge: target.nativeBridgeEnabled,
dimitry8d6dde82019-07-11 10:23:53 +02001585 NativeBridgeHostArchName: nativeBridgeHostArchNameStr,
1586 NativeBridgeRelativePath: nativeBridgeRelativePathStr,
Jiyong Park1613e552020-09-14 19:43:17 +09001587 HostCross: hostCross,
Colin Crossa1ad8d12016-06-01 17:09:44 -07001588 })
Dan Willemsen490fd492015-11-24 17:53:15 -08001589 }
1590
Colin Cross4225f652015-09-17 14:33:42 -07001591 if variables.HostArch == nil {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001592 return nil, fmt.Errorf("No host primary architecture set")
Colin Cross4225f652015-09-17 14:33:42 -07001593 }
1594
Colin Crossa6845402020-11-16 15:08:19 -08001595 // The primary host target, which must always exist.
Liz Kammerb7f33662022-02-28 14:16:16 -05001596 addTarget(targetConfig{os: config.BuildOS, archName: *variables.HostArch, nativeBridgeEnabled: NativeBridgeDisabled})
Colin Cross4225f652015-09-17 14:33:42 -07001597
Colin Crossa6845402020-11-16 15:08:19 -08001598 // An optional secondary host target.
Colin Crosseeabb892015-11-20 13:07:51 -08001599 if variables.HostSecondaryArch != nil && *variables.HostSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001600 addTarget(targetConfig{os: config.BuildOS, archName: *variables.HostSecondaryArch, nativeBridgeEnabled: NativeBridgeDisabled})
Dan Willemsen490fd492015-11-24 17:53:15 -08001601 }
1602
Colin Crossa6845402020-11-16 15:08:19 -08001603 // Optional cross-compiled host targets, generally Windows.
Colin Crossff3ae9d2018-04-10 16:15:18 -07001604 if String(variables.CrossHost) != "" {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001605 crossHostOs := osByName(*variables.CrossHost)
1606 if crossHostOs == NoOsType {
1607 return nil, fmt.Errorf("Unknown cross host OS %q", *variables.CrossHost)
1608 }
1609
Colin Crossff3ae9d2018-04-10 16:15:18 -07001610 if String(variables.CrossHostArch) == "" {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001611 return nil, fmt.Errorf("No cross-host primary architecture set")
Dan Willemsen490fd492015-11-24 17:53:15 -08001612 }
1613
Colin Crossa6845402020-11-16 15:08:19 -08001614 // The primary cross-compiled host target.
Liz Kammerb7f33662022-02-28 14:16:16 -05001615 addTarget(targetConfig{os: crossHostOs, archName: *variables.CrossHostArch, nativeBridgeEnabled: NativeBridgeDisabled})
Dan Willemsen490fd492015-11-24 17:53:15 -08001616
Colin Crossa6845402020-11-16 15:08:19 -08001617 // An optional secondary cross-compiled host target.
Dan Willemsen490fd492015-11-24 17:53:15 -08001618 if variables.CrossHostSecondaryArch != nil && *variables.CrossHostSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001619 addTarget(targetConfig{os: crossHostOs, archName: *variables.CrossHostSecondaryArch, nativeBridgeEnabled: NativeBridgeDisabled})
Dan Willemsen490fd492015-11-24 17:53:15 -08001620 }
1621 }
1622
Colin Crossa6845402020-11-16 15:08:19 -08001623 // Optional device targets
Dan Willemsen3f32f032016-07-11 14:36:48 -07001624 if variables.DeviceArch != nil && *variables.DeviceArch != "" {
Colin Crossa6845402020-11-16 15:08:19 -08001625 // The primary device target.
Liz Kammerb7f33662022-02-28 14:16:16 -05001626 addTarget(targetConfig{
1627 os: Android,
1628 archName: *variables.DeviceArch,
1629 archVariant: variables.DeviceArchVariant,
1630 cpuVariant: variables.DeviceCpuVariant,
1631 abi: variables.DeviceAbi,
1632 nativeBridgeEnabled: NativeBridgeDisabled,
1633 })
Colin Cross4225f652015-09-17 14:33:42 -07001634
Colin Crossa6845402020-11-16 15:08:19 -08001635 // An optional secondary device target.
Dan Willemsen3f32f032016-07-11 14:36:48 -07001636 if variables.DeviceSecondaryArch != nil && *variables.DeviceSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001637 addTarget(targetConfig{
1638 os: Android,
1639 archName: *variables.DeviceSecondaryArch,
1640 archVariant: variables.DeviceSecondaryArchVariant,
1641 cpuVariant: variables.DeviceSecondaryCpuVariant,
1642 abi: variables.DeviceSecondaryAbi,
1643 nativeBridgeEnabled: NativeBridgeDisabled,
1644 })
Colin Cross4225f652015-09-17 14:33:42 -07001645 }
dimitry1f33e402019-03-26 12:39:31 +01001646
Colin Crossa6845402020-11-16 15:08:19 -08001647 // An optional NativeBridge device target.
dimitry1f33e402019-03-26 12:39:31 +01001648 if variables.NativeBridgeArch != nil && *variables.NativeBridgeArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001649 addTarget(targetConfig{
1650 os: Android,
1651 archName: *variables.NativeBridgeArch,
1652 archVariant: variables.NativeBridgeArchVariant,
1653 cpuVariant: variables.NativeBridgeCpuVariant,
1654 abi: variables.NativeBridgeAbi,
1655 nativeBridgeEnabled: NativeBridgeEnabled,
1656 nativeBridgeHostArchName: variables.DeviceArch,
1657 nativeBridgeRelativePath: variables.NativeBridgeRelativePath,
1658 })
dimitry1f33e402019-03-26 12:39:31 +01001659 }
1660
Colin Crossa6845402020-11-16 15:08:19 -08001661 // An optional secondary NativeBridge device target.
dimitry1f33e402019-03-26 12:39:31 +01001662 if variables.DeviceSecondaryArch != nil && *variables.DeviceSecondaryArch != "" &&
1663 variables.NativeBridgeSecondaryArch != nil && *variables.NativeBridgeSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001664 addTarget(targetConfig{
1665 os: Android,
1666 archName: *variables.NativeBridgeSecondaryArch,
1667 archVariant: variables.NativeBridgeSecondaryArchVariant,
1668 cpuVariant: variables.NativeBridgeSecondaryCpuVariant,
1669 abi: variables.NativeBridgeSecondaryAbi,
1670 nativeBridgeEnabled: NativeBridgeEnabled,
1671 nativeBridgeHostArchName: variables.DeviceSecondaryArch,
1672 nativeBridgeRelativePath: variables.NativeBridgeSecondaryRelativePath,
1673 })
dimitry1f33e402019-03-26 12:39:31 +01001674 }
Colin Cross4225f652015-09-17 14:33:42 -07001675 }
1676
Colin Crossa1ad8d12016-06-01 17:09:44 -07001677 if targetErr != nil {
1678 return nil, targetErr
1679 }
1680
1681 return targets, nil
Colin Cross4225f652015-09-17 14:33:42 -07001682}
1683
Colin Crossbb2e2b72016-12-08 17:23:53 -08001684// hasArmAbi returns true if arch has at least one arm ABI
1685func hasArmAbi(arch Arch) bool {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001686 return PrefixInList(arch.Abi, "arm")
Colin Crossbb2e2b72016-12-08 17:23:53 -08001687}
1688
Lev Rumyantsev34581212021-10-13 09:47:59 -07001689// hasArmAndroidArch returns true if targets has at least
1690// one arm Android arch (possibly native bridged)
Colin Cross4247f0d2017-04-13 16:56:14 -07001691func hasArmAndroidArch(targets []Target) bool {
1692 for _, target := range targets {
Lev Rumyantsev34581212021-10-13 09:47:59 -07001693 if target.Os == Android &&
1694 (target.Arch.ArchType == Arm || target.Arch.ArchType == Arm64) {
Victor Khimenko5eb8ec12018-03-21 20:30:54 +01001695 return true
1696 }
1697 }
1698 return false
1699}
1700
Colin Crossa6845402020-11-16 15:08:19 -08001701// archConfig describes a built-in configuration.
Dan Albert4098deb2016-10-19 14:04:41 -07001702type archConfig struct {
1703 arch string
1704 archVariant string
1705 cpuVariant string
1706 abi []string
1707}
1708
Dan Albertf1d14c72020-07-30 14:32:55 -07001709// getNdkAbisConfig returns the list of archConfigs that are used for bulding
1710// the API stubs and static libraries that are included in the NDK. These are
1711// built *without Neon*, because non-Neon is still supported and building these
1712// with Neon will break those users.
Dan Albert4098deb2016-10-19 14:04:41 -07001713func getNdkAbisConfig() []archConfig {
1714 return []archConfig{
Tamas Petzbca786d2021-01-20 18:56:33 +01001715 {"arm64", "armv8-a-branchprot", "", []string{"arm64-v8a"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001716 {"arm", "armv7-a", "", []string{"armeabi-v7a"}},
Dan Albert4098deb2016-10-19 14:04:41 -07001717 {"x86_64", "", "", []string{"x86_64"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001718 {"x86", "", "", []string{"x86"}},
Dan Albert4098deb2016-10-19 14:04:41 -07001719 }
1720}
1721
Colin Crossa6845402020-11-16 15:08:19 -08001722// getAmlAbisConfig returns a list of archConfigs for the ABIs supported by mainline modules.
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001723func getAmlAbisConfig() []archConfig {
1724 return []archConfig{
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001725 {"arm64", "armv8-a", "", []string{"arm64-v8a"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001726 {"arm", "armv7-a-neon", "", []string{"armeabi-v7a"}},
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001727 {"x86_64", "", "", []string{"x86_64"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001728 {"x86", "", "", []string{"x86"}},
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001729 }
1730}
1731
Colin Crossa6845402020-11-16 15:08:19 -08001732// decodeArchSettings converts a list of archConfigs into a list of Targets for the given OsType.
Liz Kammerb7f33662022-02-28 14:16:16 -05001733func decodeAndroidArchSettings(archConfigs []archConfig) ([]Target, error) {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001734 var ret []Target
Dan Willemsen322acaf2016-01-12 23:07:05 -08001735
Dan Albert4098deb2016-10-19 14:04:41 -07001736 for _, config := range archConfigs {
Liz Kammerb7f33662022-02-28 14:16:16 -05001737 arch, err := decodeArch(Android, config.arch, &config.archVariant,
Colin Crossa74ca042019-01-31 14:31:51 -08001738 &config.cpuVariant, config.abi)
Dan Willemsen322acaf2016-01-12 23:07:05 -08001739 if err != nil {
1740 return nil, err
1741 }
Colin Cross3b19f5d2019-09-17 14:45:31 -07001742
Colin Crossa1ad8d12016-06-01 17:09:44 -07001743 ret = append(ret, Target{
1744 Os: Android,
1745 Arch: arch,
1746 })
Dan Willemsen322acaf2016-01-12 23:07:05 -08001747 }
1748
1749 return ret, nil
1750}
1751
Colin Crossa6845402020-11-16 15:08:19 -08001752// decodeArch converts a set of strings from product variables into an Arch struct.
Colin Crossa74ca042019-01-31 14:31:51 -08001753func decodeArch(os OsType, arch string, archVariant, cpuVariant *string, abi []string) (Arch, error) {
Colin Crossa6845402020-11-16 15:08:19 -08001754 // Verify the arch is valid
Colin Crosseeabb892015-11-20 13:07:51 -08001755 archType, ok := archTypeMap[arch]
1756 if !ok {
1757 return Arch{}, fmt.Errorf("unknown arch %q", arch)
1758 }
Colin Cross4225f652015-09-17 14:33:42 -07001759
Colin Crosseeabb892015-11-20 13:07:51 -08001760 a := Arch{
Colin Cross4225f652015-09-17 14:33:42 -07001761 ArchType: archType,
Colin Crossa6845402020-11-16 15:08:19 -08001762 ArchVariant: String(archVariant),
1763 CpuVariant: String(cpuVariant),
Colin Crossa74ca042019-01-31 14:31:51 -08001764 Abi: abi,
Colin Crosseeabb892015-11-20 13:07:51 -08001765 }
1766
Colin Crossa6845402020-11-16 15:08:19 -08001767 // Convert generic arch variants into the empty string.
Colin Crosseeabb892015-11-20 13:07:51 -08001768 if a.ArchVariant == a.ArchType.Name || a.ArchVariant == "generic" {
1769 a.ArchVariant = ""
1770 }
1771
Colin Crossa6845402020-11-16 15:08:19 -08001772 // Convert generic CPU variants into the empty string.
Colin Crosseeabb892015-11-20 13:07:51 -08001773 if a.CpuVariant == a.ArchType.Name || a.CpuVariant == "generic" {
1774 a.CpuVariant = ""
1775 }
1776
Liz Kammer2c2afe22022-02-11 11:35:03 -05001777 if a.ArchVariant != "" {
1778 if validArchVariants := archVariants[archType]; !InList(a.ArchVariant, validArchVariants) {
1779 return Arch{}, fmt.Errorf("[%q] unknown arch variant %q, support variants: %q", archType, a.ArchVariant, validArchVariants)
1780 }
1781 }
1782
1783 if a.CpuVariant != "" {
1784 if validCpuVariants := cpuVariants[archType]; !InList(a.CpuVariant, validCpuVariants) {
1785 return Arch{}, fmt.Errorf("[%q] unknown cpu variant %q, support variants: %q", archType, a.CpuVariant, validCpuVariants)
1786 }
1787 }
1788
Colin Crossa6845402020-11-16 15:08:19 -08001789 // Filter empty ABIs out of the list.
Colin Crosseeabb892015-11-20 13:07:51 -08001790 for i := 0; i < len(a.Abi); i++ {
1791 if a.Abi[i] == "" {
1792 a.Abi = append(a.Abi[:i], a.Abi[i+1:]...)
1793 i--
1794 }
1795 }
1796
Liz Kammere8303bd2022-02-16 09:02:48 -05001797 // Set ArchFeatures from the arch type. for Android OS, other os-es do not specify features
1798 if os == Android {
1799 if featureMap, ok := androidArchFeatureMap[archType]; ok {
Dan Willemsen01a3c252019-01-11 19:02:16 -08001800 a.ArchFeatures = featureMap[a.ArchVariant]
1801 }
Colin Crossc5c24ad2015-11-20 15:35:00 -08001802 }
1803
Colin Crosseeabb892015-11-20 13:07:51 -08001804 return a, nil
Colin Cross4225f652015-09-17 14:33:42 -07001805}
1806
Colin Crossa6845402020-11-16 15:08:19 -08001807// filterMultilibTargets takes a list of Targets and a multilib value and returns a new list of
1808// Targets containing only those that have the given multilib value.
Colin Cross69617d32016-09-06 10:39:07 -07001809func filterMultilibTargets(targets []Target, multilib string) []Target {
1810 var ret []Target
1811 for _, t := range targets {
1812 if t.Arch.ArchType.Multilib == multilib {
1813 ret = append(ret, t)
1814 }
1815 }
1816 return ret
1817}
1818
Colin Crossa6845402020-11-16 15:08:19 -08001819// getCommonTargets returns the set of Os specific common architecture targets for each Os in a list
1820// of targets.
Nan Zhangdb0b9a32017-02-27 10:12:13 -08001821func getCommonTargets(targets []Target) []Target {
1822 var ret []Target
1823 set := make(map[string]bool)
1824
1825 for _, t := range targets {
1826 if _, found := set[t.Os.String()]; !found {
1827 set[t.Os.String()] = true
1828 ret = append(ret, commonTargetMap[t.Os.String()])
1829 }
1830 }
1831
1832 return ret
1833}
1834
Sam Delmericocc271e22022-06-01 15:45:02 +00001835// FirstTarget takes a list of Targets and a list of multilib values and returns a list of Targets
Colin Crossa6845402020-11-16 15:08:19 -08001836// that contains zero or one Target for each OsType, selecting the one that matches the earliest
1837// filter.
Sam Delmericocc271e22022-06-01 15:45:02 +00001838func FirstTarget(targets []Target, filters ...string) []Target {
Jiyong Park22101982020-09-17 19:09:58 +09001839 // find the first target from each OS
1840 var ret []Target
1841 hasHost := false
1842 set := make(map[OsType]bool)
1843
Colin Cross6b4a32d2017-12-05 13:42:45 -08001844 for _, filter := range filters {
1845 buildTargets := filterMultilibTargets(targets, filter)
Jiyong Park22101982020-09-17 19:09:58 +09001846 for _, t := range buildTargets {
1847 if _, found := set[t.Os]; !found {
1848 hasHost = hasHost || (t.Os.Class == Host)
1849 set[t.Os] = true
1850 ret = append(ret, t)
1851 }
Colin Cross6b4a32d2017-12-05 13:42:45 -08001852 }
1853 }
Jiyong Park22101982020-09-17 19:09:58 +09001854 return ret
Colin Cross6b4a32d2017-12-05 13:42:45 -08001855}
1856
Colin Crossa6845402020-11-16 15:08:19 -08001857// decodeMultilibTargets uses the module's multilib setting to select one or more targets from a
1858// list of Targets.
Colin Crossee0bc3b2018-10-02 22:01:37 -07001859func decodeMultilibTargets(multilib string, targets []Target, prefer32 bool) ([]Target, error) {
Colin Crossa6845402020-11-16 15:08:19 -08001860 var buildTargets []Target
Colin Cross6b4a32d2017-12-05 13:42:45 -08001861
Colin Cross4225f652015-09-17 14:33:42 -07001862 switch multilib {
1863 case "common":
Colin Cross6b4a32d2017-12-05 13:42:45 -08001864 buildTargets = getCommonTargets(targets)
1865 case "common_first":
1866 buildTargets = getCommonTargets(targets)
1867 if prefer32 {
Sam Delmericocc271e22022-06-01 15:45:02 +00001868 buildTargets = append(buildTargets, FirstTarget(targets, "lib32", "lib64")...)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001869 } else {
Sam Delmericocc271e22022-06-01 15:45:02 +00001870 buildTargets = append(buildTargets, FirstTarget(targets, "lib64", "lib32")...)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001871 }
Colin Cross4225f652015-09-17 14:33:42 -07001872 case "both":
Colin Cross8b74d172016-09-13 09:59:14 -07001873 if prefer32 {
1874 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib32")...)
1875 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib64")...)
1876 } else {
1877 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib64")...)
1878 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib32")...)
1879 }
Colin Cross4225f652015-09-17 14:33:42 -07001880 case "32":
Colin Cross69617d32016-09-06 10:39:07 -07001881 buildTargets = filterMultilibTargets(targets, "lib32")
Colin Cross4225f652015-09-17 14:33:42 -07001882 case "64":
Colin Cross69617d32016-09-06 10:39:07 -07001883 buildTargets = filterMultilibTargets(targets, "lib64")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001884 case "first":
1885 if prefer32 {
Sam Delmericocc271e22022-06-01 15:45:02 +00001886 buildTargets = FirstTarget(targets, "lib32", "lib64")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001887 } else {
Sam Delmericocc271e22022-06-01 15:45:02 +00001888 buildTargets = FirstTarget(targets, "lib64", "lib32")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001889 }
Victor Chang9448e8f2020-09-14 15:34:16 +01001890 case "first_prefer32":
Sam Delmericocc271e22022-06-01 15:45:02 +00001891 buildTargets = FirstTarget(targets, "lib32", "lib64")
Colin Cross69617d32016-09-06 10:39:07 -07001892 case "prefer32":
Colin Cross3dceee32018-09-06 10:19:57 -07001893 buildTargets = filterMultilibTargets(targets, "lib32")
1894 if len(buildTargets) == 0 {
1895 buildTargets = filterMultilibTargets(targets, "lib64")
1896 }
Dan Willemsen47450072021-10-19 20:24:49 -07001897 case "darwin_universal":
1898 buildTargets = filterMultilibTargets(targets, "lib64")
1899 // Reverse the targets so that the first architecture can depend on the second
1900 // architecture module in order to merge the outputs.
1901 reverseSliceInPlace(buildTargets)
1902 case "darwin_universal_common_first":
1903 archTargets := filterMultilibTargets(targets, "lib64")
1904 reverseSliceInPlace(archTargets)
1905 buildTargets = append(getCommonTargets(targets), archTargets...)
Colin Cross4225f652015-09-17 14:33:42 -07001906 default:
Victor Chang9448e8f2020-09-14 15:34:16 +01001907 return nil, fmt.Errorf(`compile_multilib must be "both", "first", "32", "64", "prefer32" or "first_prefer32" found %q`,
Colin Cross4225f652015-09-17 14:33:42 -07001908 multilib)
Colin Cross4225f652015-09-17 14:33:42 -07001909 }
1910
Colin Crossa1ad8d12016-06-01 17:09:44 -07001911 return buildTargets, nil
Colin Cross4225f652015-09-17 14:33:42 -07001912}
Jingwen Chen5d864492021-02-24 07:20:12 -05001913
Chris Parsonsc424b762021-04-29 18:06:50 -04001914func (m *ModuleBase) getArchPropertySet(propertySet interface{}, archType ArchType) interface{} {
1915 archString := archType.Field
1916 for i := range m.archProperties {
1917 if m.archProperties[i] == nil {
1918 // Skip over nil properties
1919 continue
1920 }
1921
1922 // Not archProperties are usable; this function looks for properties of a very specific
1923 // form, and ignores the rest.
1924 for _, archProperty := range m.archProperties[i] {
1925 // archPropValue is a property struct, we are looking for the form:
1926 // `arch: { arm: { key: value, ... }}`
1927 archPropValue := reflect.ValueOf(archProperty).Elem()
1928
1929 // Unwrap src so that it should looks like a pointer to `arm: { key: value, ... }`
1930 src := archPropValue.FieldByName("Arch").Elem()
1931
1932 // Step into non-nil pointers to structs in the src value.
1933 if src.Kind() == reflect.Ptr {
1934 if src.IsNil() {
1935 continue
1936 }
1937 src = src.Elem()
1938 }
1939
1940 // Find the requested field (e.g. arm, x86) in the src struct.
1941 src = src.FieldByName(archString)
1942
1943 // We only care about structs.
1944 if !src.IsValid() || src.Kind() != reflect.Struct {
1945 continue
1946 }
1947
1948 // If the value of the field is a struct then step into the
1949 // BlueprintEmbed field. The special "BlueprintEmbed" name is
1950 // used by createArchPropTypeDesc to embed the arch properties
1951 // in the parent struct, so the src arch prop should be in this
1952 // field.
1953 //
1954 // See createArchPropTypeDesc for more details on how Arch-specific
1955 // module properties are processed from the nested props and written
1956 // into the module's archProperties.
1957 src = src.FieldByName("BlueprintEmbed")
1958
1959 // Clone the destination prop, since we want a unique prop struct per arch.
1960 propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1961
1962 // Copy the located property struct into the cloned destination property struct.
1963 err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)
1964 if err != nil {
1965 // This is fine, it just means the src struct doesn't match the type of propertySet.
1966 continue
1967 }
1968
1969 return propertySetClone
1970 }
1971 }
1972 // No property set was found specific to the given arch, so return an empty
1973 // property set.
1974 return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1975}
1976
1977// getMultilibPropertySet returns a property set struct matching the type of
1978// `propertySet`, containing multilib-specific module properties for the given architecture.
1979// If no multilib-specific properties exist for the given architecture, returns an empty property
1980// set matching `propertySet`'s type.
1981func (m *ModuleBase) getMultilibPropertySet(propertySet interface{}, archType ArchType) interface{} {
1982 // archType.Multilib is lowercase (for example, lib32) but property struct field is
1983 // capitalized, such as Lib32, so use strings.Title to capitalize it.
1984 multiLibString := strings.Title(archType.Multilib)
1985
1986 for i := range m.archProperties {
1987 if m.archProperties[i] == nil {
1988 // Skip over nil properties
1989 continue
1990 }
1991
1992 // Not archProperties are usable; this function looks for properties of a very specific
1993 // form, and ignores the rest.
1994 for _, archProperties := range m.archProperties[i] {
1995 // archPropValue is a property struct, we are looking for the form:
1996 // `multilib: { lib32: { key: value, ... }}`
1997 archPropValue := reflect.ValueOf(archProperties).Elem()
1998
1999 // Unwrap src so that it should looks like a pointer to `lib32: { key: value, ... }`
2000 src := archPropValue.FieldByName("Multilib").Elem()
2001
2002 // Step into non-nil pointers to structs in the src value.
2003 if src.Kind() == reflect.Ptr {
2004 if src.IsNil() {
2005 // Ignore nil pointers.
2006 continue
2007 }
2008 src = src.Elem()
2009 }
2010
2011 // Find the requested field (e.g. lib32) in the src struct.
2012 src = src.FieldByName(multiLibString)
2013
2014 // We only care about valid struct pointers.
2015 if !src.IsValid() || src.Kind() != reflect.Ptr || src.Elem().Kind() != reflect.Struct {
2016 continue
2017 }
2018
2019 // Get the zero value for the requested property set.
2020 propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2021
2022 // Copy the located property struct into the "zero" property set struct.
2023 err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)
2024
2025 if err != nil {
2026 // This is fine, it just means the src struct doesn't match.
2027 continue
2028 }
2029
2030 return propertySetClone
2031 }
2032 }
2033
2034 // There were no multilib properties specifically matching the given archtype.
2035 // Return zeroed value.
2036 return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2037}
2038
Liz Kammerb6dbc872021-05-14 15:14:40 -04002039// ArchVariantContext defines the limited context necessary to retrieve arch_variant properties.
2040type ArchVariantContext interface {
2041 ModuleErrorf(fmt string, args ...interface{})
2042 PropertyErrorf(property, fmt string, args ...interface{})
2043}
2044
Liz Kammer9abd62d2021-05-21 08:37:59 -04002045// ArchVariantProperties represents a map of arch-variant config strings to a property interface{}.
2046type ArchVariantProperties map[string]interface{}
2047
2048// ConfigurationAxisToArchVariantProperties represents a map of bazel.ConfigurationAxis to
2049// ArchVariantProperties, such that each independent arch-variant axis maps to the
2050// configs/properties for that axis.
2051type ConfigurationAxisToArchVariantProperties map[bazel.ConfigurationAxis]ArchVariantProperties
2052
2053// GetArchVariantProperties returns a ConfigurationAxisToArchVariantProperties where the
2054// arch-variant properties correspond to the values of the properties of the 'propertySet' struct
2055// that are specific to that axis/configuration. Each axis is independent, containing
2056// non-overlapping configs that correspond to the various "arch-variant" support, at this time:
2057// arches (including multilib)
2058// oses
2059// arch+os combinations
Jingwen Chen5d864492021-02-24 07:20:12 -05002060//
Liz Kammer9abd62d2021-05-21 08:37:59 -04002061// For example, passing a struct { Foo bool, Bar string } will return an interface{} that can be
2062// type asserted back into the same struct, containing the config-specific property value specified
2063// by the module if defined.
Chris Parsonsc424b762021-04-29 18:06:50 -04002064//
2065// Arch-specific properties may come from an arch stanza or a multilib stanza; properties
2066// in these stanzas are combined.
2067// For example: `arch: { x86: { Foo: ["bar"] } }, multilib: { lib32: {` Foo: ["baz"] } }`
2068// will result in `Foo: ["bar", "baz"]` being returned for architecture x86, if the given
2069// propertyset contains `Foo []string`.
Liz Kammer9abd62d2021-05-21 08:37:59 -04002070func (m *ModuleBase) GetArchVariantProperties(ctx ArchVariantContext, propertySet interface{}) ConfigurationAxisToArchVariantProperties {
Jingwen Chen5d864492021-02-24 07:20:12 -05002071 // Return value of the arch types to the prop values for that arch.
Liz Kammer9abd62d2021-05-21 08:37:59 -04002072 axisToProps := ConfigurationAxisToArchVariantProperties{}
Jingwen Chen5d864492021-02-24 07:20:12 -05002073
2074 // Nothing to do for non-arch-specific modules.
2075 if !m.ArchSpecific() {
Liz Kammer9abd62d2021-05-21 08:37:59 -04002076 return axisToProps
Jingwen Chen5d864492021-02-24 07:20:12 -05002077 }
2078
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002079 dstType := reflect.ValueOf(propertySet).Type()
2080 var archProperties []interface{}
2081
2082 // First find the property set in the module that corresponds to the requested
Usta851a3272022-01-05 23:42:33 -05002083 // one. m.archProperties[i] corresponds to m.GetProperties()[i].
2084 for i, generalProp := range m.GetProperties() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002085 srcType := reflect.ValueOf(generalProp).Type()
2086 if srcType == dstType {
2087 archProperties = m.archProperties[i]
Liz Kammer135bf552021-08-11 10:46:06 -04002088 axisToProps[bazel.NoConfigAxis] = ArchVariantProperties{"": generalProp}
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002089 break
2090 }
2091 }
2092
2093 if archProperties == nil {
2094 // This module does not have the property set requested
Liz Kammer9abd62d2021-05-21 08:37:59 -04002095 return axisToProps
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002096 }
2097
Liz Kammer9abd62d2021-05-21 08:37:59 -04002098 archToProp := ArchVariantProperties{}
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002099 // For each arch type (x86, arm64, etc.)
Chris Parsonsc424b762021-04-29 18:06:50 -04002100 for _, arch := range ArchTypeList() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002101 // Arch properties are sometimes sharded (see createArchPropTypeDesc() ).
2102 // Iterate over ever shard and extract a struct with the same type as the
2103 // input one that contains the data specific to that arch.
2104 propertyStructs := make([]reflect.Value, 0)
2105 for _, archProperty := range archProperties {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02002106 archTypeStruct, ok := getArchTypeStruct(ctx, archProperty, arch)
2107 if ok {
2108 propertyStructs = append(propertyStructs, archTypeStruct)
2109 }
2110 multilibStruct, ok := getMultilibStruct(ctx, archProperty, arch)
2111 if ok {
2112 propertyStructs = append(propertyStructs, multilibStruct)
2113 }
Jingwen Chen5d864492021-02-24 07:20:12 -05002114 }
2115
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002116 // Create a new instance of the requested property set
2117 value := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2118
Chris Parsonsa37e1952021-09-28 16:47:36 -04002119 archToProp[arch.Name] = mergeStructs(ctx, propertyStructs, value)
Jingwen Chen5d864492021-02-24 07:20:12 -05002120 }
Liz Kammer9abd62d2021-05-21 08:37:59 -04002121 axisToProps[bazel.ArchConfigurationAxis] = archToProp
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002122
Liz Kammer9abd62d2021-05-21 08:37:59 -04002123 osToProp := ArchVariantProperties{}
2124 archOsToProp := ArchVariantProperties{}
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002125
Liz Kammerfdd72e62021-10-11 15:41:03 -04002126 linuxStructs := getTargetStructs(ctx, archProperties, "Linux")
2127 bionicStructs := getTargetStructs(ctx, archProperties, "Bionic")
2128 hostStructs := getTargetStructs(ctx, archProperties, "Host")
Colin Crossa98d36d2022-03-07 14:39:49 -08002129 hostLinuxStructs := getTargetStructs(ctx, archProperties, "Host_linux")
Liz Kammerfdd72e62021-10-11 15:41:03 -04002130 hostNotWindowsStructs := getTargetStructs(ctx, archProperties, "Not_windows")
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002131
Liz Kammer9abd62d2021-05-21 08:37:59 -04002132 // For android, linux, ...
2133 for _, os := range osTypeList {
2134 if os == CommonOS {
2135 // It looks like this OS value is not used in Blueprint files
2136 continue
2137 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002138 osStructs := make([]reflect.Value, 0)
Liz Kammerfdd72e62021-10-11 15:41:03 -04002139
2140 osSpecificStructs := getTargetStructs(ctx, archProperties, os.Field)
2141 if os.Class == Host {
2142 osStructs = append(osStructs, hostStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002143 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002144 if os.Linux() {
2145 osStructs = append(osStructs, linuxStructs...)
2146 }
2147 if os.Bionic() {
2148 osStructs = append(osStructs, bionicStructs...)
2149 }
Colin Crossa98d36d2022-03-07 14:39:49 -08002150 if os.Linux() && os.Class == Host {
2151 osStructs = append(osStructs, hostLinuxStructs...)
2152 }
Liz Kammerfdd72e62021-10-11 15:41:03 -04002153
2154 if os == LinuxMusl {
2155 osStructs = append(osStructs, getTargetStructs(ctx, archProperties, "Musl")...)
2156 }
2157 if os == Linux {
2158 osStructs = append(osStructs, getTargetStructs(ctx, archProperties, "Glibc")...)
2159 }
2160
2161 osStructs = append(osStructs, osSpecificStructs...)
2162
2163 if os.Class == Host && os != Windows {
2164 osStructs = append(osStructs, hostNotWindowsStructs...)
2165 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002166 osToProp[os.Name] = mergeStructs(ctx, osStructs, propertySet)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002167
Liz Kammer9abd62d2021-05-21 08:37:59 -04002168 // For arm, x86, ...
2169 for _, arch := range osArchTypeMap[os] {
Chris Parsonsa37e1952021-09-28 16:47:36 -04002170 osArchStructs := make([]reflect.Value, 0)
2171
Chris Parsonsa37e1952021-09-28 16:47:36 -04002172 // Auto-combine with Linux_ and Bionic_ targets. This potentially results in
2173 // repetition and select() bloat, but use of Linux_* and Bionic_* targets is rare.
2174 // TODO(b/201423152): Look into cleanup.
2175 if os.Linux() {
2176 targetField := "Linux_" + arch.Name
Liz Kammerfdd72e62021-10-11 15:41:03 -04002177 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2178 osArchStructs = append(osArchStructs, targetStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002179 }
2180 if os.Bionic() {
2181 targetField := "Bionic_" + arch.Name
Liz Kammerfdd72e62021-10-11 15:41:03 -04002182 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2183 osArchStructs = append(osArchStructs, targetStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002184 }
Colin Cross2d295a22022-03-07 14:46:20 -08002185 if os == LinuxMusl {
2186 targetField := "Musl_" + arch.Name
2187 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2188 osArchStructs = append(osArchStructs, targetStructs...)
2189 }
2190 if os == Linux {
2191 targetField := "Glibc_" + arch.Name
2192 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2193 osArchStructs = append(osArchStructs, targetStructs...)
2194 }
Chris Parsonsa37e1952021-09-28 16:47:36 -04002195
Liz Kammerfdd72e62021-10-11 15:41:03 -04002196 targetField := GetCompoundTargetField(os, arch)
2197 targetName := fmt.Sprintf("%s_%s", os.Name, arch.Name)
2198 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2199 osArchStructs = append(osArchStructs, targetStructs...)
2200
Chris Parsonsa37e1952021-09-28 16:47:36 -04002201 archOsToProp[targetName] = mergeStructs(ctx, osArchStructs, propertySet)
Liz Kammer9abd62d2021-05-21 08:37:59 -04002202 }
2203 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002204
Liz Kammer9abd62d2021-05-21 08:37:59 -04002205 axisToProps[bazel.OsConfigurationAxis] = osToProp
2206 axisToProps[bazel.OsArchConfigurationAxis] = archOsToProp
Liz Kammer9abd62d2021-05-21 08:37:59 -04002207 return axisToProps
Jingwen Chen5d864492021-02-24 07:20:12 -05002208}
Jingwen Chen91220d72021-03-24 02:18:33 -04002209
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002210// Returns a struct matching the propertySet interface, containing properties specific to the targetName
2211// For example, given these arguments:
2212// propertySet = BaseCompilerProperties
2213// targetName = "android_arm"
2214// And given this Android.bp fragment:
2215// target:
2216// android_arm: {
2217// srcs: ["foo.c"],
2218// }
2219// android_arm64: {
2220// srcs: ["bar.c"],
2221// }
2222// }
2223// This would return a BaseCompilerProperties with BaseCompilerProperties.Srcs = ["foo.c"]
Liz Kammerfdd72e62021-10-11 15:41:03 -04002224func getTargetStructs(ctx ArchVariantContext, archProperties []interface{}, targetName string) []reflect.Value {
2225 var propertyStructs []reflect.Value
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002226 for _, archProperty := range archProperties {
2227 archPropValues := reflect.ValueOf(archProperty).Elem()
2228 targetProp := archPropValues.FieldByName("Target").Elem()
2229 targetStruct, ok := getChildPropertyStruct(ctx, targetProp, targetName, targetName)
2230 if ok {
2231 propertyStructs = append(propertyStructs, targetStruct)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002232 } else {
Liz Kammerfdd72e62021-10-11 15:41:03 -04002233 return []reflect.Value{}
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002234 }
2235 }
2236
Liz Kammerfdd72e62021-10-11 15:41:03 -04002237 return propertyStructs
Chris Parsonsa37e1952021-09-28 16:47:36 -04002238}
2239
2240func mergeStructs(ctx ArchVariantContext, propertyStructs []reflect.Value, propertySet interface{}) interface{} {
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002241 // Create a new instance of the requested property set
2242 value := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2243
2244 // Merge all the structs together
2245 for _, propertyStruct := range propertyStructs {
2246 mergePropertyStruct(ctx, value, propertyStruct)
2247 }
2248
2249 return value
2250}
Liz Kammere8303bd2022-02-16 09:02:48 -05002251
2252func printArchTypeStarlarkDict(dict map[ArchType][]string) string {
2253 valDict := make(map[string]string, len(dict))
2254 for k, v := range dict {
2255 valDict[k.String()] = starlark_fmt.PrintStringList(v, 1)
2256 }
2257 return starlark_fmt.PrintDict(valDict, 0)
2258}
2259
2260func printArchTypeNestedStarlarkDict(dict map[ArchType]map[string][]string) string {
2261 valDict := make(map[string]string, len(dict))
2262 for k, v := range dict {
2263 valDict[k.String()] = starlark_fmt.PrintStringListDict(v, 1)
2264 }
2265 return starlark_fmt.PrintDict(valDict, 0)
2266}
2267
2268func StarlarkArchConfigurations() string {
2269 return fmt.Sprintf(`
2270_arch_to_variants = %s
2271
2272_arch_to_cpu_variants = %s
2273
2274_arch_to_features = %s
2275
2276_android_arch_feature_for_arch_variant = %s
2277
2278arch_to_variants = _arch_to_variants
2279arch_to_cpu_variants = _arch_to_cpu_variants
2280arch_to_features = _arch_to_features
2281android_arch_feature_for_arch_variants = _android_arch_feature_for_arch_variant
2282`, printArchTypeStarlarkDict(archVariants),
2283 printArchTypeStarlarkDict(cpuVariants),
2284 printArchTypeStarlarkDict(archFeatures),
2285 printArchTypeNestedStarlarkDict(androidArchFeatureMap),
2286 )
2287}