blob: 0f07b26c955433033533fdda8290491c87d738c9 [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"
25
Colin Cross0f7d2ef2019-10-16 11:03:10 -070026 "github.com/google/blueprint"
Colin Cross617b88a2020-08-24 18:04:09 -070027 "github.com/google/blueprint/bootstrap"
Colin Crossf6566ed2015-03-24 11:13:38 -070028 "github.com/google/blueprint/proptools"
Colin Cross3f40fa42015-01-30 17:27:36 -080029)
30
Colin Cross3f40fa42015-01-30 17:27:36 -080031/*
32Example blueprints file containing all variant property groups, with comment listing what type
33of variants get properties in that group:
34
35module {
36 arch: {
37 arm: {
38 // Host or device variants with arm architecture
39 },
40 arm64: {
41 // Host or device variants with arm64 architecture
42 },
Colin Cross3f40fa42015-01-30 17:27:36 -080043 x86: {
44 // Host or device variants with x86 architecture
45 },
46 x86_64: {
47 // Host or device variants with x86_64 architecture
48 },
49 },
50 multilib: {
51 lib32: {
52 // Host or device variants for 32-bit architectures
53 },
54 lib64: {
55 // Host or device variants for 64-bit architectures
56 },
57 },
58 target: {
59 android: {
Martin Stjernholme284b482020-09-23 21:03:27 +010060 // Device variants (implies Bionic)
Colin Cross3f40fa42015-01-30 17:27:36 -080061 },
62 host: {
63 // Host variants
64 },
Martin Stjernholme284b482020-09-23 21:03:27 +010065 bionic: {
66 // Bionic (device and host) variants
67 },
68 linux_bionic: {
69 // Bionic host variants
70 },
71 linux: {
72 // Bionic (device and host) and Linux glibc variants
73 },
Dan Willemsen5746bd42017-10-02 19:42:01 -070074 linux_glibc: {
Martin Stjernholme284b482020-09-23 21:03:27 +010075 // Linux host variants (using non-Bionic libc)
Colin Cross3f40fa42015-01-30 17:27:36 -080076 },
77 darwin: {
78 // Darwin host variants
79 },
80 windows: {
81 // Windows host variants
82 },
83 not_windows: {
84 // Non-windows host variants
85 },
Martin Stjernholme284b482020-09-23 21:03:27 +010086 android_arm: {
87 // Any <os>_<arch> combination restricts to that os and arch
88 },
Colin Cross3f40fa42015-01-30 17:27:36 -080089 },
90}
91*/
Colin Cross7d5136f2015-05-11 13:39:40 -070092
Colin Cross3f40fa42015-01-30 17:27:36 -080093// An Arch indicates a single CPU architecture.
94type Arch struct {
Colin Crossa6845402020-11-16 15:08:19 -080095 // The type of the architecture (arm, arm64, x86, or x86_64).
96 ArchType ArchType
97
98 // The variant of the architecture, for example "armv7-a" or "armv7-a-neon" for arm.
99 ArchVariant string
100
101 // The variant of the CPU, for example "cortex-a53" for arm64.
102 CpuVariant string
103
104 // The list of Android app ABIs supported by the CPU architecture, for example "arm64-v8a".
105 Abi []string
106
107 // The list of arch-specific features supported by the CPU architecture, for example "neon".
Colin Crossc5c24ad2015-11-20 15:35:00 -0800108 ArchFeatures []string
Colin Cross3f40fa42015-01-30 17:27:36 -0800109}
110
Colin Crossa6845402020-11-16 15:08:19 -0800111// String returns the Arch as a string. The value is used as the name of the variant created
112// by archMutator.
Colin Cross3f40fa42015-01-30 17:27:36 -0800113func (a Arch) String() string {
Colin Crossd3ba0392015-05-07 14:11:29 -0700114 s := a.ArchType.String()
Colin Cross3f40fa42015-01-30 17:27:36 -0800115 if a.ArchVariant != "" {
116 s += "_" + a.ArchVariant
117 }
118 if a.CpuVariant != "" {
119 s += "_" + a.CpuVariant
120 }
121 return s
122}
123
Colin Crossa6845402020-11-16 15:08:19 -0800124// ArchType is used to define the 4 supported architecture types (arm, arm64, x86, x86_64), as
125// well as the "common" architecture used for modules that support multiple architectures, for
126// example Java modules.
Colin Cross3f40fa42015-01-30 17:27:36 -0800127type ArchType struct {
Colin Crossa6845402020-11-16 15:08:19 -0800128 // Name is the name of the architecture type, "arm", "arm64", "x86", or "x86_64".
129 Name string
130
131 // Field is the name of the field used in properties that refer to the architecture, e.g. "Arm64".
132 Field string
133
134 // Multilib is either "lib32" or "lib64" for 32-bit or 64-bit architectures.
Colin Crossec193632015-07-06 17:49:43 -0700135 Multilib string
Colin Cross3f40fa42015-01-30 17:27:36 -0800136}
137
Colin Crossa6845402020-11-16 15:08:19 -0800138// String returns the name of the ArchType.
139func (a ArchType) String() string {
140 return a.Name
141}
142
143const COMMON_VARIANT = "common"
144
145var (
146 archTypeList []ArchType
147
148 Arm = newArch("arm", "lib32")
149 Arm64 = newArch("arm64", "lib64")
150 X86 = newArch("x86", "lib32")
151 X86_64 = newArch("x86_64", "lib64")
152
153 Common = ArchType{
154 Name: COMMON_VARIANT,
155 }
156)
157
158var archTypeMap = map[string]ArchType{}
159
Colin Crossec193632015-07-06 17:49:43 -0700160func newArch(name, multilib string) ArchType {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700161 archType := ArchType{
Colin Crossec193632015-07-06 17:49:43 -0700162 Name: name,
Dan Willemsenb1957a52016-06-23 23:44:54 -0700163 Field: proptools.FieldNameForProperty(name),
Colin Crossec193632015-07-06 17:49:43 -0700164 Multilib: multilib,
Colin Cross3f40fa42015-01-30 17:27:36 -0800165 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700166 archTypeList = append(archTypeList, archType)
Colin Crossa6845402020-11-16 15:08:19 -0800167 archTypeMap[name] = archType
Dan Willemsenb1957a52016-06-23 23:44:54 -0700168 return archType
Colin Cross3f40fa42015-01-30 17:27:36 -0800169}
170
Ustaeabf0f32021-12-06 15:17:23 -0500171// ArchTypeList returns a slice copy of the 4 supported ArchTypes for arm,
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000172// arm64, x86 and x86_64.
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700173func ArchTypeList() []ArchType {
174 return append([]ArchType(nil), archTypeList...)
175}
176
Colin Crossa6845402020-11-16 15:08:19 -0800177// MarshalText allows an ArchType to be serialized through any encoder that supports
178// encoding.TextMarshaler.
Colin Cross74ba9622019-02-11 15:11:14 -0800179func (a ArchType) MarshalText() ([]byte, error) {
Jeongik Chabec4d032021-04-15 08:55:38 +0900180 return []byte(a.String()), nil
Colin Cross74ba9622019-02-11 15:11:14 -0800181}
182
Colin Crossa6845402020-11-16 15:08:19 -0800183var _ encoding.TextMarshaler = ArchType{}
Colin Cross74ba9622019-02-11 15:11:14 -0800184
Colin Crossa6845402020-11-16 15:08:19 -0800185// UnmarshalText allows an ArchType to be deserialized through any decoder that supports
186// encoding.TextUnmarshaler.
Colin Cross74ba9622019-02-11 15:11:14 -0800187func (a *ArchType) UnmarshalText(text []byte) error {
188 if u, ok := archTypeMap[string(text)]; ok {
189 *a = u
190 return nil
191 }
192
193 return fmt.Errorf("unknown ArchType %q", text)
194}
195
Colin Crossa6845402020-11-16 15:08:19 -0800196var _ encoding.TextUnmarshaler = &ArchType{}
Colin Crossa1ad8d12016-06-01 17:09:44 -0700197
Colin Crossa6845402020-11-16 15:08:19 -0800198// OsClass is an enum that describes whether a variant of a module runs on the host, on the device,
199// or is generic.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700200type OsClass int
201
202const (
Colin Crossa6845402020-11-16 15:08:19 -0800203 // Generic is used for variants of modules that are not OS-specific.
Dan Willemsen0e2d97b2016-11-28 17:50:06 -0800204 Generic OsClass = iota
Colin Crossa6845402020-11-16 15:08:19 -0800205 // Device is used for variants of modules that run on the device.
Dan Willemsen0e2d97b2016-11-28 17:50:06 -0800206 Device
Colin Crossa6845402020-11-16 15:08:19 -0800207 // Host is used for variants of modules that run on the host.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700208 Host
Colin Crossa1ad8d12016-06-01 17:09:44 -0700209)
210
Colin Crossa6845402020-11-16 15:08:19 -0800211// String returns the OsClass as a string.
Colin Cross67a5c132017-05-09 13:45:28 -0700212func (class OsClass) String() string {
213 switch class {
214 case Generic:
215 return "generic"
216 case Device:
217 return "device"
218 case Host:
219 return "host"
Colin Cross67a5c132017-05-09 13:45:28 -0700220 default:
221 panic(fmt.Errorf("unknown class %d", class))
222 }
223}
224
Colin Crossa6845402020-11-16 15:08:19 -0800225// OsType describes an OS variant of a module.
226type OsType struct {
227 // Name is the name of the OS. It is also used as the name of the property in Android.bp
228 // files.
229 Name string
230
231 // Field is the name of the OS converted to an exported field name, i.e. with the first
232 // character capitalized.
233 Field string
234
235 // Class is the OsClass of the OS.
236 Class OsClass
237
238 // DefaultDisabled is set when the module variants for the OS should not be created unless
239 // the module explicitly requests them. This is used to limit Windows cross compilation to
240 // only modules that need it.
241 DefaultDisabled bool
242}
243
244// String returns the name of the OsType.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700245func (os OsType) String() string {
246 return os.Name
Colin Cross54c71122016-06-01 17:09:44 -0700247}
248
Colin Crossa6845402020-11-16 15:08:19 -0800249// Bionic returns true if the OS uses the Bionic libc runtime, i.e. if the OS is Android or
250// is Linux with Bionic.
Dan Willemsen866b5632017-09-22 12:28:24 -0700251func (os OsType) Bionic() bool {
252 return os == Android || os == LinuxBionic
253}
254
Colin Crossa6845402020-11-16 15:08:19 -0800255// Linux returns true if the OS uses the Linux kernel, i.e. if the OS is Android or is Linux
256// with or without the Bionic libc runtime.
Dan Willemsen866b5632017-09-22 12:28:24 -0700257func (os OsType) Linux() bool {
Colin Cross528d67e2021-07-23 22:23:07 +0000258 return os == Android || os == Linux || os == LinuxBionic || os == LinuxMusl
Dan Willemsen866b5632017-09-22 12:28:24 -0700259}
260
Colin Crossa6845402020-11-16 15:08:19 -0800261// newOsType constructs an OsType and adds it to the global lists.
262func newOsType(name string, class OsClass, defDisabled bool, archTypes ...ArchType) OsType {
263 checkCalledFromInit()
Colin Crossa1ad8d12016-06-01 17:09:44 -0700264 os := OsType{
265 Name: name,
Colin Crossa6845402020-11-16 15:08:19 -0800266 Field: proptools.FieldNameForProperty(name),
Colin Crossa1ad8d12016-06-01 17:09:44 -0700267 Class: class,
Dan Willemsen0a37a2a2016-11-13 10:16:05 -0800268
269 DefaultDisabled: defDisabled,
Colin Cross54c71122016-06-01 17:09:44 -0700270 }
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000271 osTypeList = append(osTypeList, os)
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800272
273 if _, found := commonTargetMap[name]; found {
274 panic(fmt.Errorf("Found Os type duplicate during OsType registration: %q", name))
275 } else {
Colin Crosse9fe2942020-11-10 18:12:15 -0800276 commonTargetMap[name] = Target{Os: os, Arch: CommonArch}
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800277 }
Colin Crossa6845402020-11-16 15:08:19 -0800278 osArchTypeMap[os] = archTypes
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800279
Colin Crossa1ad8d12016-06-01 17:09:44 -0700280 return os
281}
282
Colin Crossa6845402020-11-16 15:08:19 -0800283// osByName returns the OsType that has the given name, or NoOsType if none match.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700284func osByName(name string) OsType {
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000285 for _, os := range osTypeList {
Colin Crossa1ad8d12016-06-01 17:09:44 -0700286 if os.Name == name {
287 return os
288 }
289 }
290
291 return NoOsType
Dan Willemsen490fd492015-11-24 17:53:15 -0800292}
293
Colin Crossa6845402020-11-16 15:08:19 -0800294var (
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000295 // osTypeList contains a list of all the supported OsTypes, including ones not supported
Colin Crossa6845402020-11-16 15:08:19 -0800296 // by the current build host or the target device.
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000297 osTypeList []OsType
Colin Crossa6845402020-11-16 15:08:19 -0800298 // commonTargetMap maps names of OsTypes to the corresponding common Target, i.e. the
299 // Target with the same OsType and the common ArchType.
300 commonTargetMap = make(map[string]Target)
301 // osArchTypeMap maps OsTypes to the list of supported ArchTypes for that OS.
302 osArchTypeMap = map[OsType][]ArchType{}
303
304 // NoOsType is a placeholder for when no OS is needed.
305 NoOsType OsType
306 // Linux is the OS for the Linux kernel plus the glibc runtime.
307 Linux = newOsType("linux_glibc", Host, false, X86, X86_64)
Colin Cross528d67e2021-07-23 22:23:07 +0000308 // LinuxMusl is the OS for the Linux kernel plus the musl runtime.
309 LinuxMusl = newOsType("linux_musl", Host, false, X86, X86_64)
Colin Crossa6845402020-11-16 15:08:19 -0800310 // Darwin is the OS for MacOS/Darwin host machines.
Dan Willemsen8528f4e2021-10-19 00:22:06 -0700311 Darwin = newOsType("darwin", Host, false, Arm64, X86_64)
Colin Crossa6845402020-11-16 15:08:19 -0800312 // LinuxBionic is the OS for the Linux kernel plus the Bionic libc runtime, but without the
313 // rest of Android.
314 LinuxBionic = newOsType("linux_bionic", Host, false, Arm64, X86_64)
315 // Windows the OS for Windows host machines.
316 Windows = newOsType("windows", Host, true, X86, X86_64)
317 // Android is the OS for target devices that run all of Android, including the Linux kernel
318 // and the Bionic libc runtime.
319 Android = newOsType("android", Device, false, Arm, Arm64, X86, X86_64)
Colin Crossa6845402020-11-16 15:08:19 -0800320
321 // CommonOS is a pseudo OSType for a common OS variant, which is OsType agnostic and which
322 // has dependencies on all the OS variants.
323 CommonOS = newOsType("common_os", Generic, false)
Colin Crosse9fe2942020-11-10 18:12:15 -0800324
325 // CommonArch is the Arch for all modules that are os-specific but not arch specific,
326 // for example most Java modules.
327 CommonArch = Arch{ArchType: Common}
dimitry1f33e402019-03-26 12:39:31 +0100328)
329
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000330// OsTypeList returns a slice copy of the supported OsTypes.
331func OsTypeList() []OsType {
332 return append([]OsType(nil), osTypeList...)
333}
334
Colin Crossa6845402020-11-16 15:08:19 -0800335// Target specifies the OS and architecture that a module is being compiled for.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700336type Target struct {
Colin Crossa6845402020-11-16 15:08:19 -0800337 // Os the OS that the module is being compiled for (e.g. "linux_glibc", "android").
338 Os OsType
339 // Arch is the architecture that the module is being compiled for.
340 Arch Arch
341 // NativeBridge is NativeBridgeEnabled if the architecture is supported using NativeBridge
342 // (i.e. arm on x86) for this device.
343 NativeBridge NativeBridgeSupport
344 // NativeBridgeHostArchName is the name of the real architecture that is used to implement
345 // the NativeBridge architecture. For example, for arm on x86 this would be "x86".
dimitry8d6dde82019-07-11 10:23:53 +0200346 NativeBridgeHostArchName string
Colin Crossa6845402020-11-16 15:08:19 -0800347 // NativeBridgeRelativePath is the name of the subdirectory that will contain NativeBridge
348 // libraries and binaries.
dimitry8d6dde82019-07-11 10:23:53 +0200349 NativeBridgeRelativePath string
Jiyong Park1613e552020-09-14 19:43:17 +0900350
351 // HostCross is true when the target cannot run natively on the current build host.
352 // For example, linux_glibc_x86 returns true on a regular x86/i686/Linux machines, but returns false
353 // on Mac (different OS), or on 64-bit only i686/Linux machines (unsupported arch).
354 HostCross bool
Colin Crossd3ba0392015-05-07 14:11:29 -0700355}
356
Colin Crossa6845402020-11-16 15:08:19 -0800357// NativeBridgeSupport is an enum that specifies if a Target supports NativeBridge.
358type NativeBridgeSupport bool
359
360const (
361 NativeBridgeDisabled NativeBridgeSupport = false
362 NativeBridgeEnabled NativeBridgeSupport = true
363)
364
365// String returns the OS and arch variations used for the Target.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700366func (target Target) String() string {
Colin Crossa195f912019-10-16 11:07:20 -0700367 return target.OsVariation() + "_" + target.ArchVariation()
368}
369
Colin Crossa6845402020-11-16 15:08:19 -0800370// OsVariation returns the name of the variation used by the osMutator for the Target.
Colin Crossa195f912019-10-16 11:07:20 -0700371func (target Target) OsVariation() string {
372 return target.Os.String()
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700373}
374
Colin Crossa6845402020-11-16 15:08:19 -0800375// ArchVariation returns the name of the variation used by the archMutator for the Target.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700376func (target Target) ArchVariation() string {
377 var variation string
dimitry1f33e402019-03-26 12:39:31 +0100378 if target.NativeBridge {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700379 variation = "native_bridge_"
dimitry1f33e402019-03-26 12:39:31 +0100380 }
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700381 variation += target.Arch.String()
382
Colin Crossa195f912019-10-16 11:07:20 -0700383 return variation
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700384}
385
Colin Crossa6845402020-11-16 15:08:19 -0800386// Variations returns a list of blueprint.Variations for the osMutator and archMutator for the
387// Target.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700388func (target Target) Variations() []blueprint.Variation {
389 return []blueprint.Variation{
Colin Crossa195f912019-10-16 11:07:20 -0700390 {Mutator: "os", Variation: target.OsVariation()},
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700391 {Mutator: "arch", Variation: target.ArchVariation()},
392 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800393}
394
Liz Kammer4562a3b2021-04-21 18:15:34 -0400395func registerBp2buildArchPathDepsMutator(ctx RegisterMutatorsContext) {
396 ctx.BottomUp("bp2build-arch-pathdeps", bp2buildArchPathDepsMutator).Parallel()
397}
398
399// add dependencies for architecture specific properties tagged with `android:"path"`
400func bp2buildArchPathDepsMutator(ctx BottomUpMutatorContext) {
401 var module Module
402 module = ctx.Module()
403
404 m := module.base()
405 if !m.ArchSpecific() {
406 return
407 }
408
409 // addPathDepsForProps does not descend into sub structs, so we need to descend into the
410 // arch-specific properties ourselves
Ustaeabf0f32021-12-06 15:17:23 -0500411 var properties []interface{}
Liz Kammer4562a3b2021-04-21 18:15:34 -0400412 for _, archProperties := range m.archProperties {
413 for _, archProps := range archProperties {
414 archPropValues := reflect.ValueOf(archProps).Elem()
415 // there are three "arch" variations, descend into each
416 for _, variant := range []string{"Arch", "Multilib", "Target"} {
417 // The properties are an interface, get the value (a pointer) that it points to
418 archProps := archPropValues.FieldByName(variant).Elem()
419 if archProps.IsNil() {
420 continue
421 }
422 // And then a pointer to a struct
423 archProps = archProps.Elem()
424 for i := 0; i < archProps.NumField(); i += 1 {
425 f := archProps.Field(i)
426 // If the value of the field is a struct (as opposed to a pointer to a struct) then step
427 // into the BlueprintEmbed field.
428 if f.Kind() == reflect.Struct {
429 f = f.FieldByName("BlueprintEmbed")
430 }
431 if f.IsZero() {
432 continue
433 }
434 props := f.Interface().(interface{})
435 properties = append(properties, props)
436 }
437 }
438 }
439 }
440 addPathDepsForProps(ctx, properties)
441}
442
Colin Crossa6845402020-11-16 15:08:19 -0800443// osMutator splits an arch-specific module into a variant for each OS that is enabled for the
444// module. It uses the HostOrDevice value passed to InitAndroidArchModule and the
445// device_supported and host_supported properties to determine which OsTypes are enabled for this
446// module, then searches through the Targets to determine which have enabled Targets for this
447// module.
Colin Cross617b88a2020-08-24 18:04:09 -0700448func osMutator(bpctx blueprint.BottomUpMutatorContext) {
Colin Crossa195f912019-10-16 11:07:20 -0700449 var module Module
450 var ok bool
Colin Cross617b88a2020-08-24 18:04:09 -0700451 if module, ok = bpctx.Module().(Module); !ok {
Colin Crossa6845402020-11-16 15:08:19 -0800452 // The module is not a Soong module, it is a Blueprint module.
Colin Cross617b88a2020-08-24 18:04:09 -0700453 if bootstrap.IsBootstrapModule(bpctx.Module()) {
454 // Bootstrap Go modules are always the build OS or linux bionic.
455 config := bpctx.Config().(Config)
456 osNames := []string{config.BuildOSTarget.OsVariation()}
457 for _, hostCrossTarget := range config.Targets[LinuxBionic] {
458 if hostCrossTarget.Arch.ArchType == config.BuildOSTarget.Arch.ArchType {
459 osNames = append(osNames, hostCrossTarget.OsVariation())
460 }
461 }
462 osNames = FirstUniqueStrings(osNames)
463 bpctx.CreateVariations(osNames...)
464 }
Colin Crossa195f912019-10-16 11:07:20 -0700465 return
466 }
467
Colin Cross617b88a2020-08-24 18:04:09 -0700468 // Bootstrap Go module support above requires this mutator to be a
469 // blueprint.BottomUpMutatorContext because android.BottomUpMutatorContext
470 // filters out non-Soong modules. Now that we've handled them, create a
471 // normal android.BottomUpMutatorContext.
Liz Kammer356f7d42021-01-26 09:18:53 -0500472 mctx := bottomUpMutatorContextFactory(bpctx, module, false, false)
Colin Cross617b88a2020-08-24 18:04:09 -0700473
Colin Crossa195f912019-10-16 11:07:20 -0700474 base := module.base()
475
Colin Crossa6845402020-11-16 15:08:19 -0800476 // Nothing to do for modules that are not architecture specific (e.g. a genrule).
Colin Crossa195f912019-10-16 11:07:20 -0700477 if !base.ArchSpecific() {
478 return
479 }
480
Colin Crossa6845402020-11-16 15:08:19 -0800481 // Collect a list of OSTypes supported by this module based on the HostOrDevice value
482 // passed to InitAndroidArchModule and the device_supported and host_supported properties.
Colin Crossa195f912019-10-16 11:07:20 -0700483 var moduleOSList []OsType
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000484 for _, os := range osTypeList {
Jiyong Park1613e552020-09-14 19:43:17 +0900485 for _, t := range mctx.Config().Targets[os] {
Colin Cross08d6f8f2020-11-19 02:33:19 +0000486 if base.supportsTarget(t) {
Jiyong Park1613e552020-09-14 19:43:17 +0900487 moduleOSList = append(moduleOSList, os)
488 break
Colin Crossa195f912019-10-16 11:07:20 -0700489 }
490 }
Colin Crossa195f912019-10-16 11:07:20 -0700491 }
492
Colin Crossa6845402020-11-16 15:08:19 -0800493 // If there are no supported OSes then disable the module.
Colin Crossa195f912019-10-16 11:07:20 -0700494 if len(moduleOSList) == 0 {
Inseob Kimeec88e12020-01-22 11:11:29 +0900495 base.Disable()
Colin Crossa195f912019-10-16 11:07:20 -0700496 return
497 }
498
Colin Crossa6845402020-11-16 15:08:19 -0800499 // Convert the list of supported OsTypes to the variation names.
Colin Crossa195f912019-10-16 11:07:20 -0700500 osNames := make([]string, len(moduleOSList))
Colin Crossa195f912019-10-16 11:07:20 -0700501 for i, os := range moduleOSList {
502 osNames[i] = os.String()
503 }
504
Paul Duffin1356d8c2020-02-25 19:26:33 +0000505 createCommonOSVariant := base.commonProperties.CreateCommonOSVariant
506 if createCommonOSVariant {
Colin Crossa6845402020-11-16 15:08:19 -0800507 // A CommonOS variant was requested so add it to the list of OS variants to
Paul Duffin1356d8c2020-02-25 19:26:33 +0000508 // create. It needs to be added to the end because it needs to depend on the
509 // the other variants in the list returned by CreateVariations(...) and inter
510 // variant dependencies can only be created from a later variant in that list to
511 // an earlier one. That is because variants are always processed in the order in
512 // which they are returned from CreateVariations(...).
513 osNames = append(osNames, CommonOS.Name)
514 moduleOSList = append(moduleOSList, CommonOS)
Colin Crossa195f912019-10-16 11:07:20 -0700515 }
516
Colin Crossa6845402020-11-16 15:08:19 -0800517 // Create the variations, annotate each one with which OS it was created for, and
518 // squash the appropriate OS-specific properties into the top level properties.
Paul Duffin1356d8c2020-02-25 19:26:33 +0000519 modules := mctx.CreateVariations(osNames...)
520 for i, m := range modules {
521 m.base().commonProperties.CompileOS = moduleOSList[i]
522 m.base().setOSProperties(mctx)
523 }
524
525 if createCommonOSVariant {
526 // A CommonOS variant was requested so add dependencies from it (the last one in
527 // the list) to the OS type specific variants.
528 last := len(modules) - 1
529 commonOSVariant := modules[last]
530 commonOSVariant.base().commonProperties.CommonOSVariant = true
531 for _, module := range modules[0:last] {
532 // Ignore modules that are enabled. Note, this will only avoid adding
533 // dependencies on OsType variants that are explicitly disabled in their
534 // properties. The CommonOS variant will still depend on disabled variants
535 // if they are disabled afterwards, e.g. in archMutator if
536 if module.Enabled() {
537 mctx.AddInterVariantDependency(commonOsToOsSpecificVariantTag, commonOSVariant, module)
538 }
539 }
540 }
541}
542
Colin Crossc179ea62020-10-09 10:54:15 -0700543type archDepTag struct {
544 blueprint.BaseDependencyTag
545 name string
546}
Paul Duffin1356d8c2020-02-25 19:26:33 +0000547
Colin Crossc179ea62020-10-09 10:54:15 -0700548// Identifies the dependency from CommonOS variant to the os specific variants.
549var commonOsToOsSpecificVariantTag = archDepTag{name: "common os to os specific"}
550
Paul Duffin1356d8c2020-02-25 19:26:33 +0000551// Get the OsType specific variants for the current CommonOS variant.
552//
553// The returned list will only contain enabled OsType specific variants of the
554// module referenced in the supplied context. An empty list is returned if there
555// are no enabled variants or the supplied context is not for an CommonOS
556// variant.
557func GetOsSpecificVariantsOfCommonOSVariant(mctx BaseModuleContext) []Module {
558 var variants []Module
559 mctx.VisitDirectDeps(func(m Module) {
560 if mctx.OtherModuleDependencyTag(m) == commonOsToOsSpecificVariantTag {
561 if m.Enabled() {
562 variants = append(variants, m)
563 }
564 }
565 })
Paul Duffin1356d8c2020-02-25 19:26:33 +0000566 return variants
Colin Crossa195f912019-10-16 11:07:20 -0700567}
568
Dan Willemsen47450072021-10-19 20:24:49 -0700569var DarwinUniversalVariantTag = archDepTag{name: "darwin universal binary"}
570
Colin Crossee0bc3b2018-10-02 22:01:37 -0700571// archMutator splits a module into a variant for each Target requested by the module. Target selection
Colin Crossa6845402020-11-16 15:08:19 -0800572// for a module is in three levels, OsClass, multilib, and then Target.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700573// OsClass selection is determined by:
574// - The HostOrDeviceSupported value passed in to InitAndroidArchModule by the module type factory, which selects
575// whether the module type can compile for host, device or both.
576// - The host_supported and device_supported properties on the module.
Roland Levillainf5b635d2019-06-05 14:42:57 +0100577// 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 -0700578// for the module, the Device OsClass is selected.
579// Within each selected OsClass, the multilib selection is determined by:
Jaewoong Jung02b2d4d2019-06-06 15:19:57 -0700580// - The compile_multilib property if it set (which may be overridden by target.android.compile_multilib or
Colin Crossee0bc3b2018-10-02 22:01:37 -0700581// target.host.compile_multilib).
582// - The default multilib passed to InitAndroidArchModule if compile_multilib was not set.
583// Valid multilib values include:
584// "both": compile for all Targets supported by the OsClass (generally x86_64 and x86, or arm64 and arm).
585// "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 -0700586// but may be arm for a 32-bit only build.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700587// "32": compile for only a single 32-bit Target supported by the OsClass.
588// "64": compile for only a single 64-bit Target supported by the OsClass.
Colin Crossa6845402020-11-16 15:08:19 -0800589// "common": compile a for a single Target that will work on all Targets supported by the OsClass (for example Java).
590// "common_first": compile a for a Target that will work on all Targets supported by the OsClass
591// (same as "common"), plus a second Target for the preferred Target supported by the OsClass
592// (same as "first"). This is used for java_binary that produces a common .jar and a wrapper
593// executable script.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700594//
595// Once the list of Targets is determined, the module is split into a variant for each Target.
596//
597// Modules can be initialized with InitAndroidMultiTargetsArchModule, in which case they will be split by OsClass,
598// 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 -0700599func archMutator(bpctx blueprint.BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700600 var module Module
Colin Cross3f40fa42015-01-30 17:27:36 -0800601 var ok bool
Colin Cross617b88a2020-08-24 18:04:09 -0700602 if module, ok = bpctx.Module().(Module); !ok {
603 if bootstrap.IsBootstrapModule(bpctx.Module()) {
604 // Bootstrap Go modules are always the build architecture.
605 bpctx.CreateVariations(bpctx.Config().(Config).BuildOSTarget.ArchVariation())
606 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800607 return
608 }
609
Colin Cross617b88a2020-08-24 18:04:09 -0700610 // Bootstrap Go module support above requires this mutator to be a
611 // blueprint.BottomUpMutatorContext because android.BottomUpMutatorContext
612 // filters out non-Soong modules. Now that we've handled them, create a
613 // normal android.BottomUpMutatorContext.
Liz Kammer356f7d42021-01-26 09:18:53 -0500614 mctx := bottomUpMutatorContextFactory(bpctx, module, false, false)
Colin Cross617b88a2020-08-24 18:04:09 -0700615
Colin Cross5eca7cb2018-10-02 14:02:10 -0700616 base := module.base()
617
618 if !base.ArchSpecific() {
Colin Crossb9db4802016-06-03 01:50:47 +0000619 return
620 }
621
Colin Crossa195f912019-10-16 11:07:20 -0700622 os := base.commonProperties.CompileOS
Paul Duffin1356d8c2020-02-25 19:26:33 +0000623 if os == CommonOS {
624 // Make sure that the target related properties are initialized for the
625 // CommonOS variant.
626 addTargetProperties(module, commonTargetMap[os.Name], nil, true)
627
628 // Do not create arch specific variants for the CommonOS variant.
629 return
630 }
631
Colin Crossa195f912019-10-16 11:07:20 -0700632 osTargets := mctx.Config().Targets[os]
Colin Crossfb0c16e2019-11-20 17:12:35 -0800633 image := base.commonProperties.ImageVariation
Colin Crossa6845402020-11-16 15:08:19 -0800634 // Filter NativeBridge targets unless they are explicitly supported.
635 // Skip creating native bridge variants for non-core modules.
Paul Duffine3d1ae42021-09-03 17:47:17 +0100636 if os == Android && !(base.IsNativeBridgeSupported() && image == CoreVariation) {
Colin Cross83bead42019-12-18 10:45:46 -0800637
Colin Crossa195f912019-10-16 11:07:20 -0700638 var targets []Target
639 for _, t := range osTargets {
640 if !t.NativeBridge {
641 targets = append(targets, t)
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700642 }
643 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700644
Colin Crossa195f912019-10-16 11:07:20 -0700645 osTargets = targets
646 }
Colin Crossee0bc3b2018-10-02 22:01:37 -0700647
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700648 // only the primary arch in the ramdisk / vendor_ramdisk / recovery partition
Inseob Kim08758f02021-04-08 21:13:22 +0900649 if os == Android && (module.InstallInRecovery() || module.InstallInRamdisk() || module.InstallInVendorRamdisk() || module.InstallInDebugRamdisk()) {
Colin Crossa195f912019-10-16 11:07:20 -0700650 osTargets = []Target{osTargets[0]}
651 }
dimitry1f33e402019-03-26 12:39:31 +0100652
Jaewoong Jung003d8082021-02-24 17:39:54 -0800653 // Windows builds always prefer 32-bit
654 prefer32 := os == Windows
dimitry1f33e402019-03-26 12:39:31 +0100655
Colin Crossa6845402020-11-16 15:08:19 -0800656 // Determine the multilib selection for this module.
Dan Willemsen47450072021-10-19 20:24:49 -0700657 multilib, extraMultilib := decodeMultilib(base, os)
Colin Crossa6845402020-11-16 15:08:19 -0800658
659 // Convert the multilib selection into a list of Targets.
Colin Crossa195f912019-10-16 11:07:20 -0700660 targets, err := decodeMultilibTargets(multilib, osTargets, prefer32)
661 if err != nil {
662 mctx.ModuleErrorf("%s", err.Error())
663 }
Colin Cross5eca7cb2018-10-02 14:02:10 -0700664
Colin Crossa6845402020-11-16 15:08:19 -0800665 // If the module is using extraMultilib, decode the extraMultilib selection into
666 // a separate list of Targets.
Colin Crossa195f912019-10-16 11:07:20 -0700667 var multiTargets []Target
668 if extraMultilib != "" {
669 multiTargets, err = decodeMultilibTargets(extraMultilib, osTargets, prefer32)
Colin Crossa1ad8d12016-06-01 17:09:44 -0700670 if err != nil {
671 mctx.ModuleErrorf("%s", err.Error())
672 }
Colin Crossb9db4802016-06-03 01:50:47 +0000673 }
674
Colin Crossa6845402020-11-16 15:08:19 -0800675 // Recovery is always the primary architecture, filter out any other architectures.
Inseob Kim20fb5d42021-02-02 20:07:58 +0900676 // Common arch is also allowed
Colin Crossfb0c16e2019-11-20 17:12:35 -0800677 if image == RecoveryVariation {
678 primaryArch := mctx.Config().DevicePrimaryArchType()
Inseob Kim20fb5d42021-02-02 20:07:58 +0900679 targets = filterToArch(targets, primaryArch, Common)
680 multiTargets = filterToArch(multiTargets, primaryArch, Common)
Colin Crossfb0c16e2019-11-20 17:12:35 -0800681 }
682
Colin Crossa6845402020-11-16 15:08:19 -0800683 // If there are no supported targets disable the module.
Colin Crossa195f912019-10-16 11:07:20 -0700684 if len(targets) == 0 {
Inseob Kimeec88e12020-01-22 11:11:29 +0900685 base.Disable()
Dan Willemsen3f32f032016-07-11 14:36:48 -0700686 return
687 }
688
Colin Crossa6845402020-11-16 15:08:19 -0800689 // Convert the targets into a list of arch variation names.
Colin Crossa195f912019-10-16 11:07:20 -0700690 targetNames := make([]string, len(targets))
Colin Crossa195f912019-10-16 11:07:20 -0700691 for i, target := range targets {
692 targetNames[i] = target.ArchVariation()
Colin Crossa1ad8d12016-06-01 17:09:44 -0700693 }
694
Colin Crossa6845402020-11-16 15:08:19 -0800695 // Create the variations, annotate each one with which Target it was created for, and
696 // squash the appropriate arch-specific properties into the top level properties.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700697 modules := mctx.CreateVariations(targetNames...)
Colin Cross3f40fa42015-01-30 17:27:36 -0800698 for i, m := range modules {
Paul Duffin1356d8c2020-02-25 19:26:33 +0000699 addTargetProperties(m, targets[i], multiTargets, i == 0)
Colin Cross617b88a2020-08-24 18:04:09 -0700700 m.base().setArchProperties(mctx)
Dan Willemsen8528f4e2021-10-19 00:22:06 -0700701
702 // Install support doesn't understand Darwin+Arm64
703 if os == Darwin && targets[i].HostCross {
704 m.base().commonProperties.SkipInstall = true
705 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800706 }
Dan Willemsen47450072021-10-19 20:24:49 -0700707
708 // Create a dependency for Darwin Universal binaries from the primary to secondary
709 // architecture. The module itself will be responsible for calling lipo to merge the outputs.
710 if os == Darwin {
711 if multilib == "darwin_universal" && len(modules) == 2 {
712 mctx.AddInterVariantDependency(DarwinUniversalVariantTag, modules[1], modules[0])
713 } else if multilib == "darwin_universal_common_first" && len(modules) == 3 {
714 mctx.AddInterVariantDependency(DarwinUniversalVariantTag, modules[2], modules[1])
715 }
716 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800717}
718
Colin Crossa6845402020-11-16 15:08:19 -0800719// addTargetProperties annotates a variant with the Target is is being compiled for, the list
720// of additional Targets it is supporting (if any), and whether it is the primary Target for
721// the module.
Paul Duffin1356d8c2020-02-25 19:26:33 +0000722func addTargetProperties(m Module, target Target, multiTargets []Target, primaryTarget bool) {
723 m.base().commonProperties.CompileTarget = target
724 m.base().commonProperties.CompileMultiTargets = multiTargets
725 m.base().commonProperties.CompilePrimary = primaryTarget
726}
727
Colin Crossa6845402020-11-16 15:08:19 -0800728// decodeMultilib returns the appropriate compile_multilib property for the module, or the default
729// multilib from the factory's call to InitAndroidArchModule if none was set. For modules that
730// called InitAndroidMultiTargetsArchModule it always returns "common" for multilib, and returns
731// the actual multilib in extraMultilib.
Dan Willemsen47450072021-10-19 20:24:49 -0700732func decodeMultilib(base *ModuleBase, os OsType) (multilib, extraMultilib string) {
Colin Crossa6845402020-11-16 15:08:19 -0800733 // First check the "android.compile_multilib" or "host.compile_multilib" properties.
Dan Willemsen47450072021-10-19 20:24:49 -0700734 switch os.Class {
Colin Crossee0bc3b2018-10-02 22:01:37 -0700735 case Device:
736 multilib = String(base.commonProperties.Target.Android.Compile_multilib)
Jiyong Park1613e552020-09-14 19:43:17 +0900737 case Host:
Colin Crossee0bc3b2018-10-02 22:01:37 -0700738 multilib = String(base.commonProperties.Target.Host.Compile_multilib)
739 }
Colin Crossa6845402020-11-16 15:08:19 -0800740
741 // If those aren't set, try the "compile_multilib" property.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700742 if multilib == "" {
743 multilib = String(base.commonProperties.Compile_multilib)
744 }
Colin Crossa6845402020-11-16 15:08:19 -0800745
746 // If that wasn't set, use the default multilib set by the factory.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700747 if multilib == "" {
748 multilib = base.commonProperties.Default_multilib
749 }
750
751 if base.commonProperties.UseTargetVariants {
Dan Willemsen47450072021-10-19 20:24:49 -0700752 // Darwin has the concept of "universal binaries" which is implemented in Soong by
753 // building both x86_64 and arm64 variants, and having select module types know how to
754 // merge the outputs of their corresponding variants together into a final binary. Most
755 // module types don't need to understand this logic, as we only build a small portion
756 // of the tree for Darwin, and only module types writing macho files need to do the
757 // merging.
758 //
759 // This logic is not enabled for:
760 // "common", as it's not an arch-specific variant
761 // "32", as Darwin never has a 32-bit variant
762 // !UseTargetVariants, as the module has opted into handling the arch-specific logic on
763 // its own.
764 if os == Darwin && multilib != "common" && multilib != "32" {
765 if multilib == "common_first" {
766 multilib = "darwin_universal_common_first"
767 } else {
768 multilib = "darwin_universal"
769 }
770 }
771
Colin Crossee0bc3b2018-10-02 22:01:37 -0700772 return multilib, ""
773 } else {
774 // For app modules a single arch variant will be created per OS class which is expected to handle all the
775 // selected arches. Return the common-type as multilib and any Android.bp provided multilib as extraMultilib
776 if multilib == base.commonProperties.Default_multilib {
777 multilib = "first"
778 }
779 return base.commonProperties.Default_multilib, multilib
780 }
781}
782
Colin Crossa6845402020-11-16 15:08:19 -0800783// filterToArch takes a list of Targets and an ArchType, and returns a modified list that contains
Inseob Kim20fb5d42021-02-02 20:07:58 +0900784// only Targets that have the specified ArchTypes.
785func filterToArch(targets []Target, archs ...ArchType) []Target {
Colin Crossfb0c16e2019-11-20 17:12:35 -0800786 for i := 0; i < len(targets); i++ {
Inseob Kim20fb5d42021-02-02 20:07:58 +0900787 found := false
788 for _, arch := range archs {
789 if targets[i].Arch.ArchType == arch {
790 found = true
791 break
792 }
793 }
794 if !found {
Colin Crossfb0c16e2019-11-20 17:12:35 -0800795 targets = append(targets[:i], targets[i+1:]...)
796 i--
797 }
798 }
799 return targets
800}
801
Colin Crossa6845402020-11-16 15:08:19 -0800802// archPropRoot is a struct type used as the top level of the arch-specific properties. It
803// contains the "arch", "multilib", and "target" property structs. It is used to split up the
804// property structs to limit how much is allocated when a single arch-specific property group is
805// used. The types are interface{} because they will hold instances of runtime-created types.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800806type archPropRoot struct {
807 Arch, Multilib, Target interface{}
808}
809
Colin Crossa6845402020-11-16 15:08:19 -0800810// archPropTypeDesc holds the runtime-created types for the property structs to instantiate to
811// create an archPropRoot property struct.
812type archPropTypeDesc struct {
813 arch, multilib, target reflect.Type
814}
815
Colin Crosscbbd13f2020-01-17 14:08:22 -0800816// createArchPropTypeDesc takes a reflect.Type that is either a struct or a pointer to a struct, and
817// returns lists of reflect.Types that contains the arch-variant properties inside structs for each
818// arch, multilib and target property.
Colin Crossa6845402020-11-16 15:08:19 -0800819//
820// This is a relatively expensive operation, so the results are cached in the global
821// archPropTypeMap. It is constructed entirely based on compile-time data, so there is no need
822// to isolate the results between multiple tests running in parallel.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800823func createArchPropTypeDesc(props reflect.Type) []archPropTypeDesc {
Colin Crossb1d8c992020-01-21 11:43:29 -0800824 // Each property struct shard will be nested many times under the runtime generated arch struct,
825 // which can hit the limit of 64kB for the name of runtime generated structs. They are nested
826 // 97 times now, which may grow in the future, plus there is some overhead for the containing
827 // type. This number may need to be reduced if too many are added, but reducing it too far
828 // could cause problems if a single deeply nested property no longer fits in the name.
829 const maxArchTypeNameSize = 500
830
Colin Crossa6845402020-11-16 15:08:19 -0800831 // Convert the type to a new set of types that contains only the arch-specific properties
Usta Shrestha0b52d832022-02-04 21:37:39 -0500832 // (those that are tagged with `android:"arch_variant"`), and sharded into multiple types
Colin Crossa6845402020-11-16 15:08:19 -0800833 // to keep the runtime-generated names under the limit.
Colin Crossb1d8c992020-01-21 11:43:29 -0800834 propShards, _ := proptools.FilterPropertyStructSharded(props, maxArchTypeNameSize, filterArchStruct)
Colin Crossa6845402020-11-16 15:08:19 -0800835
836 // If the type has no arch-specific properties there is nothing to do.
Colin Crosscb988072019-01-24 14:58:11 -0800837 if len(propShards) == 0 {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700838 return nil
839 }
840
Colin Crosscbbd13f2020-01-17 14:08:22 -0800841 var ret []archPropTypeDesc
Colin Crossc17727d2018-10-24 12:42:09 -0700842 for _, props := range propShards {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700843
Colin Crossa6845402020-11-16 15:08:19 -0800844 // variantFields takes a list of variant property field names and returns a list the
845 // StructFields with the names and the type of the current shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700846 variantFields := func(names []string) []reflect.StructField {
847 ret := make([]reflect.StructField, len(names))
Dan Willemsenb1957a52016-06-23 23:44:54 -0700848
Colin Crossc17727d2018-10-24 12:42:09 -0700849 for i, name := range names {
850 ret[i].Name = name
851 ret[i].Type = props
Dan Willemsen866b5632017-09-22 12:28:24 -0700852 }
Colin Crossc17727d2018-10-24 12:42:09 -0700853
854 return ret
855 }
856
Colin Crossa6845402020-11-16 15:08:19 -0800857 // Create a type that contains the properties in this shard repeated for each
858 // architecture, architecture variant, and architecture feature.
Colin Crossc17727d2018-10-24 12:42:09 -0700859 archFields := make([]reflect.StructField, len(archTypeList))
860 for i, arch := range archTypeList {
Colin Crossa6845402020-11-16 15:08:19 -0800861 var variants []string
Colin Crossc17727d2018-10-24 12:42:09 -0700862
863 for _, archVariant := range archVariants[arch] {
864 archVariant := variantReplacer.Replace(archVariant)
865 variants = append(variants, proptools.FieldNameForProperty(archVariant))
866 }
Liz Kammer2c2afe22022-02-11 11:35:03 -0500867 for _, cpuVariant := range cpuVariants[arch] {
868 cpuVariant := variantReplacer.Replace(cpuVariant)
869 variants = append(variants, proptools.FieldNameForProperty(cpuVariant))
870 }
Colin Crossc17727d2018-10-24 12:42:09 -0700871 for _, feature := range archFeatures[arch] {
872 feature := variantReplacer.Replace(feature)
873 variants = append(variants, proptools.FieldNameForProperty(feature))
874 }
875
Colin Crossa6845402020-11-16 15:08:19 -0800876 // Create the StructFields for each architecture variant architecture feature
877 // (e.g. "arch.arm.cortex-a53" or "arch.arm.neon").
Colin Crossc17727d2018-10-24 12:42:09 -0700878 fields := variantFields(variants)
879
Colin Crossa6845402020-11-16 15:08:19 -0800880 // Create the StructField for the architecture itself (e.g. "arch.arm"). The special
881 // "BlueprintEmbed" name is used by Blueprint to put the properties in the
882 // parent struct.
Colin Crossc17727d2018-10-24 12:42:09 -0700883 fields = append([]reflect.StructField{{
884 Name: "BlueprintEmbed",
885 Type: props,
886 Anonymous: true,
887 }}, fields...)
888
889 archFields[i] = reflect.StructField{
890 Name: arch.Field,
891 Type: reflect.StructOf(fields),
892 }
893 }
Colin Crossa6845402020-11-16 15:08:19 -0800894
895 // Create the type of the "arch" property struct for this shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700896 archType := reflect.StructOf(archFields)
897
Colin Crossa6845402020-11-16 15:08:19 -0800898 // Create the type for the "multilib" property struct for this shard, containing the
899 // "multilib.lib32" and "multilib.lib64" property structs.
Colin Crossc17727d2018-10-24 12:42:09 -0700900 multilibType := reflect.StructOf(variantFields([]string{"Lib32", "Lib64"}))
901
Colin Crossa6845402020-11-16 15:08:19 -0800902 // Start with a list of the special targets
Colin Crossc17727d2018-10-24 12:42:09 -0700903 targets := []string{
904 "Host",
905 "Android64",
906 "Android32",
907 "Bionic",
Colin Cross528d67e2021-07-23 22:23:07 +0000908 "Glibc",
909 "Musl",
Colin Crossc17727d2018-10-24 12:42:09 -0700910 "Linux",
911 "Not_windows",
912 "Arm_on_x86",
913 "Arm_on_x86_64",
Victor Khimenkoc26fcf42020-05-07 22:16:33 +0200914 "Native_bridge",
Colin Crossc17727d2018-10-24 12:42:09 -0700915 }
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000916 for _, os := range osTypeList {
Colin Crossa6845402020-11-16 15:08:19 -0800917 // Add all the OSes.
Colin Crossc17727d2018-10-24 12:42:09 -0700918 targets = append(targets, os.Field)
919
Colin Crossa6845402020-11-16 15:08:19 -0800920 // Add the OS/Arch combinations, e.g. "android_arm64".
Colin Crossc17727d2018-10-24 12:42:09 -0700921 for _, archType := range osArchTypeMap[os] {
Liz Kammer9abd62d2021-05-21 08:37:59 -0400922 targets = append(targets, GetCompoundTargetField(os, archType))
Colin Crossc17727d2018-10-24 12:42:09 -0700923
Colin Cross1aa45b02022-02-10 10:33:10 -0800924 // Also add the special "linux_<arch>", "bionic_<arch>" , "glibc_<arch>", and
925 // "musl_<arch>" property structs.
Colin Crossc17727d2018-10-24 12:42:09 -0700926 if os.Linux() {
927 target := "Linux_" + archType.Name
928 if !InList(target, targets) {
929 targets = append(targets, target)
930 }
931 }
932 if os.Bionic() {
933 target := "Bionic_" + archType.Name
934 if !InList(target, targets) {
935 targets = append(targets, target)
936 }
Dan Willemsen866b5632017-09-22 12:28:24 -0700937 }
Colin Cross1aa45b02022-02-10 10:33:10 -0800938 if os == Linux {
939 target := "Glibc_" + archType.Name
940 if !InList(target, targets) {
941 targets = append(targets, target)
942 }
943 }
944 if os == LinuxMusl {
945 target := "Musl_" + archType.Name
946 if !InList(target, targets) {
947 targets = append(targets, target)
948 }
949 }
Dan Willemsen866b5632017-09-22 12:28:24 -0700950 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700951 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700952
Colin Crossa6845402020-11-16 15:08:19 -0800953 // Create the type for the "target" property struct for this shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700954 targetType := reflect.StructOf(variantFields(targets))
Colin Crosscbbd13f2020-01-17 14:08:22 -0800955
Colin Crossa6845402020-11-16 15:08:19 -0800956 // Return a descriptor of the 3 runtime-created types.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800957 ret = append(ret, archPropTypeDesc{
958 arch: reflect.PtrTo(archType),
959 multilib: reflect.PtrTo(multilibType),
960 target: reflect.PtrTo(targetType),
961 })
Colin Crossc17727d2018-10-24 12:42:09 -0700962 }
963 return ret
Dan Willemsenb1957a52016-06-23 23:44:54 -0700964}
965
Colin Crossa6845402020-11-16 15:08:19 -0800966// variantReplacer converts architecture variant or architecture feature names into names that
967// are valid for an Android.bp file.
968var variantReplacer = strings.NewReplacer("-", "_", ".", "_")
969
970// filterArchStruct returns true if the given field is an architecture specific property.
Colin Cross74449102019-09-25 11:26:40 -0700971func filterArchStruct(field reflect.StructField, prefix string) (bool, reflect.StructField) {
972 if proptools.HasTag(field, "android", "arch_variant") {
973 // The arch_variant field isn't necessary past this point
974 // Instead of wasting space, just remove it. Go also has a
975 // 16-bit limit on structure name length. The name is constructed
976 // based on the Go source representation of the structure, so
977 // the tag names count towards that length.
Colin Crossb4fecbf2020-01-21 11:38:47 -0800978
979 androidTag := field.Tag.Get("android")
980 values := strings.Split(androidTag, ",")
981
982 if string(field.Tag) != `android:"`+strings.Join(values, ",")+`"` {
983 panic(fmt.Errorf("unexpected tag format %q", field.Tag))
Colin Cross74449102019-09-25 11:26:40 -0700984 }
Liz Kammer4562a3b2021-04-21 18:15:34 -0400985 // don't delete path tag as it is needed for bp2build
Colin Crossb4fecbf2020-01-21 11:38:47 -0800986 // these tags don't need to be present in the runtime generated struct type.
Liz Kammer4562a3b2021-04-21 18:15:34 -0400987 values = RemoveListFromList(values, []string{"arch_variant", "variant_prepend"})
988 if len(values) > 0 && values[0] != "path" {
Colin Crossb4fecbf2020-01-21 11:38:47 -0800989 panic(fmt.Errorf("unknown tags %q in field %q", values, prefix+field.Name))
Liz Kammer4562a3b2021-04-21 18:15:34 -0400990 } else if len(values) == 1 {
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxfd0c03c2021-09-21 15:17:48 +0000991 // FIXME(b/200678898): This assumes that the only tag type when there's
992 // `android:"arch_variant"` is `android` itself and thus clobbers others
Liz Kammer4562a3b2021-04-21 18:15:34 -0400993 field.Tag = reflect.StructTag(`android:"` + strings.Join(values, ",") + `"`)
994 } else {
995 field.Tag = ``
Colin Crossb4fecbf2020-01-21 11:38:47 -0800996 }
997
Colin Cross74449102019-09-25 11:26:40 -0700998 return true, field
999 }
1000 return false, field
1001}
1002
Colin Crossa6845402020-11-16 15:08:19 -08001003// archPropTypeMap contains a cache of the results of createArchPropTypeDesc for each type. It is
1004// shared across all Contexts, but is constructed based only on compile-time information so there
1005// is no risk of contaminating one Context with data from another.
Dan Willemsenb1957a52016-06-23 23:44:54 -07001006var archPropTypeMap OncePer
1007
Colin Crossa6845402020-11-16 15:08:19 -08001008// initArchModule adds the architecture-specific property structs to a Module.
1009func initArchModule(m Module) {
Colin Cross3f40fa42015-01-30 17:27:36 -08001010
1011 base := m.base()
1012
Ustaeabf0f32021-12-06 15:17:23 -05001013 if len(base.archProperties) != 0 {
1014 panic(fmt.Errorf("module %s already has archProperties", m.Name()))
1015 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001016
Ustaeabf0f32021-12-06 15:17:23 -05001017 getStructType := func(properties interface{}) reflect.Type {
Colin Cross3f40fa42015-01-30 17:27:36 -08001018 propertiesValue := reflect.ValueOf(properties)
Colin Cross62496a02016-08-08 15:49:17 -07001019 t := propertiesValue.Type()
Colin Cross3f40fa42015-01-30 17:27:36 -08001020 if propertiesValue.Kind() != reflect.Ptr {
Colin Crossca860ac2016-01-04 14:34:37 -08001021 panic(fmt.Errorf("properties must be a pointer to a struct, got %T",
1022 propertiesValue.Interface()))
Colin Cross3f40fa42015-01-30 17:27:36 -08001023 }
1024
1025 propertiesValue = propertiesValue.Elem()
1026 if propertiesValue.Kind() != reflect.Struct {
Ustaeabf0f32021-12-06 15:17:23 -05001027 panic(fmt.Errorf("properties must be a pointer to a struct, got a pointer to %T",
Colin Crossca860ac2016-01-04 14:34:37 -08001028 propertiesValue.Interface()))
Colin Cross3f40fa42015-01-30 17:27:36 -08001029 }
Ustaeabf0f32021-12-06 15:17:23 -05001030 return t
1031 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001032
Usta851a3272022-01-05 23:42:33 -05001033 for _, properties := range m.GetProperties() {
Ustaeabf0f32021-12-06 15:17:23 -05001034 t := getStructType(properties)
Colin Crossa6845402020-11-16 15:08:19 -08001035 // Get or create the arch-specific property struct types for this property struct type.
Colin Cross571cccf2019-02-04 11:22:08 -08001036 archPropTypes := archPropTypeMap.Once(NewCustomOnceKey(t), func() interface{} {
Colin Crosscbbd13f2020-01-17 14:08:22 -08001037 return createArchPropTypeDesc(t)
1038 }).([]archPropTypeDesc)
Colin Cross3f40fa42015-01-30 17:27:36 -08001039
Colin Crossa6845402020-11-16 15:08:19 -08001040 // Instantiate one of each arch-specific property struct type and add it to the
1041 // properties for the Module.
Colin Crossc17727d2018-10-24 12:42:09 -07001042 var archProperties []interface{}
1043 for _, t := range archPropTypes {
Colin Crosscbbd13f2020-01-17 14:08:22 -08001044 archProperties = append(archProperties, &archPropRoot{
1045 Arch: reflect.Zero(t.arch).Interface(),
1046 Multilib: reflect.Zero(t.multilib).Interface(),
1047 Target: reflect.Zero(t.target).Interface(),
1048 })
Dan Willemsenb1957a52016-06-23 23:44:54 -07001049 }
Colin Crossc17727d2018-10-24 12:42:09 -07001050 base.archProperties = append(base.archProperties, archProperties)
1051 m.AddProperties(archProperties...)
Colin Cross3f40fa42015-01-30 17:27:36 -08001052 }
1053
Colin Cross3f40fa42015-01-30 17:27:36 -08001054}
1055
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001056func maybeBlueprintEmbed(src reflect.Value) reflect.Value {
Colin Crossa6845402020-11-16 15:08:19 -08001057 // If the value of the field is a struct (as opposed to a pointer to a struct) then step
1058 // into the BlueprintEmbed field.
Dan Willemsenb1957a52016-06-23 23:44:54 -07001059 if src.Kind() == reflect.Struct {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001060 return src.FieldByName("BlueprintEmbed")
1061 } else {
1062 return src
Colin Cross06a931b2015-10-28 17:23:31 -07001063 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001064}
1065
1066// Merges the property struct in srcValue into dst.
Liz Kammerb6dbc872021-05-14 15:14:40 -04001067func mergePropertyStruct(ctx ArchVariantContext, dst interface{}, srcValue reflect.Value) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001068 src := maybeBlueprintEmbed(srcValue).Interface()
Colin Cross06a931b2015-10-28 17:23:31 -07001069
Colin Crossa6845402020-11-16 15:08:19 -08001070 // order checks the `android:"variant_prepend"` tag to handle properties where the
1071 // arch-specific value needs to come before the generic value, for example for lists of
1072 // include directories.
Colin Cross6ee75b62016-05-05 15:57:15 -07001073 order := func(property string,
1074 dstField, srcField reflect.StructField,
1075 dstValue, srcValue interface{}) (proptools.Order, error) {
1076 if proptools.HasTag(dstField, "android", "variant_prepend") {
1077 return proptools.Prepend, nil
1078 } else {
1079 return proptools.Append, nil
1080 }
1081 }
1082
Colin Crossa6845402020-11-16 15:08:19 -08001083 // Squash the located property struct into the destination property struct.
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001084 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src, nil, order)
Colin Cross06a931b2015-10-28 17:23:31 -07001085 if err != nil {
1086 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1087 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1088 } else {
1089 panic(err)
1090 }
1091 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001092}
Colin Cross85a88972015-11-23 13:29:51 -08001093
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001094// Returns the immediate child of the input property struct that corresponds to
1095// the sub-property "field".
Liz Kammerb6dbc872021-05-14 15:14:40 -04001096func getChildPropertyStruct(ctx ArchVariantContext,
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001097 src reflect.Value, field, userFriendlyField string) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001098
1099 // Step into non-nil pointers to structs in the src value.
1100 if src.Kind() == reflect.Ptr {
1101 if src.IsNil() {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001102 return reflect.Value{}, false
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001103 }
1104 src = src.Elem()
1105 }
1106
1107 // Find the requested field in the src struct.
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001108 child := src.FieldByName(proptools.FieldNameForProperty(field))
1109 if !child.IsValid() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001110 ctx.ModuleErrorf("field %q does not exist", userFriendlyField)
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001111 return reflect.Value{}, false
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001112 }
1113
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001114 if child.IsZero() {
1115 return reflect.Value{}, false
1116 }
1117
1118 return child, true
Colin Cross06a931b2015-10-28 17:23:31 -07001119}
1120
Colin Crossa6845402020-11-16 15:08:19 -08001121// Squash the appropriate OS-specific property structs into the matching top level property structs
1122// based on the CompileOS value that was annotated on the variant.
Colin Crossa195f912019-10-16 11:07:20 -07001123func (m *ModuleBase) setOSProperties(ctx BottomUpMutatorContext) {
1124 os := m.commonProperties.CompileOS
1125
Ustadca02192021-12-20 12:56:46 -05001126 for i := range m.archProperties {
Usta851a3272022-01-05 23:42:33 -05001127 genProps := m.GetProperties()[i]
Colin Crossa195f912019-10-16 11:07:20 -07001128 if m.archProperties[i] == nil {
1129 continue
1130 }
1131 for _, archProperties := range m.archProperties[i] {
1132 archPropValues := reflect.ValueOf(archProperties).Elem()
1133
Colin Crosscbbd13f2020-01-17 14:08:22 -08001134 targetProp := archPropValues.FieldByName("Target").Elem()
Colin Crossa195f912019-10-16 11:07:20 -07001135
1136 // Handle host-specific properties in the form:
1137 // target: {
1138 // host: {
1139 // key: value,
1140 // },
1141 // },
Jiyong Park1613e552020-09-14 19:43:17 +09001142 if os.Class == Host {
Colin Crossa195f912019-10-16 11:07:20 -07001143 field := "Host"
1144 prefix := "target.host"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001145 if hostProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1146 mergePropertyStruct(ctx, genProps, hostProperties)
1147 }
Colin Crossa195f912019-10-16 11:07:20 -07001148 }
1149
1150 // Handle target OS generalities of the form:
1151 // target: {
1152 // bionic: {
1153 // key: value,
1154 // },
1155 // }
1156 if os.Linux() {
1157 field := "Linux"
1158 prefix := "target.linux"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001159 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1160 mergePropertyStruct(ctx, genProps, linuxProperties)
1161 }
Colin Crossa195f912019-10-16 11:07:20 -07001162 }
1163
1164 if os.Bionic() {
1165 field := "Bionic"
1166 prefix := "target.bionic"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001167 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1168 mergePropertyStruct(ctx, genProps, bionicProperties)
1169 }
Colin Crossa195f912019-10-16 11:07:20 -07001170 }
1171
Colin Cross528d67e2021-07-23 22:23:07 +00001172 if os == Linux {
1173 field := "Glibc"
1174 prefix := "target.glibc"
1175 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1176 mergePropertyStruct(ctx, genProps, bionicProperties)
1177 }
1178 }
1179
1180 if os == LinuxMusl {
1181 field := "Musl"
1182 prefix := "target.musl"
1183 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1184 mergePropertyStruct(ctx, genProps, bionicProperties)
1185 }
1186
1187 // Special case: to ease the transition from glibc to musl, apply linux_glibc
1188 // properties (which has historically mean host linux) to musl variants.
1189 field = "Linux_glibc"
1190 prefix = "target.linux_glibc"
1191 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1192 mergePropertyStruct(ctx, genProps, bionicProperties)
1193 }
1194 }
1195
Colin Crossa195f912019-10-16 11:07:20 -07001196 // Handle target OS properties in the form:
1197 // target: {
1198 // linux_glibc: {
1199 // key: value,
1200 // },
1201 // not_windows: {
1202 // key: value,
1203 // },
1204 // android {
1205 // key: value,
1206 // },
1207 // },
1208 field := os.Field
1209 prefix := "target." + os.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001210 if osProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1211 mergePropertyStruct(ctx, genProps, osProperties)
1212 }
Colin Crossa195f912019-10-16 11:07:20 -07001213
Jiyong Park1613e552020-09-14 19:43:17 +09001214 if os.Class == Host && os != Windows {
Colin Crossa195f912019-10-16 11:07:20 -07001215 field := "Not_windows"
1216 prefix := "target.not_windows"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001217 if notWindowsProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1218 mergePropertyStruct(ctx, genProps, notWindowsProperties)
1219 }
Colin Crossa195f912019-10-16 11:07:20 -07001220 }
1221
1222 // Handle 64-bit device properties in the form:
1223 // target {
1224 // android64 {
1225 // key: value,
1226 // },
1227 // android32 {
1228 // key: value,
1229 // },
1230 // },
1231 // WARNING: this is probably not what you want to use in your blueprints file, it selects
1232 // options for all targets on a device that supports 64-bit binaries, not just the targets
1233 // that are being compiled for 64-bit. Its expected use case is binaries like linker and
1234 // debuggerd that need to know when they are a 32-bit process running on a 64-bit device
1235 if os.Class == Device {
1236 if ctx.Config().Android64() {
1237 field := "Android64"
1238 prefix := "target.android64"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001239 if android64Properties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1240 mergePropertyStruct(ctx, genProps, android64Properties)
1241 }
Colin Crossa195f912019-10-16 11:07:20 -07001242 } else {
1243 field := "Android32"
1244 prefix := "target.android32"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001245 if android32Properties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1246 mergePropertyStruct(ctx, genProps, android32Properties)
1247 }
Colin Crossa195f912019-10-16 11:07:20 -07001248 }
1249 }
1250 }
1251 }
1252}
1253
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001254// Returns the struct containing the properties specific to the given
1255// architecture type. These look like this in Blueprint files:
1256// arch: {
1257// arm64: {
1258// key: value,
1259// },
1260// },
1261// This struct will also contain sub-structs containing to the architecture/CPU
1262// variants and features that themselves contain properties specific to those.
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001263func getArchTypeStruct(ctx ArchVariantContext, archProperties interface{}, archType ArchType) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001264 archPropValues := reflect.ValueOf(archProperties).Elem()
1265 archProp := archPropValues.FieldByName("Arch").Elem()
1266 prefix := "arch." + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001267 return getChildPropertyStruct(ctx, archProp, archType.Name, prefix)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001268}
1269
1270// Returns the struct containing the properties specific to a given multilib
1271// value. These look like this in the Blueprint file:
1272// multilib: {
1273// lib32: {
1274// key: value,
1275// },
1276// },
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001277func getMultilibStruct(ctx ArchVariantContext, archProperties interface{}, archType ArchType) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001278 archPropValues := reflect.ValueOf(archProperties).Elem()
1279 multilibProp := archPropValues.FieldByName("Multilib").Elem()
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001280 return getChildPropertyStruct(ctx, multilibProp, archType.Multilib, "multilib."+archType.Multilib)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001281}
1282
Liz Kammer9abd62d2021-05-21 08:37:59 -04001283func GetCompoundTargetField(os OsType, arch ArchType) string {
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04001284 return os.Field + "_" + arch.Name
1285}
1286
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001287// Returns the structs corresponding to the properties specific to the given
1288// architecture and OS in archProperties.
1289func getArchProperties(ctx BaseMutatorContext, archProperties interface{}, arch Arch, os OsType, nativeBridgeEnabled bool) []reflect.Value {
1290 result := make([]reflect.Value, 0)
1291 archPropValues := reflect.ValueOf(archProperties).Elem()
1292
1293 targetProp := archPropValues.FieldByName("Target").Elem()
1294
1295 archType := arch.ArchType
1296
1297 if arch.ArchType != Common {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001298 archStruct, ok := getArchTypeStruct(ctx, archProperties, arch.ArchType)
1299 if ok {
1300 result = append(result, archStruct)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001301
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001302 // Handle arch-variant-specific properties in the form:
1303 // arch: {
1304 // arm: {
1305 // variant: {
1306 // key: value,
1307 // },
1308 // },
1309 // },
1310 v := variantReplacer.Replace(arch.ArchVariant)
1311 if v != "" {
1312 prefix := "arch." + archType.Name + "." + v
1313 if variantProperties, ok := getChildPropertyStruct(ctx, archStruct, v, prefix); ok {
1314 result = append(result, variantProperties)
1315 }
1316 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001317
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001318 // Handle cpu-variant-specific properties in the form:
1319 // arch: {
1320 // arm: {
1321 // variant: {
1322 // key: value,
1323 // },
1324 // },
1325 // },
1326 if arch.CpuVariant != arch.ArchVariant {
1327 c := variantReplacer.Replace(arch.CpuVariant)
1328 if c != "" {
1329 prefix := "arch." + archType.Name + "." + c
1330 if cpuVariantProperties, ok := getChildPropertyStruct(ctx, archStruct, c, prefix); ok {
1331 result = append(result, cpuVariantProperties)
1332 }
1333 }
1334 }
1335
1336 // Handle arch-feature-specific properties in the form:
1337 // arch: {
1338 // arm: {
1339 // feature: {
1340 // key: value,
1341 // },
1342 // },
1343 // },
1344 for _, feature := range arch.ArchFeatures {
1345 prefix := "arch." + archType.Name + "." + feature
1346 if featureProperties, ok := getChildPropertyStruct(ctx, archStruct, feature, prefix); ok {
1347 result = append(result, featureProperties)
1348 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001349 }
1350 }
1351
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001352 if multilibProperties, ok := getMultilibStruct(ctx, archProperties, archType); ok {
1353 result = append(result, multilibProperties)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001354 }
1355
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001356 // Handle combined OS-feature and arch specific properties in the form:
1357 // target: {
1358 // bionic_x86: {
1359 // key: value,
1360 // },
1361 // }
1362 if os.Linux() {
1363 field := "Linux_" + arch.ArchType.Name
1364 userFriendlyField := "target.linux_" + arch.ArchType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001365 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1366 result = append(result, linuxProperties)
1367 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001368 }
1369
1370 if os.Bionic() {
1371 field := "Bionic_" + archType.Name
1372 userFriendlyField := "target.bionic_" + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001373 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1374 result = append(result, bionicProperties)
1375 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001376 }
1377
1378 // Handle combined OS and arch specific properties in the form:
1379 // target: {
1380 // linux_glibc_x86: {
1381 // key: value,
1382 // },
1383 // linux_glibc_arm: {
1384 // key: value,
1385 // },
1386 // android_arm {
1387 // key: value,
1388 // },
1389 // android_x86 {
1390 // key: value,
1391 // },
1392 // },
Liz Kammer9abd62d2021-05-21 08:37:59 -04001393 field := GetCompoundTargetField(os, archType)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001394 userFriendlyField := "target." + os.Name + "_" + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001395 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1396 result = append(result, osArchProperties)
1397 }
Colin Cross528d67e2021-07-23 22:23:07 +00001398
Colin Cross1aa45b02022-02-10 10:33:10 -08001399 if os == Linux {
1400 field := "Glibc_" + archType.Name
1401 userFriendlyField := "target.glibc_" + "_" + archType.Name
1402 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1403 result = append(result, osArchProperties)
1404 }
1405 }
1406
Colin Cross528d67e2021-07-23 22:23:07 +00001407 if os == LinuxMusl {
Colin Cross1aa45b02022-02-10 10:33:10 -08001408 field := "Musl_" + archType.Name
1409 userFriendlyField := "target.musl_" + "_" + archType.Name
1410 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1411 result = append(result, osArchProperties)
1412 }
1413
Colin Cross528d67e2021-07-23 22:23:07 +00001414 // Special case: to ease the transition from glibc to musl, apply linux_glibc
1415 // properties (which has historically mean host linux) to musl variants.
Colin Cross1aa45b02022-02-10 10:33:10 -08001416 field = "Linux_glibc_" + archType.Name
1417 userFriendlyField = "target.linux_glibc_" + archType.Name
Colin Cross528d67e2021-07-23 22:23:07 +00001418 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1419 result = append(result, osArchProperties)
1420 }
1421 }
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
Dan Willemsen01a3c252019-01-11 19:02:16 -08001797 if a.ArchVariant == "" {
Colin Crossa6845402020-11-16 15:08:19 -08001798 // Set ArchFeatures from the default arch features.
Dan Willemsen01a3c252019-01-11 19:02:16 -08001799 if featureMap, ok := defaultArchFeatureMap[os]; ok {
1800 a.ArchFeatures = featureMap[archType]
1801 }
1802 } else {
Colin Crossa6845402020-11-16 15:08:19 -08001803 // Set ArchFeatures from the arch type.
Dan Willemsen01a3c252019-01-11 19:02:16 -08001804 if featureMap, ok := archFeatureMap[archType]; ok {
1805 a.ArchFeatures = featureMap[a.ArchVariant]
1806 }
Colin Crossc5c24ad2015-11-20 15:35:00 -08001807 }
1808
Colin Crosseeabb892015-11-20 13:07:51 -08001809 return a, nil
Colin Cross4225f652015-09-17 14:33:42 -07001810}
1811
Colin Crossa6845402020-11-16 15:08:19 -08001812// filterMultilibTargets takes a list of Targets and a multilib value and returns a new list of
1813// Targets containing only those that have the given multilib value.
Colin Cross69617d32016-09-06 10:39:07 -07001814func filterMultilibTargets(targets []Target, multilib string) []Target {
1815 var ret []Target
1816 for _, t := range targets {
1817 if t.Arch.ArchType.Multilib == multilib {
1818 ret = append(ret, t)
1819 }
1820 }
1821 return ret
1822}
1823
Colin Crossa6845402020-11-16 15:08:19 -08001824// getCommonTargets returns the set of Os specific common architecture targets for each Os in a list
1825// of targets.
Nan Zhangdb0b9a32017-02-27 10:12:13 -08001826func getCommonTargets(targets []Target) []Target {
1827 var ret []Target
1828 set := make(map[string]bool)
1829
1830 for _, t := range targets {
1831 if _, found := set[t.Os.String()]; !found {
1832 set[t.Os.String()] = true
1833 ret = append(ret, commonTargetMap[t.Os.String()])
1834 }
1835 }
1836
1837 return ret
1838}
1839
Colin Crossa6845402020-11-16 15:08:19 -08001840// firstTarget takes a list of Targets and a list of multilib values and returns a list of Targets
1841// that contains zero or one Target for each OsType, selecting the one that matches the earliest
1842// filter.
Colin Cross3dceee32018-09-06 10:19:57 -07001843func firstTarget(targets []Target, filters ...string) []Target {
Jiyong Park22101982020-09-17 19:09:58 +09001844 // find the first target from each OS
1845 var ret []Target
1846 hasHost := false
1847 set := make(map[OsType]bool)
1848
Colin Cross6b4a32d2017-12-05 13:42:45 -08001849 for _, filter := range filters {
1850 buildTargets := filterMultilibTargets(targets, filter)
Jiyong Park22101982020-09-17 19:09:58 +09001851 for _, t := range buildTargets {
1852 if _, found := set[t.Os]; !found {
1853 hasHost = hasHost || (t.Os.Class == Host)
1854 set[t.Os] = true
1855 ret = append(ret, t)
1856 }
Colin Cross6b4a32d2017-12-05 13:42:45 -08001857 }
1858 }
Jiyong Park22101982020-09-17 19:09:58 +09001859 return ret
Colin Cross6b4a32d2017-12-05 13:42:45 -08001860}
1861
Colin Crossa6845402020-11-16 15:08:19 -08001862// decodeMultilibTargets uses the module's multilib setting to select one or more targets from a
1863// list of Targets.
Colin Crossee0bc3b2018-10-02 22:01:37 -07001864func decodeMultilibTargets(multilib string, targets []Target, prefer32 bool) ([]Target, error) {
Colin Crossa6845402020-11-16 15:08:19 -08001865 var buildTargets []Target
Colin Cross6b4a32d2017-12-05 13:42:45 -08001866
Colin Cross4225f652015-09-17 14:33:42 -07001867 switch multilib {
1868 case "common":
Colin Cross6b4a32d2017-12-05 13:42:45 -08001869 buildTargets = getCommonTargets(targets)
1870 case "common_first":
1871 buildTargets = getCommonTargets(targets)
1872 if prefer32 {
Colin Cross3dceee32018-09-06 10:19:57 -07001873 buildTargets = append(buildTargets, firstTarget(targets, "lib32", "lib64")...)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001874 } else {
Colin Cross3dceee32018-09-06 10:19:57 -07001875 buildTargets = append(buildTargets, firstTarget(targets, "lib64", "lib32")...)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001876 }
Colin Cross4225f652015-09-17 14:33:42 -07001877 case "both":
Colin Cross8b74d172016-09-13 09:59:14 -07001878 if prefer32 {
1879 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib32")...)
1880 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib64")...)
1881 } else {
1882 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib64")...)
1883 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib32")...)
1884 }
Colin Cross4225f652015-09-17 14:33:42 -07001885 case "32":
Colin Cross69617d32016-09-06 10:39:07 -07001886 buildTargets = filterMultilibTargets(targets, "lib32")
Colin Cross4225f652015-09-17 14:33:42 -07001887 case "64":
Colin Cross69617d32016-09-06 10:39:07 -07001888 buildTargets = filterMultilibTargets(targets, "lib64")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001889 case "first":
1890 if prefer32 {
Colin Cross3dceee32018-09-06 10:19:57 -07001891 buildTargets = firstTarget(targets, "lib32", "lib64")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001892 } else {
Colin Cross3dceee32018-09-06 10:19:57 -07001893 buildTargets = firstTarget(targets, "lib64", "lib32")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001894 }
Victor Chang9448e8f2020-09-14 15:34:16 +01001895 case "first_prefer32":
1896 buildTargets = firstTarget(targets, "lib32", "lib64")
Colin Cross69617d32016-09-06 10:39:07 -07001897 case "prefer32":
Colin Cross3dceee32018-09-06 10:19:57 -07001898 buildTargets = filterMultilibTargets(targets, "lib32")
1899 if len(buildTargets) == 0 {
1900 buildTargets = filterMultilibTargets(targets, "lib64")
1901 }
Dan Willemsen47450072021-10-19 20:24:49 -07001902 case "darwin_universal":
1903 buildTargets = filterMultilibTargets(targets, "lib64")
1904 // Reverse the targets so that the first architecture can depend on the second
1905 // architecture module in order to merge the outputs.
1906 reverseSliceInPlace(buildTargets)
1907 case "darwin_universal_common_first":
1908 archTargets := filterMultilibTargets(targets, "lib64")
1909 reverseSliceInPlace(archTargets)
1910 buildTargets = append(getCommonTargets(targets), archTargets...)
Colin Cross4225f652015-09-17 14:33:42 -07001911 default:
Victor Chang9448e8f2020-09-14 15:34:16 +01001912 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 -07001913 multilib)
Colin Cross4225f652015-09-17 14:33:42 -07001914 }
1915
Colin Crossa1ad8d12016-06-01 17:09:44 -07001916 return buildTargets, nil
Colin Cross4225f652015-09-17 14:33:42 -07001917}
Jingwen Chen5d864492021-02-24 07:20:12 -05001918
Chris Parsonsc424b762021-04-29 18:06:50 -04001919func (m *ModuleBase) getArchPropertySet(propertySet interface{}, archType ArchType) interface{} {
1920 archString := archType.Field
1921 for i := range m.archProperties {
1922 if m.archProperties[i] == nil {
1923 // Skip over nil properties
1924 continue
1925 }
1926
1927 // Not archProperties are usable; this function looks for properties of a very specific
1928 // form, and ignores the rest.
1929 for _, archProperty := range m.archProperties[i] {
1930 // archPropValue is a property struct, we are looking for the form:
1931 // `arch: { arm: { key: value, ... }}`
1932 archPropValue := reflect.ValueOf(archProperty).Elem()
1933
1934 // Unwrap src so that it should looks like a pointer to `arm: { key: value, ... }`
1935 src := archPropValue.FieldByName("Arch").Elem()
1936
1937 // Step into non-nil pointers to structs in the src value.
1938 if src.Kind() == reflect.Ptr {
1939 if src.IsNil() {
1940 continue
1941 }
1942 src = src.Elem()
1943 }
1944
1945 // Find the requested field (e.g. arm, x86) in the src struct.
1946 src = src.FieldByName(archString)
1947
1948 // We only care about structs.
1949 if !src.IsValid() || src.Kind() != reflect.Struct {
1950 continue
1951 }
1952
1953 // If the value of the field is a struct then step into the
1954 // BlueprintEmbed field. The special "BlueprintEmbed" name is
1955 // used by createArchPropTypeDesc to embed the arch properties
1956 // in the parent struct, so the src arch prop should be in this
1957 // field.
1958 //
1959 // See createArchPropTypeDesc for more details on how Arch-specific
1960 // module properties are processed from the nested props and written
1961 // into the module's archProperties.
1962 src = src.FieldByName("BlueprintEmbed")
1963
1964 // Clone the destination prop, since we want a unique prop struct per arch.
1965 propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1966
1967 // Copy the located property struct into the cloned destination property struct.
1968 err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)
1969 if err != nil {
1970 // This is fine, it just means the src struct doesn't match the type of propertySet.
1971 continue
1972 }
1973
1974 return propertySetClone
1975 }
1976 }
1977 // No property set was found specific to the given arch, so return an empty
1978 // property set.
1979 return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1980}
1981
1982// getMultilibPropertySet returns a property set struct matching the type of
1983// `propertySet`, containing multilib-specific module properties for the given architecture.
1984// If no multilib-specific properties exist for the given architecture, returns an empty property
1985// set matching `propertySet`'s type.
1986func (m *ModuleBase) getMultilibPropertySet(propertySet interface{}, archType ArchType) interface{} {
1987 // archType.Multilib is lowercase (for example, lib32) but property struct field is
1988 // capitalized, such as Lib32, so use strings.Title to capitalize it.
1989 multiLibString := strings.Title(archType.Multilib)
1990
1991 for i := range m.archProperties {
1992 if m.archProperties[i] == nil {
1993 // Skip over nil properties
1994 continue
1995 }
1996
1997 // Not archProperties are usable; this function looks for properties of a very specific
1998 // form, and ignores the rest.
1999 for _, archProperties := range m.archProperties[i] {
2000 // archPropValue is a property struct, we are looking for the form:
2001 // `multilib: { lib32: { key: value, ... }}`
2002 archPropValue := reflect.ValueOf(archProperties).Elem()
2003
2004 // Unwrap src so that it should looks like a pointer to `lib32: { key: value, ... }`
2005 src := archPropValue.FieldByName("Multilib").Elem()
2006
2007 // Step into non-nil pointers to structs in the src value.
2008 if src.Kind() == reflect.Ptr {
2009 if src.IsNil() {
2010 // Ignore nil pointers.
2011 continue
2012 }
2013 src = src.Elem()
2014 }
2015
2016 // Find the requested field (e.g. lib32) in the src struct.
2017 src = src.FieldByName(multiLibString)
2018
2019 // We only care about valid struct pointers.
2020 if !src.IsValid() || src.Kind() != reflect.Ptr || src.Elem().Kind() != reflect.Struct {
2021 continue
2022 }
2023
2024 // Get the zero value for the requested property set.
2025 propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2026
2027 // Copy the located property struct into the "zero" property set struct.
2028 err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)
2029
2030 if err != nil {
2031 // This is fine, it just means the src struct doesn't match.
2032 continue
2033 }
2034
2035 return propertySetClone
2036 }
2037 }
2038
2039 // There were no multilib properties specifically matching the given archtype.
2040 // Return zeroed value.
2041 return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2042}
2043
Liz Kammerb6dbc872021-05-14 15:14:40 -04002044// ArchVariantContext defines the limited context necessary to retrieve arch_variant properties.
2045type ArchVariantContext interface {
2046 ModuleErrorf(fmt string, args ...interface{})
2047 PropertyErrorf(property, fmt string, args ...interface{})
2048}
2049
Liz Kammer9abd62d2021-05-21 08:37:59 -04002050// ArchVariantProperties represents a map of arch-variant config strings to a property interface{}.
2051type ArchVariantProperties map[string]interface{}
2052
2053// ConfigurationAxisToArchVariantProperties represents a map of bazel.ConfigurationAxis to
2054// ArchVariantProperties, such that each independent arch-variant axis maps to the
2055// configs/properties for that axis.
2056type ConfigurationAxisToArchVariantProperties map[bazel.ConfigurationAxis]ArchVariantProperties
2057
2058// GetArchVariantProperties returns a ConfigurationAxisToArchVariantProperties where the
2059// arch-variant properties correspond to the values of the properties of the 'propertySet' struct
2060// that are specific to that axis/configuration. Each axis is independent, containing
2061// non-overlapping configs that correspond to the various "arch-variant" support, at this time:
2062// arches (including multilib)
2063// oses
2064// arch+os combinations
Jingwen Chen5d864492021-02-24 07:20:12 -05002065//
Liz Kammer9abd62d2021-05-21 08:37:59 -04002066// For example, passing a struct { Foo bool, Bar string } will return an interface{} that can be
2067// type asserted back into the same struct, containing the config-specific property value specified
2068// by the module if defined.
Chris Parsonsc424b762021-04-29 18:06:50 -04002069//
2070// Arch-specific properties may come from an arch stanza or a multilib stanza; properties
2071// in these stanzas are combined.
2072// For example: `arch: { x86: { Foo: ["bar"] } }, multilib: { lib32: {` Foo: ["baz"] } }`
2073// will result in `Foo: ["bar", "baz"]` being returned for architecture x86, if the given
2074// propertyset contains `Foo []string`.
Liz Kammer9abd62d2021-05-21 08:37:59 -04002075func (m *ModuleBase) GetArchVariantProperties(ctx ArchVariantContext, propertySet interface{}) ConfigurationAxisToArchVariantProperties {
Jingwen Chen5d864492021-02-24 07:20:12 -05002076 // Return value of the arch types to the prop values for that arch.
Liz Kammer9abd62d2021-05-21 08:37:59 -04002077 axisToProps := ConfigurationAxisToArchVariantProperties{}
Jingwen Chen5d864492021-02-24 07:20:12 -05002078
2079 // Nothing to do for non-arch-specific modules.
2080 if !m.ArchSpecific() {
Liz Kammer9abd62d2021-05-21 08:37:59 -04002081 return axisToProps
Jingwen Chen5d864492021-02-24 07:20:12 -05002082 }
2083
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002084 dstType := reflect.ValueOf(propertySet).Type()
2085 var archProperties []interface{}
2086
2087 // First find the property set in the module that corresponds to the requested
Usta851a3272022-01-05 23:42:33 -05002088 // one. m.archProperties[i] corresponds to m.GetProperties()[i].
2089 for i, generalProp := range m.GetProperties() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002090 srcType := reflect.ValueOf(generalProp).Type()
2091 if srcType == dstType {
2092 archProperties = m.archProperties[i]
Liz Kammer135bf552021-08-11 10:46:06 -04002093 axisToProps[bazel.NoConfigAxis] = ArchVariantProperties{"": generalProp}
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002094 break
2095 }
2096 }
2097
2098 if archProperties == nil {
2099 // This module does not have the property set requested
Liz Kammer9abd62d2021-05-21 08:37:59 -04002100 return axisToProps
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002101 }
2102
Liz Kammer9abd62d2021-05-21 08:37:59 -04002103 archToProp := ArchVariantProperties{}
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002104 // For each arch type (x86, arm64, etc.)
Chris Parsonsc424b762021-04-29 18:06:50 -04002105 for _, arch := range ArchTypeList() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002106 // Arch properties are sometimes sharded (see createArchPropTypeDesc() ).
2107 // Iterate over ever shard and extract a struct with the same type as the
2108 // input one that contains the data specific to that arch.
2109 propertyStructs := make([]reflect.Value, 0)
2110 for _, archProperty := range archProperties {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02002111 archTypeStruct, ok := getArchTypeStruct(ctx, archProperty, arch)
2112 if ok {
2113 propertyStructs = append(propertyStructs, archTypeStruct)
2114 }
2115 multilibStruct, ok := getMultilibStruct(ctx, archProperty, arch)
2116 if ok {
2117 propertyStructs = append(propertyStructs, multilibStruct)
2118 }
Jingwen Chen5d864492021-02-24 07:20:12 -05002119 }
2120
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002121 // Create a new instance of the requested property set
2122 value := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2123
Chris Parsonsa37e1952021-09-28 16:47:36 -04002124 archToProp[arch.Name] = mergeStructs(ctx, propertyStructs, value)
Jingwen Chen5d864492021-02-24 07:20:12 -05002125 }
Liz Kammer9abd62d2021-05-21 08:37:59 -04002126 axisToProps[bazel.ArchConfigurationAxis] = archToProp
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002127
Liz Kammer9abd62d2021-05-21 08:37:59 -04002128 osToProp := ArchVariantProperties{}
2129 archOsToProp := ArchVariantProperties{}
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002130
Liz Kammerfdd72e62021-10-11 15:41:03 -04002131 linuxStructs := getTargetStructs(ctx, archProperties, "Linux")
2132 bionicStructs := getTargetStructs(ctx, archProperties, "Bionic")
2133 hostStructs := getTargetStructs(ctx, archProperties, "Host")
2134 hostNotWindowsStructs := getTargetStructs(ctx, archProperties, "Not_windows")
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002135
Liz Kammer9abd62d2021-05-21 08:37:59 -04002136 // For android, linux, ...
2137 for _, os := range osTypeList {
2138 if os == CommonOS {
2139 // It looks like this OS value is not used in Blueprint files
2140 continue
2141 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002142 osStructs := make([]reflect.Value, 0)
Liz Kammerfdd72e62021-10-11 15:41:03 -04002143
2144 osSpecificStructs := getTargetStructs(ctx, archProperties, os.Field)
2145 if os.Class == Host {
2146 osStructs = append(osStructs, hostStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002147 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002148 if os.Linux() {
2149 osStructs = append(osStructs, linuxStructs...)
2150 }
2151 if os.Bionic() {
2152 osStructs = append(osStructs, bionicStructs...)
2153 }
Liz Kammerfdd72e62021-10-11 15:41:03 -04002154
2155 if os == LinuxMusl {
2156 osStructs = append(osStructs, getTargetStructs(ctx, archProperties, "Musl")...)
2157 }
2158 if os == Linux {
2159 osStructs = append(osStructs, getTargetStructs(ctx, archProperties, "Glibc")...)
2160 }
2161
2162 osStructs = append(osStructs, osSpecificStructs...)
2163
2164 if os.Class == Host && os != Windows {
2165 osStructs = append(osStructs, hostNotWindowsStructs...)
2166 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002167 osToProp[os.Name] = mergeStructs(ctx, osStructs, propertySet)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002168
Liz Kammer9abd62d2021-05-21 08:37:59 -04002169 // For arm, x86, ...
2170 for _, arch := range osArchTypeMap[os] {
Chris Parsonsa37e1952021-09-28 16:47:36 -04002171 osArchStructs := make([]reflect.Value, 0)
2172
Chris Parsonsa37e1952021-09-28 16:47:36 -04002173 // Auto-combine with Linux_ and Bionic_ targets. This potentially results in
2174 // repetition and select() bloat, but use of Linux_* and Bionic_* targets is rare.
2175 // TODO(b/201423152): Look into cleanup.
2176 if os.Linux() {
2177 targetField := "Linux_" + arch.Name
Liz Kammerfdd72e62021-10-11 15:41:03 -04002178 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2179 osArchStructs = append(osArchStructs, targetStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002180 }
2181 if os.Bionic() {
2182 targetField := "Bionic_" + arch.Name
Liz Kammerfdd72e62021-10-11 15:41:03 -04002183 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2184 osArchStructs = append(osArchStructs, targetStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002185 }
2186
Liz Kammerfdd72e62021-10-11 15:41:03 -04002187 targetField := GetCompoundTargetField(os, arch)
2188 targetName := fmt.Sprintf("%s_%s", os.Name, arch.Name)
2189 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2190 osArchStructs = append(osArchStructs, targetStructs...)
2191
Chris Parsonsa37e1952021-09-28 16:47:36 -04002192 archOsToProp[targetName] = mergeStructs(ctx, osArchStructs, propertySet)
Liz Kammer9abd62d2021-05-21 08:37:59 -04002193 }
2194 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002195
Liz Kammer9abd62d2021-05-21 08:37:59 -04002196 axisToProps[bazel.OsConfigurationAxis] = osToProp
2197 axisToProps[bazel.OsArchConfigurationAxis] = archOsToProp
Liz Kammer9abd62d2021-05-21 08:37:59 -04002198 return axisToProps
Jingwen Chen5d864492021-02-24 07:20:12 -05002199}
Jingwen Chen91220d72021-03-24 02:18:33 -04002200
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002201// Returns a struct matching the propertySet interface, containing properties specific to the targetName
2202// For example, given these arguments:
2203// propertySet = BaseCompilerProperties
2204// targetName = "android_arm"
2205// And given this Android.bp fragment:
2206// target:
2207// android_arm: {
2208// srcs: ["foo.c"],
2209// }
2210// android_arm64: {
2211// srcs: ["bar.c"],
2212// }
2213// }
2214// This would return a BaseCompilerProperties with BaseCompilerProperties.Srcs = ["foo.c"]
Liz Kammerfdd72e62021-10-11 15:41:03 -04002215func getTargetStructs(ctx ArchVariantContext, archProperties []interface{}, targetName string) []reflect.Value {
2216 var propertyStructs []reflect.Value
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002217 for _, archProperty := range archProperties {
2218 archPropValues := reflect.ValueOf(archProperty).Elem()
2219 targetProp := archPropValues.FieldByName("Target").Elem()
2220 targetStruct, ok := getChildPropertyStruct(ctx, targetProp, targetName, targetName)
2221 if ok {
2222 propertyStructs = append(propertyStructs, targetStruct)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002223 } else {
Liz Kammerfdd72e62021-10-11 15:41:03 -04002224 return []reflect.Value{}
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002225 }
2226 }
2227
Liz Kammerfdd72e62021-10-11 15:41:03 -04002228 return propertyStructs
Chris Parsonsa37e1952021-09-28 16:47:36 -04002229}
2230
2231func mergeStructs(ctx ArchVariantContext, propertyStructs []reflect.Value, propertySet interface{}) interface{} {
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002232 // Create a new instance of the requested property set
2233 value := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2234
2235 // Merge all the structs together
2236 for _, propertyStruct := range propertyStructs {
2237 mergePropertyStruct(ctx, value, propertyStruct)
2238 }
2239
2240 return value
2241}