blob: c39db0200e4ef8c2a12d27aaf7d963dce49b2f14 [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"
Liz Kammer992918d2022-11-11 10:37:54 -050019 "encoding/json"
Colin Cross3f40fa42015-01-30 17:27:36 -080020 "fmt"
21 "reflect"
22 "runtime"
Cole Faustc843b992022-08-02 18:06:50 -070023 "sort"
Colin Cross3f40fa42015-01-30 17:27:36 -080024 "strings"
Colin Crossf6566ed2015-03-24 11:13:38 -070025
Colin Crosscb0ac952021-07-20 13:17:15 -070026 "android/soong/bazel"
Liz Kammere8303bd2022-02-16 09:02:48 -050027 "android/soong/starlark_fmt"
Colin Crosscb0ac952021-07-20 13:17:15 -070028
Colin Cross0f7d2ef2019-10-16 11:03:10 -070029 "github.com/google/blueprint"
Colin Cross617b88a2020-08-24 18:04:09 -070030 "github.com/google/blueprint/bootstrap"
Colin Crossf6566ed2015-03-24 11:13:38 -070031 "github.com/google/blueprint/proptools"
Colin Cross3f40fa42015-01-30 17:27:36 -080032)
33
Colin Cross3f40fa42015-01-30 17:27:36 -080034/*
35Example blueprints file containing all variant property groups, with comment listing what type
36of variants get properties in that group:
37
38module {
39 arch: {
40 arm: {
41 // Host or device variants with arm architecture
42 },
43 arm64: {
44 // Host or device variants with arm64 architecture
45 },
Colin Cross3f40fa42015-01-30 17:27:36 -080046 x86: {
47 // Host or device variants with x86 architecture
48 },
49 x86_64: {
50 // Host or device variants with x86_64 architecture
51 },
52 },
53 multilib: {
54 lib32: {
55 // Host or device variants for 32-bit architectures
56 },
57 lib64: {
58 // Host or device variants for 64-bit architectures
59 },
60 },
61 target: {
62 android: {
Martin Stjernholme284b482020-09-23 21:03:27 +010063 // Device variants (implies Bionic)
Colin Cross3f40fa42015-01-30 17:27:36 -080064 },
65 host: {
66 // Host variants
67 },
Martin Stjernholme284b482020-09-23 21:03:27 +010068 bionic: {
69 // Bionic (device and host) variants
70 },
71 linux_bionic: {
72 // Bionic host variants
73 },
74 linux: {
75 // Bionic (device and host) and Linux glibc variants
76 },
Dan Willemsen5746bd42017-10-02 19:42:01 -070077 linux_glibc: {
Martin Stjernholme284b482020-09-23 21:03:27 +010078 // Linux host variants (using non-Bionic libc)
Colin Cross3f40fa42015-01-30 17:27:36 -080079 },
80 darwin: {
81 // Darwin host variants
82 },
83 windows: {
84 // Windows host variants
85 },
86 not_windows: {
87 // Non-windows host variants
88 },
Martin Stjernholme284b482020-09-23 21:03:27 +010089 android_arm: {
90 // Any <os>_<arch> combination restricts to that os and arch
91 },
Colin Cross3f40fa42015-01-30 17:27:36 -080092 },
93}
94*/
Colin Cross7d5136f2015-05-11 13:39:40 -070095
Colin Cross3f40fa42015-01-30 17:27:36 -080096// An Arch indicates a single CPU architecture.
97type Arch struct {
Colin Crossa6845402020-11-16 15:08:19 -080098 // The type of the architecture (arm, arm64, x86, or x86_64).
99 ArchType ArchType
100
101 // The variant of the architecture, for example "armv7-a" or "armv7-a-neon" for arm.
102 ArchVariant string
103
104 // The variant of the CPU, for example "cortex-a53" for arm64.
105 CpuVariant string
106
107 // The list of Android app ABIs supported by the CPU architecture, for example "arm64-v8a".
108 Abi []string
109
110 // The list of arch-specific features supported by the CPU architecture, for example "neon".
Colin Crossc5c24ad2015-11-20 15:35:00 -0800111 ArchFeatures []string
Colin Cross3f40fa42015-01-30 17:27:36 -0800112}
113
Colin Crossa6845402020-11-16 15:08:19 -0800114// String returns the Arch as a string. The value is used as the name of the variant created
115// by archMutator.
Colin Cross3f40fa42015-01-30 17:27:36 -0800116func (a Arch) String() string {
Colin Crossd3ba0392015-05-07 14:11:29 -0700117 s := a.ArchType.String()
Colin Cross3f40fa42015-01-30 17:27:36 -0800118 if a.ArchVariant != "" {
119 s += "_" + a.ArchVariant
120 }
121 if a.CpuVariant != "" {
122 s += "_" + a.CpuVariant
123 }
124 return s
125}
126
Colin Crossa6845402020-11-16 15:08:19 -0800127// ArchType is used to define the 4 supported architecture types (arm, arm64, x86, x86_64), as
128// well as the "common" architecture used for modules that support multiple architectures, for
129// example Java modules.
Colin Cross3f40fa42015-01-30 17:27:36 -0800130type ArchType struct {
Colin Crossa6845402020-11-16 15:08:19 -0800131 // Name is the name of the architecture type, "arm", "arm64", "x86", or "x86_64".
132 Name string
133
134 // Field is the name of the field used in properties that refer to the architecture, e.g. "Arm64".
135 Field string
136
137 // Multilib is either "lib32" or "lib64" for 32-bit or 64-bit architectures.
Colin Crossec193632015-07-06 17:49:43 -0700138 Multilib string
Colin Cross3f40fa42015-01-30 17:27:36 -0800139}
140
Colin Crossa6845402020-11-16 15:08:19 -0800141// String returns the name of the ArchType.
142func (a ArchType) String() string {
143 return a.Name
144}
145
146const COMMON_VARIANT = "common"
147
148var (
149 archTypeList []ArchType
150
Colin Crossf05b0d32022-07-14 18:10:34 -0700151 Arm = newArch("arm", "lib32")
152 Arm64 = newArch("arm64", "lib64")
153 Riscv64 = newArch("riscv64", "lib64")
154 X86 = newArch("x86", "lib32")
155 X86_64 = newArch("x86_64", "lib64")
Colin Crossa6845402020-11-16 15:08:19 -0800156
157 Common = ArchType{
158 Name: COMMON_VARIANT,
159 }
160)
161
162var archTypeMap = map[string]ArchType{}
163
Colin Crossec193632015-07-06 17:49:43 -0700164func newArch(name, multilib string) ArchType {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700165 archType := ArchType{
Colin Crossec193632015-07-06 17:49:43 -0700166 Name: name,
Dan Willemsenb1957a52016-06-23 23:44:54 -0700167 Field: proptools.FieldNameForProperty(name),
Colin Crossec193632015-07-06 17:49:43 -0700168 Multilib: multilib,
Colin Cross3f40fa42015-01-30 17:27:36 -0800169 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700170 archTypeList = append(archTypeList, archType)
Colin Crossa6845402020-11-16 15:08:19 -0800171 archTypeMap[name] = archType
Dan Willemsenb1957a52016-06-23 23:44:54 -0700172 return archType
Colin Cross3f40fa42015-01-30 17:27:36 -0800173}
174
Ustaeabf0f32021-12-06 15:17:23 -0500175// ArchTypeList returns a slice copy of the 4 supported ArchTypes for arm,
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000176// arm64, x86 and x86_64.
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700177func ArchTypeList() []ArchType {
178 return append([]ArchType(nil), archTypeList...)
179}
180
Colin Crossa6845402020-11-16 15:08:19 -0800181// MarshalText allows an ArchType to be serialized through any encoder that supports
182// encoding.TextMarshaler.
Colin Cross74ba9622019-02-11 15:11:14 -0800183func (a ArchType) MarshalText() ([]byte, error) {
Jeongik Chabec4d032021-04-15 08:55:38 +0900184 return []byte(a.String()), nil
Colin Cross74ba9622019-02-11 15:11:14 -0800185}
186
Colin Crossa6845402020-11-16 15:08:19 -0800187var _ encoding.TextMarshaler = ArchType{}
Colin Cross74ba9622019-02-11 15:11:14 -0800188
Colin Crossa6845402020-11-16 15:08:19 -0800189// UnmarshalText allows an ArchType to be deserialized through any decoder that supports
190// encoding.TextUnmarshaler.
Colin Cross74ba9622019-02-11 15:11:14 -0800191func (a *ArchType) UnmarshalText(text []byte) error {
192 if u, ok := archTypeMap[string(text)]; ok {
193 *a = u
194 return nil
195 }
196
197 return fmt.Errorf("unknown ArchType %q", text)
198}
199
Colin Crossa6845402020-11-16 15:08:19 -0800200var _ encoding.TextUnmarshaler = &ArchType{}
Colin Crossa1ad8d12016-06-01 17:09:44 -0700201
Colin Crossa6845402020-11-16 15:08:19 -0800202// OsClass is an enum that describes whether a variant of a module runs on the host, on the device,
203// or is generic.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700204type OsClass int
205
206const (
Colin Crossa6845402020-11-16 15:08:19 -0800207 // Generic is used for variants of modules that are not OS-specific.
Dan Willemsen0e2d97b2016-11-28 17:50:06 -0800208 Generic OsClass = iota
Colin Crossa6845402020-11-16 15:08:19 -0800209 // Device is used for variants of modules that run on the device.
Dan Willemsen0e2d97b2016-11-28 17:50:06 -0800210 Device
Colin Crossa6845402020-11-16 15:08:19 -0800211 // Host is used for variants of modules that run on the host.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700212 Host
Colin Crossa1ad8d12016-06-01 17:09:44 -0700213)
214
Colin Crossa6845402020-11-16 15:08:19 -0800215// String returns the OsClass as a string.
Colin Cross67a5c132017-05-09 13:45:28 -0700216func (class OsClass) String() string {
217 switch class {
218 case Generic:
219 return "generic"
220 case Device:
221 return "device"
222 case Host:
223 return "host"
Colin Cross67a5c132017-05-09 13:45:28 -0700224 default:
225 panic(fmt.Errorf("unknown class %d", class))
226 }
227}
228
Colin Crossa6845402020-11-16 15:08:19 -0800229// OsType describes an OS variant of a module.
230type OsType struct {
231 // Name is the name of the OS. It is also used as the name of the property in Android.bp
232 // files.
233 Name string
234
235 // Field is the name of the OS converted to an exported field name, i.e. with the first
236 // character capitalized.
237 Field string
238
239 // Class is the OsClass of the OS.
240 Class OsClass
241
242 // DefaultDisabled is set when the module variants for the OS should not be created unless
243 // the module explicitly requests them. This is used to limit Windows cross compilation to
244 // only modules that need it.
245 DefaultDisabled bool
246}
247
248// String returns the name of the OsType.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700249func (os OsType) String() string {
250 return os.Name
Colin Cross54c71122016-06-01 17:09:44 -0700251}
252
Colin Crossa6845402020-11-16 15:08:19 -0800253// Bionic returns true if the OS uses the Bionic libc runtime, i.e. if the OS is Android or
254// is Linux with Bionic.
Dan Willemsen866b5632017-09-22 12:28:24 -0700255func (os OsType) Bionic() bool {
256 return os == Android || os == LinuxBionic
257}
258
Colin Crossa6845402020-11-16 15:08:19 -0800259// Linux returns true if the OS uses the Linux kernel, i.e. if the OS is Android or is Linux
260// with or without the Bionic libc runtime.
Dan Willemsen866b5632017-09-22 12:28:24 -0700261func (os OsType) Linux() bool {
Colin Cross528d67e2021-07-23 22:23:07 +0000262 return os == Android || os == Linux || os == LinuxBionic || os == LinuxMusl
Dan Willemsen866b5632017-09-22 12:28:24 -0700263}
264
Colin Crossa6845402020-11-16 15:08:19 -0800265// newOsType constructs an OsType and adds it to the global lists.
266func newOsType(name string, class OsClass, defDisabled bool, archTypes ...ArchType) OsType {
267 checkCalledFromInit()
Colin Crossa1ad8d12016-06-01 17:09:44 -0700268 os := OsType{
269 Name: name,
Colin Crossa6845402020-11-16 15:08:19 -0800270 Field: proptools.FieldNameForProperty(name),
Colin Crossa1ad8d12016-06-01 17:09:44 -0700271 Class: class,
Dan Willemsen0a37a2a2016-11-13 10:16:05 -0800272
273 DefaultDisabled: defDisabled,
Colin Cross54c71122016-06-01 17:09:44 -0700274 }
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000275 osTypeList = append(osTypeList, os)
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800276
277 if _, found := commonTargetMap[name]; found {
278 panic(fmt.Errorf("Found Os type duplicate during OsType registration: %q", name))
279 } else {
Colin Crosse9fe2942020-11-10 18:12:15 -0800280 commonTargetMap[name] = Target{Os: os, Arch: CommonArch}
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800281 }
Colin Crossa6845402020-11-16 15:08:19 -0800282 osArchTypeMap[os] = archTypes
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800283
Colin Crossa1ad8d12016-06-01 17:09:44 -0700284 return os
285}
286
Colin Crossa6845402020-11-16 15:08:19 -0800287// osByName returns the OsType that has the given name, or NoOsType if none match.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700288func osByName(name string) OsType {
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000289 for _, os := range osTypeList {
Colin Crossa1ad8d12016-06-01 17:09:44 -0700290 if os.Name == name {
291 return os
292 }
293 }
294
295 return NoOsType
Dan Willemsen490fd492015-11-24 17:53:15 -0800296}
297
Colin Crossa6845402020-11-16 15:08:19 -0800298var (
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000299 // osTypeList contains a list of all the supported OsTypes, including ones not supported
Colin Crossa6845402020-11-16 15:08:19 -0800300 // by the current build host or the target device.
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000301 osTypeList []OsType
Colin Crossa6845402020-11-16 15:08:19 -0800302 // commonTargetMap maps names of OsTypes to the corresponding common Target, i.e. the
303 // Target with the same OsType and the common ArchType.
304 commonTargetMap = make(map[string]Target)
305 // osArchTypeMap maps OsTypes to the list of supported ArchTypes for that OS.
306 osArchTypeMap = map[OsType][]ArchType{}
307
308 // NoOsType is a placeholder for when no OS is needed.
309 NoOsType OsType
310 // Linux is the OS for the Linux kernel plus the glibc runtime.
311 Linux = newOsType("linux_glibc", Host, false, X86, X86_64)
Colin Cross528d67e2021-07-23 22:23:07 +0000312 // LinuxMusl is the OS for the Linux kernel plus the musl runtime.
Colin Crossa9b2aac2022-06-15 17:25:51 -0700313 LinuxMusl = newOsType("linux_musl", Host, false, X86, X86_64, Arm64, Arm)
Colin Crossa6845402020-11-16 15:08:19 -0800314 // Darwin is the OS for MacOS/Darwin host machines.
Dan Willemsen8528f4e2021-10-19 00:22:06 -0700315 Darwin = newOsType("darwin", Host, false, Arm64, X86_64)
Colin Crossa6845402020-11-16 15:08:19 -0800316 // LinuxBionic is the OS for the Linux kernel plus the Bionic libc runtime, but without the
317 // rest of Android.
318 LinuxBionic = newOsType("linux_bionic", Host, false, Arm64, X86_64)
319 // Windows the OS for Windows host machines.
320 Windows = newOsType("windows", Host, true, X86, X86_64)
321 // Android is the OS for target devices that run all of Android, including the Linux kernel
322 // and the Bionic libc runtime.
Colin Crossf05b0d32022-07-14 18:10:34 -0700323 Android = newOsType("android", Device, false, Arm, Arm64, Riscv64, X86, X86_64)
Colin Crossa6845402020-11-16 15:08:19 -0800324
325 // CommonOS is a pseudo OSType for a common OS variant, which is OsType agnostic and which
326 // has dependencies on all the OS variants.
327 CommonOS = newOsType("common_os", Generic, false)
Colin Crosse9fe2942020-11-10 18:12:15 -0800328
329 // CommonArch is the Arch for all modules that are os-specific but not arch specific,
330 // for example most Java modules.
331 CommonArch = Arch{ArchType: Common}
dimitry1f33e402019-03-26 12:39:31 +0100332)
333
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000334// OsTypeList returns a slice copy of the supported OsTypes.
335func OsTypeList() []OsType {
336 return append([]OsType(nil), osTypeList...)
337}
338
Colin Crossa6845402020-11-16 15:08:19 -0800339// Target specifies the OS and architecture that a module is being compiled for.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700340type Target struct {
Colin Crossa6845402020-11-16 15:08:19 -0800341 // Os the OS that the module is being compiled for (e.g. "linux_glibc", "android").
342 Os OsType
343 // Arch is the architecture that the module is being compiled for.
344 Arch Arch
345 // NativeBridge is NativeBridgeEnabled if the architecture is supported using NativeBridge
346 // (i.e. arm on x86) for this device.
347 NativeBridge NativeBridgeSupport
348 // NativeBridgeHostArchName is the name of the real architecture that is used to implement
349 // the NativeBridge architecture. For example, for arm on x86 this would be "x86".
dimitry8d6dde82019-07-11 10:23:53 +0200350 NativeBridgeHostArchName string
Colin Crossa6845402020-11-16 15:08:19 -0800351 // NativeBridgeRelativePath is the name of the subdirectory that will contain NativeBridge
352 // libraries and binaries.
dimitry8d6dde82019-07-11 10:23:53 +0200353 NativeBridgeRelativePath string
Jiyong Park1613e552020-09-14 19:43:17 +0900354
355 // HostCross is true when the target cannot run natively on the current build host.
356 // For example, linux_glibc_x86 returns true on a regular x86/i686/Linux machines, but returns false
357 // on Mac (different OS), or on 64-bit only i686/Linux machines (unsupported arch).
358 HostCross bool
Colin Crossd3ba0392015-05-07 14:11:29 -0700359}
360
Colin Crossa6845402020-11-16 15:08:19 -0800361// NativeBridgeSupport is an enum that specifies if a Target supports NativeBridge.
362type NativeBridgeSupport bool
363
364const (
365 NativeBridgeDisabled NativeBridgeSupport = false
366 NativeBridgeEnabled NativeBridgeSupport = true
367)
368
369// String returns the OS and arch variations used for the Target.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700370func (target Target) String() string {
Colin Crossa195f912019-10-16 11:07:20 -0700371 return target.OsVariation() + "_" + target.ArchVariation()
372}
373
Colin Crossa6845402020-11-16 15:08:19 -0800374// OsVariation returns the name of the variation used by the osMutator for the Target.
Colin Crossa195f912019-10-16 11:07:20 -0700375func (target Target) OsVariation() string {
376 return target.Os.String()
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700377}
378
Colin Crossa6845402020-11-16 15:08:19 -0800379// ArchVariation returns the name of the variation used by the archMutator for the Target.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700380func (target Target) ArchVariation() string {
381 var variation string
dimitry1f33e402019-03-26 12:39:31 +0100382 if target.NativeBridge {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700383 variation = "native_bridge_"
dimitry1f33e402019-03-26 12:39:31 +0100384 }
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700385 variation += target.Arch.String()
386
Colin Crossa195f912019-10-16 11:07:20 -0700387 return variation
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700388}
389
Colin Crossa6845402020-11-16 15:08:19 -0800390// Variations returns a list of blueprint.Variations for the osMutator and archMutator for the
391// Target.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700392func (target Target) Variations() []blueprint.Variation {
393 return []blueprint.Variation{
Colin Crossa195f912019-10-16 11:07:20 -0700394 {Mutator: "os", Variation: target.OsVariation()},
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700395 {Mutator: "arch", Variation: target.ArchVariation()},
396 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800397}
398
Colin Crossa6845402020-11-16 15:08:19 -0800399// osMutator splits an arch-specific module into a variant for each OS that is enabled for the
400// module. It uses the HostOrDevice value passed to InitAndroidArchModule and the
401// device_supported and host_supported properties to determine which OsTypes are enabled for this
402// module, then searches through the Targets to determine which have enabled Targets for this
403// module.
Colin Cross617b88a2020-08-24 18:04:09 -0700404func osMutator(bpctx blueprint.BottomUpMutatorContext) {
Colin Crossa195f912019-10-16 11:07:20 -0700405 var module Module
406 var ok bool
Colin Cross617b88a2020-08-24 18:04:09 -0700407 if module, ok = bpctx.Module().(Module); !ok {
Colin Crossa6845402020-11-16 15:08:19 -0800408 // The module is not a Soong module, it is a Blueprint module.
Colin Cross617b88a2020-08-24 18:04:09 -0700409 if bootstrap.IsBootstrapModule(bpctx.Module()) {
410 // Bootstrap Go modules are always the build OS or linux bionic.
411 config := bpctx.Config().(Config)
412 osNames := []string{config.BuildOSTarget.OsVariation()}
413 for _, hostCrossTarget := range config.Targets[LinuxBionic] {
414 if hostCrossTarget.Arch.ArchType == config.BuildOSTarget.Arch.ArchType {
415 osNames = append(osNames, hostCrossTarget.OsVariation())
416 }
417 }
418 osNames = FirstUniqueStrings(osNames)
419 bpctx.CreateVariations(osNames...)
420 }
Colin Crossa195f912019-10-16 11:07:20 -0700421 return
422 }
423
Colin Cross617b88a2020-08-24 18:04:09 -0700424 // Bootstrap Go module support above requires this mutator to be a
425 // blueprint.BottomUpMutatorContext because android.BottomUpMutatorContext
426 // filters out non-Soong modules. Now that we've handled them, create a
427 // normal android.BottomUpMutatorContext.
Colin Crossb63d7b32023-12-07 16:54:51 -0800428 mctx := bottomUpMutatorContextFactory(bpctx, module, false)
Colin Cross617b88a2020-08-24 18:04:09 -0700429
Colin Crossa195f912019-10-16 11:07:20 -0700430 base := module.base()
431
Colin Crossa6845402020-11-16 15:08:19 -0800432 // Nothing to do for modules that are not architecture specific (e.g. a genrule).
Colin Crossa195f912019-10-16 11:07:20 -0700433 if !base.ArchSpecific() {
434 return
435 }
436
Colin Crossa6845402020-11-16 15:08:19 -0800437 // Collect a list of OSTypes supported by this module based on the HostOrDevice value
438 // passed to InitAndroidArchModule and the device_supported and host_supported properties.
Colin Crossa195f912019-10-16 11:07:20 -0700439 var moduleOSList []OsType
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000440 for _, os := range osTypeList {
Jiyong Park1613e552020-09-14 19:43:17 +0900441 for _, t := range mctx.Config().Targets[os] {
Colin Cross08d6f8f2020-11-19 02:33:19 +0000442 if base.supportsTarget(t) {
Jiyong Park1613e552020-09-14 19:43:17 +0900443 moduleOSList = append(moduleOSList, os)
444 break
Colin Crossa195f912019-10-16 11:07:20 -0700445 }
446 }
Colin Crossa195f912019-10-16 11:07:20 -0700447 }
448
Cole Faust8fc38f32023-12-12 17:14:22 -0800449 createCommonOSVariant := base.commonProperties.CreateCommonOSVariant
450
Colin Crossa6845402020-11-16 15:08:19 -0800451 // If there are no supported OSes then disable the module.
Cole Faust8fc38f32023-12-12 17:14:22 -0800452 if len(moduleOSList) == 0 && !createCommonOSVariant {
Inseob Kimeec88e12020-01-22 11:11:29 +0900453 base.Disable()
Colin Crossa195f912019-10-16 11:07:20 -0700454 return
455 }
456
Colin Crossa6845402020-11-16 15:08:19 -0800457 // Convert the list of supported OsTypes to the variation names.
Colin Crossa195f912019-10-16 11:07:20 -0700458 osNames := make([]string, len(moduleOSList))
Colin Crossa195f912019-10-16 11:07:20 -0700459 for i, os := range moduleOSList {
460 osNames[i] = os.String()
461 }
462
Paul Duffin1356d8c2020-02-25 19:26:33 +0000463 if createCommonOSVariant {
Colin Crossa6845402020-11-16 15:08:19 -0800464 // A CommonOS variant was requested so add it to the list of OS variants to
Paul Duffin1356d8c2020-02-25 19:26:33 +0000465 // create. It needs to be added to the end because it needs to depend on the
466 // the other variants in the list returned by CreateVariations(...) and inter
467 // variant dependencies can only be created from a later variant in that list to
468 // an earlier one. That is because variants are always processed in the order in
469 // which they are returned from CreateVariations(...).
470 osNames = append(osNames, CommonOS.Name)
471 moduleOSList = append(moduleOSList, CommonOS)
Colin Crossa195f912019-10-16 11:07:20 -0700472 }
473
Colin Crossa6845402020-11-16 15:08:19 -0800474 // Create the variations, annotate each one with which OS it was created for, and
475 // squash the appropriate OS-specific properties into the top level properties.
Paul Duffin1356d8c2020-02-25 19:26:33 +0000476 modules := mctx.CreateVariations(osNames...)
477 for i, m := range modules {
478 m.base().commonProperties.CompileOS = moduleOSList[i]
479 m.base().setOSProperties(mctx)
480 }
481
482 if createCommonOSVariant {
483 // A CommonOS variant was requested so add dependencies from it (the last one in
484 // the list) to the OS type specific variants.
485 last := len(modules) - 1
486 commonOSVariant := modules[last]
487 commonOSVariant.base().commonProperties.CommonOSVariant = true
488 for _, module := range modules[0:last] {
489 // Ignore modules that are enabled. Note, this will only avoid adding
490 // dependencies on OsType variants that are explicitly disabled in their
491 // properties. The CommonOS variant will still depend on disabled variants
492 // if they are disabled afterwards, e.g. in archMutator if
493 if module.Enabled() {
494 mctx.AddInterVariantDependency(commonOsToOsSpecificVariantTag, commonOSVariant, module)
495 }
496 }
497 }
498}
499
Colin Crossc179ea62020-10-09 10:54:15 -0700500type archDepTag struct {
501 blueprint.BaseDependencyTag
502 name string
503}
Paul Duffin1356d8c2020-02-25 19:26:33 +0000504
Colin Crossc179ea62020-10-09 10:54:15 -0700505// Identifies the dependency from CommonOS variant to the os specific variants.
506var commonOsToOsSpecificVariantTag = archDepTag{name: "common os to os specific"}
507
Paul Duffin1356d8c2020-02-25 19:26:33 +0000508// Get the OsType specific variants for the current CommonOS variant.
509//
510// The returned list will only contain enabled OsType specific variants of the
511// module referenced in the supplied context. An empty list is returned if there
512// are no enabled variants or the supplied context is not for an CommonOS
513// variant.
514func GetOsSpecificVariantsOfCommonOSVariant(mctx BaseModuleContext) []Module {
515 var variants []Module
516 mctx.VisitDirectDeps(func(m Module) {
517 if mctx.OtherModuleDependencyTag(m) == commonOsToOsSpecificVariantTag {
518 if m.Enabled() {
519 variants = append(variants, m)
520 }
521 }
522 })
Paul Duffin1356d8c2020-02-25 19:26:33 +0000523 return variants
Colin Crossa195f912019-10-16 11:07:20 -0700524}
525
Dan Willemsen47450072021-10-19 20:24:49 -0700526var DarwinUniversalVariantTag = archDepTag{name: "darwin universal binary"}
527
Colin Crossee0bc3b2018-10-02 22:01:37 -0700528// archMutator splits a module into a variant for each Target requested by the module. Target selection
Colin Crossa6845402020-11-16 15:08:19 -0800529// for a module is in three levels, OsClass, multilib, and then Target.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700530// OsClass selection is determined by:
Colin Crossd079e0b2022-08-16 10:27:33 -0700531// - The HostOrDeviceSupported value passed in to InitAndroidArchModule by the module type factory, which selects
532// whether the module type can compile for host, device or both.
533// - The host_supported and device_supported properties on the module.
534//
Roland Levillainf5b635d2019-06-05 14:42:57 +0100535// 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 -0700536// for the module, the Device OsClass is selected.
537// Within each selected OsClass, the multilib selection is determined by:
Colin Crossd079e0b2022-08-16 10:27:33 -0700538// - The compile_multilib property if it set (which may be overridden by target.android.compile_multilib or
539// target.host.compile_multilib).
540// - The default multilib passed to InitAndroidArchModule if compile_multilib was not set.
541//
Colin Crossee0bc3b2018-10-02 22:01:37 -0700542// Valid multilib values include:
Colin Crossd079e0b2022-08-16 10:27:33 -0700543//
544// "both": compile for all Targets supported by the OsClass (generally x86_64 and x86, or arm64 and arm).
545// "first": compile for only a single preferred Target supported by the OsClass. This is generally x86_64 or arm64,
546// but may be arm for a 32-bit only build.
547// "32": compile for only a single 32-bit Target supported by the OsClass.
548// "64": compile for only a single 64-bit Target supported by the OsClass.
549// "common": compile a for a single Target that will work on all Targets supported by the OsClass (for example Java).
550// "common_first": compile a for a Target that will work on all Targets supported by the OsClass
551// (same as "common"), plus a second Target for the preferred Target supported by the OsClass
552// (same as "first"). This is used for java_binary that produces a common .jar and a wrapper
553// executable script.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700554//
555// Once the list of Targets is determined, the module is split into a variant for each Target.
556//
557// Modules can be initialized with InitAndroidMultiTargetsArchModule, in which case they will be split by OsClass,
558// 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 -0700559func archMutator(bpctx blueprint.BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700560 var module Module
Colin Cross3f40fa42015-01-30 17:27:36 -0800561 var ok bool
Colin Cross617b88a2020-08-24 18:04:09 -0700562 if module, ok = bpctx.Module().(Module); !ok {
563 if bootstrap.IsBootstrapModule(bpctx.Module()) {
564 // Bootstrap Go modules are always the build architecture.
565 bpctx.CreateVariations(bpctx.Config().(Config).BuildOSTarget.ArchVariation())
566 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800567 return
568 }
569
Colin Cross617b88a2020-08-24 18:04:09 -0700570 // Bootstrap Go module support above requires this mutator to be a
571 // blueprint.BottomUpMutatorContext because android.BottomUpMutatorContext
572 // filters out non-Soong modules. Now that we've handled them, create a
573 // normal android.BottomUpMutatorContext.
Colin Crossb63d7b32023-12-07 16:54:51 -0800574 mctx := bottomUpMutatorContextFactory(bpctx, module, false)
Colin Cross617b88a2020-08-24 18:04:09 -0700575
Colin Cross5eca7cb2018-10-02 14:02:10 -0700576 base := module.base()
577
578 if !base.ArchSpecific() {
Colin Crossb9db4802016-06-03 01:50:47 +0000579 return
580 }
581
Colin Crossa195f912019-10-16 11:07:20 -0700582 os := base.commonProperties.CompileOS
Paul Duffin1356d8c2020-02-25 19:26:33 +0000583 if os == CommonOS {
584 // Make sure that the target related properties are initialized for the
585 // CommonOS variant.
586 addTargetProperties(module, commonTargetMap[os.Name], nil, true)
587
588 // Do not create arch specific variants for the CommonOS variant.
589 return
590 }
591
Colin Crossa195f912019-10-16 11:07:20 -0700592 osTargets := mctx.Config().Targets[os]
Colin Crossfb0c16e2019-11-20 17:12:35 -0800593 image := base.commonProperties.ImageVariation
Colin Crossa6845402020-11-16 15:08:19 -0800594 // Filter NativeBridge targets unless they are explicitly supported.
595 // Skip creating native bridge variants for non-core modules.
Paul Duffine3d1ae42021-09-03 17:47:17 +0100596 if os == Android && !(base.IsNativeBridgeSupported() && image == CoreVariation) {
Colin Cross83bead42019-12-18 10:45:46 -0800597
Colin Crossa195f912019-10-16 11:07:20 -0700598 var targets []Target
599 for _, t := range osTargets {
600 if !t.NativeBridge {
601 targets = append(targets, t)
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700602 }
603 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700604
Colin Crossa195f912019-10-16 11:07:20 -0700605 osTargets = targets
606 }
Colin Crossee0bc3b2018-10-02 22:01:37 -0700607
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700608 // only the primary arch in the ramdisk / vendor_ramdisk / recovery partition
Inseob Kim08758f02021-04-08 21:13:22 +0900609 if os == Android && (module.InstallInRecovery() || module.InstallInRamdisk() || module.InstallInVendorRamdisk() || module.InstallInDebugRamdisk()) {
Colin Crossa195f912019-10-16 11:07:20 -0700610 osTargets = []Target{osTargets[0]}
611 }
dimitry1f33e402019-03-26 12:39:31 +0100612
Jaewoong Jung003d8082021-02-24 17:39:54 -0800613 // Windows builds always prefer 32-bit
614 prefer32 := os == Windows
dimitry1f33e402019-03-26 12:39:31 +0100615
Colin Crossa6845402020-11-16 15:08:19 -0800616 // Determine the multilib selection for this module.
Christopher Ferris98f10222022-07-13 23:16:52 -0700617 ignorePrefer32OnDevice := mctx.Config().IgnorePrefer32OnDevice()
618 multilib, extraMultilib := decodeMultilib(base, os, ignorePrefer32OnDevice)
Colin Crossa6845402020-11-16 15:08:19 -0800619
620 // Convert the multilib selection into a list of Targets.
Colin Crossa195f912019-10-16 11:07:20 -0700621 targets, err := decodeMultilibTargets(multilib, osTargets, prefer32)
622 if err != nil {
623 mctx.ModuleErrorf("%s", err.Error())
624 }
Colin Cross5eca7cb2018-10-02 14:02:10 -0700625
Colin Crossc0f0eb82022-07-19 14:41:11 -0700626 // If there are no supported targets disable the module.
627 if len(targets) == 0 {
628 base.Disable()
629 return
630 }
631
Colin Crossa6845402020-11-16 15:08:19 -0800632 // If the module is using extraMultilib, decode the extraMultilib selection into
633 // a separate list of Targets.
Colin Crossa195f912019-10-16 11:07:20 -0700634 var multiTargets []Target
635 if extraMultilib != "" {
636 multiTargets, err = decodeMultilibTargets(extraMultilib, osTargets, prefer32)
Colin Crossa1ad8d12016-06-01 17:09:44 -0700637 if err != nil {
638 mctx.ModuleErrorf("%s", err.Error())
639 }
Colin Crossc0f0eb82022-07-19 14:41:11 -0700640 multiTargets = filterHostCross(multiTargets, targets[0].HostCross)
Colin Crossb9db4802016-06-03 01:50:47 +0000641 }
642
Colin Crossa6845402020-11-16 15:08:19 -0800643 // Recovery is always the primary architecture, filter out any other architectures.
Inseob Kim20fb5d42021-02-02 20:07:58 +0900644 // Common arch is also allowed
Colin Crossfb0c16e2019-11-20 17:12:35 -0800645 if image == RecoveryVariation {
646 primaryArch := mctx.Config().DevicePrimaryArchType()
Inseob Kim20fb5d42021-02-02 20:07:58 +0900647 targets = filterToArch(targets, primaryArch, Common)
648 multiTargets = filterToArch(multiTargets, primaryArch, Common)
Colin Crossfb0c16e2019-11-20 17:12:35 -0800649 }
650
Colin Crossa6845402020-11-16 15:08:19 -0800651 // If there are no supported targets disable the module.
Colin Crossa195f912019-10-16 11:07:20 -0700652 if len(targets) == 0 {
Inseob Kimeec88e12020-01-22 11:11:29 +0900653 base.Disable()
Dan Willemsen3f32f032016-07-11 14:36:48 -0700654 return
655 }
656
Colin Crossa6845402020-11-16 15:08:19 -0800657 // Convert the targets into a list of arch variation names.
Colin Crossa195f912019-10-16 11:07:20 -0700658 targetNames := make([]string, len(targets))
Colin Crossa195f912019-10-16 11:07:20 -0700659 for i, target := range targets {
660 targetNames[i] = target.ArchVariation()
Colin Crossa1ad8d12016-06-01 17:09:44 -0700661 }
662
Colin Crossa6845402020-11-16 15:08:19 -0800663 // Create the variations, annotate each one with which Target it was created for, and
664 // squash the appropriate arch-specific properties into the top level properties.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700665 modules := mctx.CreateVariations(targetNames...)
Colin Cross3f40fa42015-01-30 17:27:36 -0800666 for i, m := range modules {
Paul Duffin1356d8c2020-02-25 19:26:33 +0000667 addTargetProperties(m, targets[i], multiTargets, i == 0)
Colin Cross617b88a2020-08-24 18:04:09 -0700668 m.base().setArchProperties(mctx)
Dan Willemsen8528f4e2021-10-19 00:22:06 -0700669
670 // Install support doesn't understand Darwin+Arm64
671 if os == Darwin && targets[i].HostCross {
672 m.base().commonProperties.SkipInstall = true
673 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800674 }
Dan Willemsen47450072021-10-19 20:24:49 -0700675
676 // Create a dependency for Darwin Universal binaries from the primary to secondary
677 // architecture. The module itself will be responsible for calling lipo to merge the outputs.
678 if os == Darwin {
679 if multilib == "darwin_universal" && len(modules) == 2 {
680 mctx.AddInterVariantDependency(DarwinUniversalVariantTag, modules[1], modules[0])
681 } else if multilib == "darwin_universal_common_first" && len(modules) == 3 {
682 mctx.AddInterVariantDependency(DarwinUniversalVariantTag, modules[2], modules[1])
683 }
684 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800685}
686
Colin Crossa6845402020-11-16 15:08:19 -0800687// addTargetProperties annotates a variant with the Target is is being compiled for, the list
688// of additional Targets it is supporting (if any), and whether it is the primary Target for
689// the module.
Paul Duffin1356d8c2020-02-25 19:26:33 +0000690func addTargetProperties(m Module, target Target, multiTargets []Target, primaryTarget bool) {
691 m.base().commonProperties.CompileTarget = target
692 m.base().commonProperties.CompileMultiTargets = multiTargets
693 m.base().commonProperties.CompilePrimary = primaryTarget
694}
695
Colin Crossa6845402020-11-16 15:08:19 -0800696// decodeMultilib returns the appropriate compile_multilib property for the module, or the default
697// multilib from the factory's call to InitAndroidArchModule if none was set. For modules that
698// called InitAndroidMultiTargetsArchModule it always returns "common" for multilib, and returns
699// the actual multilib in extraMultilib.
Christopher Ferris98f10222022-07-13 23:16:52 -0700700func decodeMultilib(base *ModuleBase, os OsType, ignorePrefer32OnDevice bool) (multilib, extraMultilib string) {
Colin Crossa6845402020-11-16 15:08:19 -0800701 // First check the "android.compile_multilib" or "host.compile_multilib" properties.
Dan Willemsen47450072021-10-19 20:24:49 -0700702 switch os.Class {
Colin Crossee0bc3b2018-10-02 22:01:37 -0700703 case Device:
704 multilib = String(base.commonProperties.Target.Android.Compile_multilib)
Jiyong Park1613e552020-09-14 19:43:17 +0900705 case Host:
Colin Crossee0bc3b2018-10-02 22:01:37 -0700706 multilib = String(base.commonProperties.Target.Host.Compile_multilib)
707 }
Colin Crossa6845402020-11-16 15:08:19 -0800708
709 // If those aren't set, try the "compile_multilib" property.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700710 if multilib == "" {
711 multilib = String(base.commonProperties.Compile_multilib)
712 }
Colin Crossa6845402020-11-16 15:08:19 -0800713
714 // If that wasn't set, use the default multilib set by the factory.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700715 if multilib == "" {
716 multilib = base.commonProperties.Default_multilib
717 }
718
Christopher Ferris98f10222022-07-13 23:16:52 -0700719 // If a device is configured with multiple targets, this option
720 // force all device targets that prefer32 to be compiled only as
721 // the first target.
722 if ignorePrefer32OnDevice && os.Class == Device && (multilib == "prefer32" || multilib == "first_prefer32") {
723 multilib = "first"
724 }
725
Colin Crossee0bc3b2018-10-02 22:01:37 -0700726 if base.commonProperties.UseTargetVariants {
Dan Willemsen47450072021-10-19 20:24:49 -0700727 // Darwin has the concept of "universal binaries" which is implemented in Soong by
728 // building both x86_64 and arm64 variants, and having select module types know how to
729 // merge the outputs of their corresponding variants together into a final binary. Most
730 // module types don't need to understand this logic, as we only build a small portion
731 // of the tree for Darwin, and only module types writing macho files need to do the
732 // merging.
733 //
734 // This logic is not enabled for:
735 // "common", as it's not an arch-specific variant
736 // "32", as Darwin never has a 32-bit variant
737 // !UseTargetVariants, as the module has opted into handling the arch-specific logic on
738 // its own.
739 if os == Darwin && multilib != "common" && multilib != "32" {
740 if multilib == "common_first" {
741 multilib = "darwin_universal_common_first"
742 } else {
743 multilib = "darwin_universal"
744 }
745 }
746
Colin Crossee0bc3b2018-10-02 22:01:37 -0700747 return multilib, ""
748 } else {
749 // For app modules a single arch variant will be created per OS class which is expected to handle all the
750 // selected arches. Return the common-type as multilib and any Android.bp provided multilib as extraMultilib
751 if multilib == base.commonProperties.Default_multilib {
752 multilib = "first"
753 }
754 return base.commonProperties.Default_multilib, multilib
755 }
756}
757
Colin Crossa6845402020-11-16 15:08:19 -0800758// filterToArch takes a list of Targets and an ArchType, and returns a modified list that contains
Inseob Kim20fb5d42021-02-02 20:07:58 +0900759// only Targets that have the specified ArchTypes.
760func filterToArch(targets []Target, archs ...ArchType) []Target {
Colin Crossfb0c16e2019-11-20 17:12:35 -0800761 for i := 0; i < len(targets); i++ {
Inseob Kim20fb5d42021-02-02 20:07:58 +0900762 found := false
763 for _, arch := range archs {
764 if targets[i].Arch.ArchType == arch {
765 found = true
766 break
767 }
768 }
769 if !found {
Colin Crossfb0c16e2019-11-20 17:12:35 -0800770 targets = append(targets[:i], targets[i+1:]...)
771 i--
772 }
773 }
774 return targets
775}
776
Colin Crossc0f0eb82022-07-19 14:41:11 -0700777// filterHostCross takes a list of Targets and a hostCross value, and returns a modified list
778// that contains only Targets that have the specified HostCross.
779func filterHostCross(targets []Target, hostCross bool) []Target {
780 for i := 0; i < len(targets); i++ {
781 if targets[i].HostCross != hostCross {
782 targets = append(targets[:i], targets[i+1:]...)
783 i--
784 }
785 }
786 return targets
787}
788
Colin Crossa6845402020-11-16 15:08:19 -0800789// archPropRoot is a struct type used as the top level of the arch-specific properties. It
790// contains the "arch", "multilib", and "target" property structs. It is used to split up the
791// property structs to limit how much is allocated when a single arch-specific property group is
792// used. The types are interface{} because they will hold instances of runtime-created types.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800793type archPropRoot struct {
794 Arch, Multilib, Target interface{}
795}
796
Colin Crossa6845402020-11-16 15:08:19 -0800797// archPropTypeDesc holds the runtime-created types for the property structs to instantiate to
798// create an archPropRoot property struct.
799type archPropTypeDesc struct {
800 arch, multilib, target reflect.Type
801}
802
Colin Crosscbbd13f2020-01-17 14:08:22 -0800803// createArchPropTypeDesc takes a reflect.Type that is either a struct or a pointer to a struct, and
804// returns lists of reflect.Types that contains the arch-variant properties inside structs for each
805// arch, multilib and target property.
Colin Crossa6845402020-11-16 15:08:19 -0800806//
807// This is a relatively expensive operation, so the results are cached in the global
808// archPropTypeMap. It is constructed entirely based on compile-time data, so there is no need
809// to isolate the results between multiple tests running in parallel.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800810func createArchPropTypeDesc(props reflect.Type) []archPropTypeDesc {
Colin Crossb1d8c992020-01-21 11:43:29 -0800811 // Each property struct shard will be nested many times under the runtime generated arch struct,
812 // which can hit the limit of 64kB for the name of runtime generated structs. They are nested
813 // 97 times now, which may grow in the future, plus there is some overhead for the containing
814 // type. This number may need to be reduced if too many are added, but reducing it too far
815 // could cause problems if a single deeply nested property no longer fits in the name.
816 const maxArchTypeNameSize = 500
817
Colin Crossa6845402020-11-16 15:08:19 -0800818 // Convert the type to a new set of types that contains only the arch-specific properties
Usta Shrestha0b52d832022-02-04 21:37:39 -0500819 // (those that are tagged with `android:"arch_variant"`), and sharded into multiple types
Colin Crossa6845402020-11-16 15:08:19 -0800820 // to keep the runtime-generated names under the limit.
Colin Crossb1d8c992020-01-21 11:43:29 -0800821 propShards, _ := proptools.FilterPropertyStructSharded(props, maxArchTypeNameSize, filterArchStruct)
Colin Crossa6845402020-11-16 15:08:19 -0800822
823 // If the type has no arch-specific properties there is nothing to do.
Colin Crosscb988072019-01-24 14:58:11 -0800824 if len(propShards) == 0 {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700825 return nil
826 }
827
Colin Crosscbbd13f2020-01-17 14:08:22 -0800828 var ret []archPropTypeDesc
Colin Crossc17727d2018-10-24 12:42:09 -0700829 for _, props := range propShards {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700830
Colin Crossa6845402020-11-16 15:08:19 -0800831 // variantFields takes a list of variant property field names and returns a list the
832 // StructFields with the names and the type of the current shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700833 variantFields := func(names []string) []reflect.StructField {
834 ret := make([]reflect.StructField, len(names))
Dan Willemsenb1957a52016-06-23 23:44:54 -0700835
Colin Crossc17727d2018-10-24 12:42:09 -0700836 for i, name := range names {
837 ret[i].Name = name
838 ret[i].Type = props
Dan Willemsen866b5632017-09-22 12:28:24 -0700839 }
Colin Crossc17727d2018-10-24 12:42:09 -0700840
841 return ret
842 }
843
Colin Crossa6845402020-11-16 15:08:19 -0800844 // Create a type that contains the properties in this shard repeated for each
845 // architecture, architecture variant, and architecture feature.
Colin Crossc17727d2018-10-24 12:42:09 -0700846 archFields := make([]reflect.StructField, len(archTypeList))
847 for i, arch := range archTypeList {
Colin Crossa6845402020-11-16 15:08:19 -0800848 var variants []string
Colin Crossc17727d2018-10-24 12:42:09 -0700849
850 for _, archVariant := range archVariants[arch] {
851 archVariant := variantReplacer.Replace(archVariant)
852 variants = append(variants, proptools.FieldNameForProperty(archVariant))
853 }
Liz Kammer2c2afe22022-02-11 11:35:03 -0500854 for _, cpuVariant := range cpuVariants[arch] {
855 cpuVariant := variantReplacer.Replace(cpuVariant)
856 variants = append(variants, proptools.FieldNameForProperty(cpuVariant))
857 }
Colin Crossc17727d2018-10-24 12:42:09 -0700858 for _, feature := range archFeatures[arch] {
859 feature := variantReplacer.Replace(feature)
860 variants = append(variants, proptools.FieldNameForProperty(feature))
861 }
862
Colin Crossa6845402020-11-16 15:08:19 -0800863 // Create the StructFields for each architecture variant architecture feature
864 // (e.g. "arch.arm.cortex-a53" or "arch.arm.neon").
Colin Crossc17727d2018-10-24 12:42:09 -0700865 fields := variantFields(variants)
866
Colin Crossa6845402020-11-16 15:08:19 -0800867 // Create the StructField for the architecture itself (e.g. "arch.arm"). The special
868 // "BlueprintEmbed" name is used by Blueprint to put the properties in the
869 // parent struct.
Colin Crossc17727d2018-10-24 12:42:09 -0700870 fields = append([]reflect.StructField{{
871 Name: "BlueprintEmbed",
872 Type: props,
873 Anonymous: true,
874 }}, fields...)
875
876 archFields[i] = reflect.StructField{
877 Name: arch.Field,
878 Type: reflect.StructOf(fields),
879 }
880 }
Colin Crossa6845402020-11-16 15:08:19 -0800881
882 // Create the type of the "arch" property struct for this shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700883 archType := reflect.StructOf(archFields)
884
Colin Crossa6845402020-11-16 15:08:19 -0800885 // Create the type for the "multilib" property struct for this shard, containing the
886 // "multilib.lib32" and "multilib.lib64" property structs.
Colin Crossc17727d2018-10-24 12:42:09 -0700887 multilibType := reflect.StructOf(variantFields([]string{"Lib32", "Lib64"}))
888
Colin Crossa6845402020-11-16 15:08:19 -0800889 // Start with a list of the special targets
Colin Crossc17727d2018-10-24 12:42:09 -0700890 targets := []string{
891 "Host",
892 "Android64",
893 "Android32",
894 "Bionic",
Colin Cross528d67e2021-07-23 22:23:07 +0000895 "Glibc",
896 "Musl",
Colin Crossc17727d2018-10-24 12:42:09 -0700897 "Linux",
Colin Crossa98d36d2022-03-07 14:39:49 -0800898 "Host_linux",
Colin Crossc17727d2018-10-24 12:42:09 -0700899 "Not_windows",
900 "Arm_on_x86",
901 "Arm_on_x86_64",
Victor Khimenkoc26fcf42020-05-07 22:16:33 +0200902 "Native_bridge",
Colin Crossc17727d2018-10-24 12:42:09 -0700903 }
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000904 for _, os := range osTypeList {
Colin Crossa6845402020-11-16 15:08:19 -0800905 // Add all the OSes.
Colin Crossc17727d2018-10-24 12:42:09 -0700906 targets = append(targets, os.Field)
907
Colin Crossa6845402020-11-16 15:08:19 -0800908 // Add the OS/Arch combinations, e.g. "android_arm64".
Colin Crossc17727d2018-10-24 12:42:09 -0700909 for _, archType := range osArchTypeMap[os] {
Liz Kammer9abd62d2021-05-21 08:37:59 -0400910 targets = append(targets, GetCompoundTargetField(os, archType))
Colin Crossc17727d2018-10-24 12:42:09 -0700911
Colin Cross1aa45b02022-02-10 10:33:10 -0800912 // Also add the special "linux_<arch>", "bionic_<arch>" , "glibc_<arch>", and
913 // "musl_<arch>" property structs.
Colin Crossc17727d2018-10-24 12:42:09 -0700914 if os.Linux() {
915 target := "Linux_" + archType.Name
916 if !InList(target, targets) {
917 targets = append(targets, target)
918 }
919 }
Colin Crossa98d36d2022-03-07 14:39:49 -0800920 if os.Linux() && os.Class == Host {
921 target := "Host_linux_" + archType.Name
922 if !InList(target, targets) {
923 targets = append(targets, target)
924 }
925 }
Colin Crossc17727d2018-10-24 12:42:09 -0700926 if os.Bionic() {
927 target := "Bionic_" + archType.Name
928 if !InList(target, targets) {
929 targets = append(targets, target)
930 }
Dan Willemsen866b5632017-09-22 12:28:24 -0700931 }
Colin Cross1aa45b02022-02-10 10:33:10 -0800932 if os == Linux {
933 target := "Glibc_" + archType.Name
934 if !InList(target, targets) {
935 targets = append(targets, target)
936 }
937 }
938 if os == LinuxMusl {
939 target := "Musl_" + archType.Name
940 if !InList(target, targets) {
941 targets = append(targets, target)
942 }
943 }
Dan Willemsen866b5632017-09-22 12:28:24 -0700944 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700945 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700946
Colin Crossa6845402020-11-16 15:08:19 -0800947 // Create the type for the "target" property struct for this shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700948 targetType := reflect.StructOf(variantFields(targets))
Colin Crosscbbd13f2020-01-17 14:08:22 -0800949
Colin Crossa6845402020-11-16 15:08:19 -0800950 // Return a descriptor of the 3 runtime-created types.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800951 ret = append(ret, archPropTypeDesc{
952 arch: reflect.PtrTo(archType),
953 multilib: reflect.PtrTo(multilibType),
954 target: reflect.PtrTo(targetType),
955 })
Colin Crossc17727d2018-10-24 12:42:09 -0700956 }
957 return ret
Dan Willemsenb1957a52016-06-23 23:44:54 -0700958}
959
Colin Crossa6845402020-11-16 15:08:19 -0800960// variantReplacer converts architecture variant or architecture feature names into names that
961// are valid for an Android.bp file.
962var variantReplacer = strings.NewReplacer("-", "_", ".", "_")
963
964// filterArchStruct returns true if the given field is an architecture specific property.
Colin Cross74449102019-09-25 11:26:40 -0700965func filterArchStruct(field reflect.StructField, prefix string) (bool, reflect.StructField) {
966 if proptools.HasTag(field, "android", "arch_variant") {
967 // The arch_variant field isn't necessary past this point
968 // Instead of wasting space, just remove it. Go also has a
969 // 16-bit limit on structure name length. The name is constructed
970 // based on the Go source representation of the structure, so
971 // the tag names count towards that length.
Colin Crossb4fecbf2020-01-21 11:38:47 -0800972
973 androidTag := field.Tag.Get("android")
974 values := strings.Split(androidTag, ",")
975
976 if string(field.Tag) != `android:"`+strings.Join(values, ",")+`"` {
977 panic(fmt.Errorf("unexpected tag format %q", field.Tag))
Colin Cross74449102019-09-25 11:26:40 -0700978 }
Colin Crossb4fecbf2020-01-21 11:38:47 -0800979 // these tags don't need to be present in the runtime generated struct type.
Liz Kammerff966b12022-07-29 10:49:16 -0400980 values = RemoveListFromList(values, []string{"arch_variant", "variant_prepend", "path"})
981 if len(values) > 0 {
Colin Crossb4fecbf2020-01-21 11:38:47 -0800982 panic(fmt.Errorf("unknown tags %q in field %q", values, prefix+field.Name))
983 }
984
Liz Kammerff966b12022-07-29 10:49:16 -0400985 field.Tag = ``
Colin Cross74449102019-09-25 11:26:40 -0700986 return true, field
987 }
988 return false, field
989}
990
Colin Crossa6845402020-11-16 15:08:19 -0800991// archPropTypeMap contains a cache of the results of createArchPropTypeDesc for each type. It is
992// shared across all Contexts, but is constructed based only on compile-time information so there
993// is no risk of contaminating one Context with data from another.
Dan Willemsenb1957a52016-06-23 23:44:54 -0700994var archPropTypeMap OncePer
995
Colin Crossa6845402020-11-16 15:08:19 -0800996// initArchModule adds the architecture-specific property structs to a Module.
997func initArchModule(m Module) {
Colin Cross3f40fa42015-01-30 17:27:36 -0800998
999 base := m.base()
1000
Ustaeabf0f32021-12-06 15:17:23 -05001001 if len(base.archProperties) != 0 {
1002 panic(fmt.Errorf("module %s already has archProperties", m.Name()))
1003 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001004
Ustaeabf0f32021-12-06 15:17:23 -05001005 getStructType := func(properties interface{}) reflect.Type {
Colin Cross3f40fa42015-01-30 17:27:36 -08001006 propertiesValue := reflect.ValueOf(properties)
Colin Cross62496a02016-08-08 15:49:17 -07001007 t := propertiesValue.Type()
Colin Cross3f40fa42015-01-30 17:27:36 -08001008 if propertiesValue.Kind() != reflect.Ptr {
Colin Crossca860ac2016-01-04 14:34:37 -08001009 panic(fmt.Errorf("properties must be a pointer to a struct, got %T",
1010 propertiesValue.Interface()))
Colin Cross3f40fa42015-01-30 17:27:36 -08001011 }
1012
1013 propertiesValue = propertiesValue.Elem()
1014 if propertiesValue.Kind() != reflect.Struct {
Ustaeabf0f32021-12-06 15:17:23 -05001015 panic(fmt.Errorf("properties must be a pointer to a struct, got a pointer to %T",
Colin Crossca860ac2016-01-04 14:34:37 -08001016 propertiesValue.Interface()))
Colin Cross3f40fa42015-01-30 17:27:36 -08001017 }
Ustaeabf0f32021-12-06 15:17:23 -05001018 return t
1019 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001020
Usta851a3272022-01-05 23:42:33 -05001021 for _, properties := range m.GetProperties() {
Ustaeabf0f32021-12-06 15:17:23 -05001022 t := getStructType(properties)
Colin Crossa6845402020-11-16 15:08:19 -08001023 // Get or create the arch-specific property struct types for this property struct type.
Colin Cross571cccf2019-02-04 11:22:08 -08001024 archPropTypes := archPropTypeMap.Once(NewCustomOnceKey(t), func() interface{} {
Colin Crosscbbd13f2020-01-17 14:08:22 -08001025 return createArchPropTypeDesc(t)
1026 }).([]archPropTypeDesc)
Colin Cross3f40fa42015-01-30 17:27:36 -08001027
Colin Crossa6845402020-11-16 15:08:19 -08001028 // Instantiate one of each arch-specific property struct type and add it to the
1029 // properties for the Module.
Colin Crossc17727d2018-10-24 12:42:09 -07001030 var archProperties []interface{}
1031 for _, t := range archPropTypes {
Colin Crosscbbd13f2020-01-17 14:08:22 -08001032 archProperties = append(archProperties, &archPropRoot{
1033 Arch: reflect.Zero(t.arch).Interface(),
1034 Multilib: reflect.Zero(t.multilib).Interface(),
1035 Target: reflect.Zero(t.target).Interface(),
1036 })
Dan Willemsenb1957a52016-06-23 23:44:54 -07001037 }
Colin Crossc17727d2018-10-24 12:42:09 -07001038 base.archProperties = append(base.archProperties, archProperties)
1039 m.AddProperties(archProperties...)
Colin Cross3f40fa42015-01-30 17:27:36 -08001040 }
1041
Colin Cross3f40fa42015-01-30 17:27:36 -08001042}
1043
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001044func maybeBlueprintEmbed(src reflect.Value) reflect.Value {
Colin Crossa6845402020-11-16 15:08:19 -08001045 // If the value of the field is a struct (as opposed to a pointer to a struct) then step
1046 // into the BlueprintEmbed field.
Dan Willemsenb1957a52016-06-23 23:44:54 -07001047 if src.Kind() == reflect.Struct {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001048 return src.FieldByName("BlueprintEmbed")
1049 } else {
1050 return src
Colin Cross06a931b2015-10-28 17:23:31 -07001051 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001052}
1053
1054// Merges the property struct in srcValue into dst.
Liz Kammerb6dbc872021-05-14 15:14:40 -04001055func mergePropertyStruct(ctx ArchVariantContext, dst interface{}, srcValue reflect.Value) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001056 src := maybeBlueprintEmbed(srcValue).Interface()
Colin Cross06a931b2015-10-28 17:23:31 -07001057
Colin Crossa6845402020-11-16 15:08:19 -08001058 // order checks the `android:"variant_prepend"` tag to handle properties where the
1059 // arch-specific value needs to come before the generic value, for example for lists of
1060 // include directories.
Colin Cross6ee75b62016-05-05 15:57:15 -07001061 order := func(property string,
1062 dstField, srcField reflect.StructField,
1063 dstValue, srcValue interface{}) (proptools.Order, error) {
1064 if proptools.HasTag(dstField, "android", "variant_prepend") {
1065 return proptools.Prepend, nil
1066 } else {
1067 return proptools.Append, nil
1068 }
1069 }
1070
Colin Crossa6845402020-11-16 15:08:19 -08001071 // Squash the located property struct into the destination property struct.
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001072 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src, nil, order)
Colin Cross06a931b2015-10-28 17:23:31 -07001073 if err != nil {
1074 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1075 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1076 } else {
1077 panic(err)
1078 }
1079 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001080}
Colin Cross85a88972015-11-23 13:29:51 -08001081
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001082// Returns the immediate child of the input property struct that corresponds to
1083// the sub-property "field".
Liz Kammerb6dbc872021-05-14 15:14:40 -04001084func getChildPropertyStruct(ctx ArchVariantContext,
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001085 src reflect.Value, field, userFriendlyField string) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001086
1087 // Step into non-nil pointers to structs in the src value.
1088 if src.Kind() == reflect.Ptr {
1089 if src.IsNil() {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001090 return reflect.Value{}, false
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001091 }
1092 src = src.Elem()
1093 }
1094
1095 // Find the requested field in the src struct.
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001096 child := src.FieldByName(proptools.FieldNameForProperty(field))
1097 if !child.IsValid() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001098 ctx.ModuleErrorf("field %q does not exist", userFriendlyField)
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001099 return reflect.Value{}, false
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001100 }
1101
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001102 if child.IsZero() {
1103 return reflect.Value{}, false
1104 }
1105
1106 return child, true
Colin Cross06a931b2015-10-28 17:23:31 -07001107}
1108
Colin Crossa6845402020-11-16 15:08:19 -08001109// Squash the appropriate OS-specific property structs into the matching top level property structs
1110// based on the CompileOS value that was annotated on the variant.
Colin Crossa195f912019-10-16 11:07:20 -07001111func (m *ModuleBase) setOSProperties(ctx BottomUpMutatorContext) {
1112 os := m.commonProperties.CompileOS
1113
Ustadca02192021-12-20 12:56:46 -05001114 for i := range m.archProperties {
Usta851a3272022-01-05 23:42:33 -05001115 genProps := m.GetProperties()[i]
Colin Crossa195f912019-10-16 11:07:20 -07001116 if m.archProperties[i] == nil {
1117 continue
1118 }
1119 for _, archProperties := range m.archProperties[i] {
1120 archPropValues := reflect.ValueOf(archProperties).Elem()
1121
Colin Crosscbbd13f2020-01-17 14:08:22 -08001122 targetProp := archPropValues.FieldByName("Target").Elem()
Colin Crossa195f912019-10-16 11:07:20 -07001123
1124 // Handle host-specific properties in the form:
1125 // target: {
1126 // host: {
1127 // key: value,
1128 // },
1129 // },
Jiyong Park1613e552020-09-14 19:43:17 +09001130 if os.Class == Host {
Colin Crossa195f912019-10-16 11:07:20 -07001131 field := "Host"
1132 prefix := "target.host"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001133 if hostProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1134 mergePropertyStruct(ctx, genProps, hostProperties)
1135 }
Colin Crossa195f912019-10-16 11:07:20 -07001136 }
1137
1138 // Handle target OS generalities of the form:
1139 // target: {
1140 // bionic: {
1141 // key: value,
1142 // },
1143 // }
1144 if os.Linux() {
1145 field := "Linux"
1146 prefix := "target.linux"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001147 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1148 mergePropertyStruct(ctx, genProps, linuxProperties)
1149 }
Colin Crossa195f912019-10-16 11:07:20 -07001150 }
1151
Colin Crossa98d36d2022-03-07 14:39:49 -08001152 if os.Linux() && os.Class == Host {
1153 field := "Host_linux"
1154 prefix := "target.host_linux"
1155 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1156 mergePropertyStruct(ctx, genProps, linuxProperties)
1157 }
1158 }
1159
Colin Crossa195f912019-10-16 11:07:20 -07001160 if os.Bionic() {
1161 field := "Bionic"
1162 prefix := "target.bionic"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001163 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1164 mergePropertyStruct(ctx, genProps, bionicProperties)
1165 }
Colin Crossa195f912019-10-16 11:07:20 -07001166 }
1167
Colin Cross528d67e2021-07-23 22:23:07 +00001168 if os == Linux {
1169 field := "Glibc"
1170 prefix := "target.glibc"
1171 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1172 mergePropertyStruct(ctx, genProps, bionicProperties)
1173 }
1174 }
1175
1176 if os == LinuxMusl {
1177 field := "Musl"
1178 prefix := "target.musl"
1179 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1180 mergePropertyStruct(ctx, genProps, bionicProperties)
1181 }
Colin Cross528d67e2021-07-23 22:23:07 +00001182 }
1183
Colin Crossa195f912019-10-16 11:07:20 -07001184 // Handle target OS properties in the form:
1185 // target: {
1186 // linux_glibc: {
1187 // key: value,
1188 // },
1189 // not_windows: {
1190 // key: value,
1191 // },
1192 // android {
1193 // key: value,
1194 // },
1195 // },
1196 field := os.Field
1197 prefix := "target." + os.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001198 if osProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1199 mergePropertyStruct(ctx, genProps, osProperties)
1200 }
Colin Crossa195f912019-10-16 11:07:20 -07001201
Jiyong Park1613e552020-09-14 19:43:17 +09001202 if os.Class == Host && os != Windows {
Colin Crossa195f912019-10-16 11:07:20 -07001203 field := "Not_windows"
1204 prefix := "target.not_windows"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001205 if notWindowsProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1206 mergePropertyStruct(ctx, genProps, notWindowsProperties)
1207 }
Colin Crossa195f912019-10-16 11:07:20 -07001208 }
1209
1210 // Handle 64-bit device properties in the form:
1211 // target {
1212 // android64 {
1213 // key: value,
1214 // },
1215 // android32 {
1216 // key: value,
1217 // },
1218 // },
1219 // WARNING: this is probably not what you want to use in your blueprints file, it selects
1220 // options for all targets on a device that supports 64-bit binaries, not just the targets
1221 // that are being compiled for 64-bit. Its expected use case is binaries like linker and
1222 // debuggerd that need to know when they are a 32-bit process running on a 64-bit device
1223 if os.Class == Device {
1224 if ctx.Config().Android64() {
1225 field := "Android64"
1226 prefix := "target.android64"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001227 if android64Properties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1228 mergePropertyStruct(ctx, genProps, android64Properties)
1229 }
Colin Crossa195f912019-10-16 11:07:20 -07001230 } else {
1231 field := "Android32"
1232 prefix := "target.android32"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001233 if android32Properties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1234 mergePropertyStruct(ctx, genProps, android32Properties)
1235 }
Colin Crossa195f912019-10-16 11:07:20 -07001236 }
1237 }
1238 }
1239 }
1240}
1241
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001242// Returns the struct containing the properties specific to the given
1243// architecture type. These look like this in Blueprint files:
Colin Crossd079e0b2022-08-16 10:27:33 -07001244//
1245// arch: {
1246// arm64: {
1247// key: value,
1248// },
1249// },
1250//
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001251// This struct will also contain sub-structs containing to the architecture/CPU
1252// variants and features that themselves contain properties specific to those.
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001253func getArchTypeStruct(ctx ArchVariantContext, archProperties interface{}, archType ArchType) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001254 archPropValues := reflect.ValueOf(archProperties).Elem()
1255 archProp := archPropValues.FieldByName("Arch").Elem()
1256 prefix := "arch." + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001257 return getChildPropertyStruct(ctx, archProp, archType.Name, prefix)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001258}
1259
1260// Returns the struct containing the properties specific to a given multilib
1261// value. These look like this in the Blueprint file:
Colin Crossd079e0b2022-08-16 10:27:33 -07001262//
1263// multilib: {
1264// lib32: {
1265// key: value,
1266// },
1267// },
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001268func getMultilibStruct(ctx ArchVariantContext, archProperties interface{}, archType ArchType) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001269 archPropValues := reflect.ValueOf(archProperties).Elem()
1270 multilibProp := archPropValues.FieldByName("Multilib").Elem()
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001271 return getChildPropertyStruct(ctx, multilibProp, archType.Multilib, "multilib."+archType.Multilib)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001272}
1273
Liz Kammer9abd62d2021-05-21 08:37:59 -04001274func GetCompoundTargetField(os OsType, arch ArchType) string {
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04001275 return os.Field + "_" + arch.Name
1276}
1277
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001278// Returns the structs corresponding to the properties specific to the given
1279// architecture and OS in archProperties.
1280func getArchProperties(ctx BaseMutatorContext, archProperties interface{}, arch Arch, os OsType, nativeBridgeEnabled bool) []reflect.Value {
1281 result := make([]reflect.Value, 0)
1282 archPropValues := reflect.ValueOf(archProperties).Elem()
1283
1284 targetProp := archPropValues.FieldByName("Target").Elem()
1285
1286 archType := arch.ArchType
1287
1288 if arch.ArchType != Common {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001289 archStruct, ok := getArchTypeStruct(ctx, archProperties, arch.ArchType)
1290 if ok {
1291 result = append(result, archStruct)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001292
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001293 // Handle arch-variant-specific properties in the form:
1294 // arch: {
1295 // arm: {
1296 // variant: {
1297 // key: value,
1298 // },
1299 // },
1300 // },
1301 v := variantReplacer.Replace(arch.ArchVariant)
1302 if v != "" {
1303 prefix := "arch." + archType.Name + "." + v
1304 if variantProperties, ok := getChildPropertyStruct(ctx, archStruct, v, prefix); ok {
1305 result = append(result, variantProperties)
1306 }
1307 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001308
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001309 // Handle cpu-variant-specific properties in the form:
1310 // arch: {
1311 // arm: {
1312 // variant: {
1313 // key: value,
1314 // },
1315 // },
1316 // },
1317 if arch.CpuVariant != arch.ArchVariant {
1318 c := variantReplacer.Replace(arch.CpuVariant)
1319 if c != "" {
1320 prefix := "arch." + archType.Name + "." + c
1321 if cpuVariantProperties, ok := getChildPropertyStruct(ctx, archStruct, c, prefix); ok {
1322 result = append(result, cpuVariantProperties)
1323 }
1324 }
1325 }
1326
1327 // Handle arch-feature-specific properties in the form:
1328 // arch: {
1329 // arm: {
1330 // feature: {
1331 // key: value,
1332 // },
1333 // },
1334 // },
1335 for _, feature := range arch.ArchFeatures {
1336 prefix := "arch." + archType.Name + "." + feature
1337 if featureProperties, ok := getChildPropertyStruct(ctx, archStruct, feature, prefix); ok {
1338 result = append(result, featureProperties)
1339 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001340 }
1341 }
1342
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001343 if multilibProperties, ok := getMultilibStruct(ctx, archProperties, archType); ok {
1344 result = append(result, multilibProperties)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001345 }
1346
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001347 // Handle combined OS-feature and arch specific properties in the form:
1348 // target: {
1349 // bionic_x86: {
1350 // key: value,
1351 // },
1352 // }
1353 if os.Linux() {
1354 field := "Linux_" + arch.ArchType.Name
1355 userFriendlyField := "target.linux_" + arch.ArchType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001356 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1357 result = append(result, linuxProperties)
1358 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001359 }
1360
1361 if os.Bionic() {
1362 field := "Bionic_" + archType.Name
1363 userFriendlyField := "target.bionic_" + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001364 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1365 result = append(result, bionicProperties)
1366 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001367 }
1368
1369 // Handle combined OS and arch specific properties in the form:
1370 // target: {
1371 // linux_glibc_x86: {
1372 // key: value,
1373 // },
1374 // linux_glibc_arm: {
1375 // key: value,
1376 // },
1377 // android_arm {
1378 // key: value,
1379 // },
1380 // android_x86 {
1381 // key: value,
1382 // },
1383 // },
Liz Kammer9abd62d2021-05-21 08:37:59 -04001384 field := GetCompoundTargetField(os, archType)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001385 userFriendlyField := "target." + os.Name + "_" + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001386 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1387 result = append(result, osArchProperties)
1388 }
Colin Cross528d67e2021-07-23 22:23:07 +00001389
Colin Cross1aa45b02022-02-10 10:33:10 -08001390 if os == Linux {
1391 field := "Glibc_" + archType.Name
1392 userFriendlyField := "target.glibc_" + "_" + archType.Name
1393 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1394 result = append(result, osArchProperties)
1395 }
1396 }
1397
Colin Cross528d67e2021-07-23 22:23:07 +00001398 if os == LinuxMusl {
Colin Cross1aa45b02022-02-10 10:33:10 -08001399 field := "Musl_" + archType.Name
1400 userFriendlyField := "target.musl_" + "_" + archType.Name
1401 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1402 result = append(result, osArchProperties)
1403 }
Colin Cross528d67e2021-07-23 22:23:07 +00001404 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001405 }
1406
1407 // Handle arm on x86 properties in the form:
1408 // target {
1409 // arm_on_x86 {
1410 // key: value,
1411 // },
1412 // arm_on_x86_64 {
1413 // key: value,
1414 // },
1415 // },
1416 if os.Class == Device {
1417 if arch.ArchType == X86 && (hasArmAbi(arch) ||
1418 hasArmAndroidArch(ctx.Config().Targets[Android])) {
1419 field := "Arm_on_x86"
1420 userFriendlyField := "target.arm_on_x86"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001421 if armOnX86Properties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1422 result = append(result, armOnX86Properties)
1423 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001424 }
1425 if arch.ArchType == X86_64 && (hasArmAbi(arch) ||
1426 hasArmAndroidArch(ctx.Config().Targets[Android])) {
1427 field := "Arm_on_x86_64"
1428 userFriendlyField := "target.arm_on_x86_64"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001429 if armOnX8664Properties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1430 result = append(result, armOnX8664Properties)
1431 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001432 }
1433 if os == Android && nativeBridgeEnabled {
1434 userFriendlyField := "Native_bridge"
1435 prefix := "target.native_bridge"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001436 if nativeBridgeProperties, ok := getChildPropertyStruct(ctx, targetProp, userFriendlyField, prefix); ok {
1437 result = append(result, nativeBridgeProperties)
1438 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001439 }
1440 }
1441
1442 return result
1443}
1444
Colin Crossa6845402020-11-16 15:08:19 -08001445// Squash the appropriate arch-specific property structs into the matching top level property
1446// structs based on the CompileTarget value that was annotated on the variant.
Colin Cross4157e882019-06-06 16:57:04 -07001447func (m *ModuleBase) setArchProperties(ctx BottomUpMutatorContext) {
1448 arch := m.Arch()
1449 os := m.Os()
Colin Crossd3ba0392015-05-07 14:11:29 -07001450
Ustadca02192021-12-20 12:56:46 -05001451 for i := range m.archProperties {
Usta851a3272022-01-05 23:42:33 -05001452 genProps := m.GetProperties()[i]
Colin Cross4157e882019-06-06 16:57:04 -07001453 if m.archProperties[i] == nil {
Dan Willemsenb1957a52016-06-23 23:44:54 -07001454 continue
1455 }
Dan Willemsenb1957a52016-06-23 23:44:54 -07001456
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001457 propStructs := make([]reflect.Value, 0)
1458 for _, archProperty := range m.archProperties[i] {
1459 propStructShard := getArchProperties(ctx, archProperty, arch, os, m.Target().NativeBridge == NativeBridgeEnabled)
1460 propStructs = append(propStructs, propStructShard...)
1461 }
Dan Willemsenb1957a52016-06-23 23:44:54 -07001462
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001463 for _, propStruct := range propStructs {
1464 mergePropertyStruct(ctx, genProps, propStruct)
Colin Crossbb2e2b72016-12-08 17:23:53 -08001465 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001466 }
1467}
1468
Colin Cross0c66bc62021-07-20 09:47:41 -07001469// determineBuildOS stores the OS and architecture used for host targets used during the build into
Colin Cross528d67e2021-07-23 22:23:07 +00001470// config based on the runtime OS and architecture determined by Go and the product configuration.
Colin Cross0c66bc62021-07-20 09:47:41 -07001471func determineBuildOS(config *config) {
1472 config.BuildOS = func() OsType {
1473 switch runtime.GOOS {
1474 case "linux":
Colin Cross528d67e2021-07-23 22:23:07 +00001475 if Bool(config.productVariables.HostMusl) {
1476 return LinuxMusl
1477 }
Colin Cross0c66bc62021-07-20 09:47:41 -07001478 return Linux
1479 case "darwin":
1480 return Darwin
1481 default:
1482 panic(fmt.Sprintf("unsupported OS: %s", runtime.GOOS))
1483 }
1484 }()
1485
1486 config.BuildArch = func() ArchType {
1487 switch runtime.GOARCH {
1488 case "amd64":
1489 return X86_64
1490 default:
1491 panic(fmt.Sprintf("unsupported Arch: %s", runtime.GOARCH))
1492 }
1493 }()
1494
1495}
1496
Colin Crossa6845402020-11-16 15:08:19 -08001497// Convert the arch product variables into a list of targets for each OsType.
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001498func decodeTargetProductVariables(config *config) (map[OsType][]Target, error) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001499 variables := config.productVariables
Dan Willemsen490fd492015-11-24 17:53:15 -08001500
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001501 targets := make(map[OsType][]Target)
Colin Crossa1ad8d12016-06-01 17:09:44 -07001502 var targetErr error
1503
Liz Kammerb7f33662022-02-28 14:16:16 -05001504 type targetConfig struct {
1505 os OsType
1506 archName string
1507 archVariant *string
1508 cpuVariant *string
1509 abi []string
1510 nativeBridgeEnabled NativeBridgeSupport
1511 nativeBridgeHostArchName *string
1512 nativeBridgeRelativePath *string
1513 }
1514
1515 addTarget := func(target targetConfig) {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001516 if targetErr != nil {
1517 return
Dan Willemsen490fd492015-11-24 17:53:15 -08001518 }
Colin Crossa1ad8d12016-06-01 17:09:44 -07001519
Liz Kammerb7f33662022-02-28 14:16:16 -05001520 arch, err := decodeArch(target.os, target.archName, target.archVariant, target.cpuVariant, target.abi)
Colin Crossa1ad8d12016-06-01 17:09:44 -07001521 if err != nil {
1522 targetErr = err
1523 return
1524 }
Liz Kammerb7f33662022-02-28 14:16:16 -05001525 nativeBridgeRelativePathStr := String(target.nativeBridgeRelativePath)
1526 nativeBridgeHostArchNameStr := String(target.nativeBridgeHostArchName)
dimitry8d6dde82019-07-11 10:23:53 +02001527
1528 // Use guest arch as relative install path by default
Liz Kammerb7f33662022-02-28 14:16:16 -05001529 if target.nativeBridgeEnabled && nativeBridgeRelativePathStr == "" {
dimitry8d6dde82019-07-11 10:23:53 +02001530 nativeBridgeRelativePathStr = arch.ArchType.String()
1531 }
Colin Crossa1ad8d12016-06-01 17:09:44 -07001532
Jiyong Park1613e552020-09-14 19:43:17 +09001533 // A target is considered as HostCross if it's a host target which can't run natively on
1534 // the currently configured build machine (either because the OS is different or because of
1535 // the unsupported arch)
1536 hostCross := false
Liz Kammerb7f33662022-02-28 14:16:16 -05001537 if target.os.Class == Host {
Jiyong Park1613e552020-09-14 19:43:17 +09001538 var osSupported bool
Liz Kammerb7f33662022-02-28 14:16:16 -05001539 if target.os == config.BuildOS {
Jiyong Park1613e552020-09-14 19:43:17 +09001540 osSupported = true
Liz Kammerb7f33662022-02-28 14:16:16 -05001541 } else if config.BuildOS.Linux() && target.os.Linux() {
Jiyong Park1613e552020-09-14 19:43:17 +09001542 // LinuxBionic and Linux are compatible
1543 osSupported = true
1544 } else {
1545 osSupported = false
1546 }
1547
1548 var archSupported bool
1549 if arch.ArchType == Common {
1550 archSupported = true
1551 } else if arch.ArchType.Name == *variables.HostArch {
1552 archSupported = true
1553 } else if variables.HostSecondaryArch != nil && arch.ArchType.Name == *variables.HostSecondaryArch {
1554 archSupported = true
1555 } else {
1556 archSupported = false
1557 }
1558 if !osSupported || !archSupported {
1559 hostCross = true
1560 }
1561 }
1562
Liz Kammerb7f33662022-02-28 14:16:16 -05001563 targets[target.os] = append(targets[target.os],
Colin Crossa1ad8d12016-06-01 17:09:44 -07001564 Target{
Liz Kammerb7f33662022-02-28 14:16:16 -05001565 Os: target.os,
dimitry8d6dde82019-07-11 10:23:53 +02001566 Arch: arch,
Liz Kammerb7f33662022-02-28 14:16:16 -05001567 NativeBridge: target.nativeBridgeEnabled,
dimitry8d6dde82019-07-11 10:23:53 +02001568 NativeBridgeHostArchName: nativeBridgeHostArchNameStr,
1569 NativeBridgeRelativePath: nativeBridgeRelativePathStr,
Jiyong Park1613e552020-09-14 19:43:17 +09001570 HostCross: hostCross,
Colin Crossa1ad8d12016-06-01 17:09:44 -07001571 })
Dan Willemsen490fd492015-11-24 17:53:15 -08001572 }
1573
Colin Cross4225f652015-09-17 14:33:42 -07001574 if variables.HostArch == nil {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001575 return nil, fmt.Errorf("No host primary architecture set")
Colin Cross4225f652015-09-17 14:33:42 -07001576 }
1577
Colin Crossa6845402020-11-16 15:08:19 -08001578 // The primary host target, which must always exist.
Liz Kammerb7f33662022-02-28 14:16:16 -05001579 addTarget(targetConfig{os: config.BuildOS, archName: *variables.HostArch, nativeBridgeEnabled: NativeBridgeDisabled})
Colin Cross4225f652015-09-17 14:33:42 -07001580
Colin Crossa6845402020-11-16 15:08:19 -08001581 // An optional secondary host target.
Colin Crosseeabb892015-11-20 13:07:51 -08001582 if variables.HostSecondaryArch != nil && *variables.HostSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001583 addTarget(targetConfig{os: config.BuildOS, archName: *variables.HostSecondaryArch, nativeBridgeEnabled: NativeBridgeDisabled})
Dan Willemsen490fd492015-11-24 17:53:15 -08001584 }
1585
Colin Crossa6845402020-11-16 15:08:19 -08001586 // Optional cross-compiled host targets, generally Windows.
Colin Crossff3ae9d2018-04-10 16:15:18 -07001587 if String(variables.CrossHost) != "" {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001588 crossHostOs := osByName(*variables.CrossHost)
1589 if crossHostOs == NoOsType {
1590 return nil, fmt.Errorf("Unknown cross host OS %q", *variables.CrossHost)
1591 }
1592
Colin Crossff3ae9d2018-04-10 16:15:18 -07001593 if String(variables.CrossHostArch) == "" {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001594 return nil, fmt.Errorf("No cross-host primary architecture set")
Dan Willemsen490fd492015-11-24 17:53:15 -08001595 }
1596
Colin Crossa6845402020-11-16 15:08:19 -08001597 // The primary cross-compiled host target.
Liz Kammerb7f33662022-02-28 14:16:16 -05001598 addTarget(targetConfig{os: crossHostOs, archName: *variables.CrossHostArch, nativeBridgeEnabled: NativeBridgeDisabled})
Dan Willemsen490fd492015-11-24 17:53:15 -08001599
Colin Crossa6845402020-11-16 15:08:19 -08001600 // An optional secondary cross-compiled host target.
Dan Willemsen490fd492015-11-24 17:53:15 -08001601 if variables.CrossHostSecondaryArch != nil && *variables.CrossHostSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001602 addTarget(targetConfig{os: crossHostOs, archName: *variables.CrossHostSecondaryArch, nativeBridgeEnabled: NativeBridgeDisabled})
Dan Willemsen490fd492015-11-24 17:53:15 -08001603 }
1604 }
1605
Colin Crossa6845402020-11-16 15:08:19 -08001606 // Optional device targets
Dan Willemsen3f32f032016-07-11 14:36:48 -07001607 if variables.DeviceArch != nil && *variables.DeviceArch != "" {
Colin Crossa6845402020-11-16 15:08:19 -08001608 // The primary device target.
Liz Kammerb7f33662022-02-28 14:16:16 -05001609 addTarget(targetConfig{
1610 os: Android,
1611 archName: *variables.DeviceArch,
1612 archVariant: variables.DeviceArchVariant,
1613 cpuVariant: variables.DeviceCpuVariant,
1614 abi: variables.DeviceAbi,
1615 nativeBridgeEnabled: NativeBridgeDisabled,
1616 })
Colin Cross4225f652015-09-17 14:33:42 -07001617
Colin Crossa6845402020-11-16 15:08:19 -08001618 // An optional secondary device target.
Dan Willemsen3f32f032016-07-11 14:36:48 -07001619 if variables.DeviceSecondaryArch != nil && *variables.DeviceSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001620 addTarget(targetConfig{
1621 os: Android,
1622 archName: *variables.DeviceSecondaryArch,
1623 archVariant: variables.DeviceSecondaryArchVariant,
1624 cpuVariant: variables.DeviceSecondaryCpuVariant,
1625 abi: variables.DeviceSecondaryAbi,
1626 nativeBridgeEnabled: NativeBridgeDisabled,
1627 })
Colin Cross4225f652015-09-17 14:33:42 -07001628 }
dimitry1f33e402019-03-26 12:39:31 +01001629
Colin Crossa6845402020-11-16 15:08:19 -08001630 // An optional NativeBridge device target.
dimitry1f33e402019-03-26 12:39:31 +01001631 if variables.NativeBridgeArch != nil && *variables.NativeBridgeArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001632 addTarget(targetConfig{
1633 os: Android,
1634 archName: *variables.NativeBridgeArch,
1635 archVariant: variables.NativeBridgeArchVariant,
1636 cpuVariant: variables.NativeBridgeCpuVariant,
1637 abi: variables.NativeBridgeAbi,
1638 nativeBridgeEnabled: NativeBridgeEnabled,
1639 nativeBridgeHostArchName: variables.DeviceArch,
1640 nativeBridgeRelativePath: variables.NativeBridgeRelativePath,
1641 })
dimitry1f33e402019-03-26 12:39:31 +01001642 }
1643
Colin Crossa6845402020-11-16 15:08:19 -08001644 // An optional secondary NativeBridge device target.
dimitry1f33e402019-03-26 12:39:31 +01001645 if variables.DeviceSecondaryArch != nil && *variables.DeviceSecondaryArch != "" &&
1646 variables.NativeBridgeSecondaryArch != nil && *variables.NativeBridgeSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001647 addTarget(targetConfig{
1648 os: Android,
1649 archName: *variables.NativeBridgeSecondaryArch,
1650 archVariant: variables.NativeBridgeSecondaryArchVariant,
1651 cpuVariant: variables.NativeBridgeSecondaryCpuVariant,
1652 abi: variables.NativeBridgeSecondaryAbi,
1653 nativeBridgeEnabled: NativeBridgeEnabled,
1654 nativeBridgeHostArchName: variables.DeviceSecondaryArch,
1655 nativeBridgeRelativePath: variables.NativeBridgeSecondaryRelativePath,
1656 })
dimitry1f33e402019-03-26 12:39:31 +01001657 }
Colin Cross4225f652015-09-17 14:33:42 -07001658 }
1659
Colin Crossa1ad8d12016-06-01 17:09:44 -07001660 if targetErr != nil {
1661 return nil, targetErr
1662 }
1663
1664 return targets, nil
Colin Cross4225f652015-09-17 14:33:42 -07001665}
1666
Colin Crossbb2e2b72016-12-08 17:23:53 -08001667// hasArmAbi returns true if arch has at least one arm ABI
1668func hasArmAbi(arch Arch) bool {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001669 return PrefixInList(arch.Abi, "arm")
Colin Crossbb2e2b72016-12-08 17:23:53 -08001670}
1671
Lev Rumyantsev34581212021-10-13 09:47:59 -07001672// hasArmAndroidArch returns true if targets has at least
1673// one arm Android arch (possibly native bridged)
Colin Cross4247f0d2017-04-13 16:56:14 -07001674func hasArmAndroidArch(targets []Target) bool {
1675 for _, target := range targets {
Lev Rumyantsev34581212021-10-13 09:47:59 -07001676 if target.Os == Android &&
1677 (target.Arch.ArchType == Arm || target.Arch.ArchType == Arm64) {
Victor Khimenko5eb8ec12018-03-21 20:30:54 +01001678 return true
1679 }
1680 }
1681 return false
1682}
1683
Colin Crossa6845402020-11-16 15:08:19 -08001684// archConfig describes a built-in configuration.
Dan Albert4098deb2016-10-19 14:04:41 -07001685type archConfig struct {
Liz Kammer992918d2022-11-11 10:37:54 -05001686 Arch string `json:"arch"`
1687 ArchVariant string `json:"arch_variant"`
1688 CpuVariant string `json:"cpu_variant"`
1689 Abi []string `json:"abis"`
Dan Albert4098deb2016-10-19 14:04:41 -07001690}
1691
Elliott Hughesc55b5862022-10-27 23:46:22 +00001692// getNdkAbisConfig returns the list of archConfigs that are used for building
1693// the API stubs and static libraries that are included in the NDK.
Dan Albert4098deb2016-10-19 14:04:41 -07001694func getNdkAbisConfig() []archConfig {
1695 return []archConfig{
Tamas Petzbca786d2021-01-20 18:56:33 +01001696 {"arm64", "armv8-a-branchprot", "", []string{"arm64-v8a"}},
Elliott Hughesc55b5862022-10-27 23:46:22 +00001697 {"arm", "armv7-a-neon", "", []string{"armeabi-v7a"}},
Elliott Hughesf7d31092023-03-14 23:11:57 +00001698 {"riscv64", "", "", []string{"riscv64"}},
Dan Albert4098deb2016-10-19 14:04:41 -07001699 {"x86_64", "", "", []string{"x86_64"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001700 {"x86", "", "", []string{"x86"}},
Dan Albert4098deb2016-10-19 14:04:41 -07001701 }
1702}
1703
Colin Crossa6845402020-11-16 15:08:19 -08001704// getAmlAbisConfig returns a list of archConfigs for the ABIs supported by mainline modules.
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001705func getAmlAbisConfig() []archConfig {
1706 return []archConfig{
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001707 {"arm64", "armv8-a", "", []string{"arm64-v8a"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001708 {"arm", "armv7-a-neon", "", []string{"armeabi-v7a"}},
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001709 {"x86_64", "", "", []string{"x86_64"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001710 {"x86", "", "", []string{"x86"}},
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001711 }
1712}
1713
Colin Crossa6845402020-11-16 15:08:19 -08001714// decodeArchSettings converts a list of archConfigs into a list of Targets for the given OsType.
Liz Kammerb7f33662022-02-28 14:16:16 -05001715func decodeAndroidArchSettings(archConfigs []archConfig) ([]Target, error) {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001716 var ret []Target
Dan Willemsen322acaf2016-01-12 23:07:05 -08001717
Dan Albert4098deb2016-10-19 14:04:41 -07001718 for _, config := range archConfigs {
Liz Kammer992918d2022-11-11 10:37:54 -05001719 arch, err := decodeArch(Android, config.Arch, &config.ArchVariant,
1720 &config.CpuVariant, config.Abi)
Dan Willemsen322acaf2016-01-12 23:07:05 -08001721 if err != nil {
1722 return nil, err
1723 }
Colin Cross3b19f5d2019-09-17 14:45:31 -07001724
Colin Crossa1ad8d12016-06-01 17:09:44 -07001725 ret = append(ret, Target{
1726 Os: Android,
1727 Arch: arch,
1728 })
Dan Willemsen322acaf2016-01-12 23:07:05 -08001729 }
1730
1731 return ret, nil
1732}
1733
Colin Crossa6845402020-11-16 15:08:19 -08001734// decodeArch converts a set of strings from product variables into an Arch struct.
Colin Crossa74ca042019-01-31 14:31:51 -08001735func decodeArch(os OsType, arch string, archVariant, cpuVariant *string, abi []string) (Arch, error) {
Colin Crossa6845402020-11-16 15:08:19 -08001736 // Verify the arch is valid
Colin Crosseeabb892015-11-20 13:07:51 -08001737 archType, ok := archTypeMap[arch]
1738 if !ok {
1739 return Arch{}, fmt.Errorf("unknown arch %q", arch)
1740 }
Colin Cross4225f652015-09-17 14:33:42 -07001741
Colin Crosseeabb892015-11-20 13:07:51 -08001742 a := Arch{
Colin Cross4225f652015-09-17 14:33:42 -07001743 ArchType: archType,
Colin Crossa6845402020-11-16 15:08:19 -08001744 ArchVariant: String(archVariant),
1745 CpuVariant: String(cpuVariant),
Colin Crossa74ca042019-01-31 14:31:51 -08001746 Abi: abi,
Colin Crosseeabb892015-11-20 13:07:51 -08001747 }
1748
Colin Crossa6845402020-11-16 15:08:19 -08001749 // Convert generic arch variants into the empty string.
Colin Crosseeabb892015-11-20 13:07:51 -08001750 if a.ArchVariant == a.ArchType.Name || a.ArchVariant == "generic" {
1751 a.ArchVariant = ""
1752 }
1753
Colin Crossa6845402020-11-16 15:08:19 -08001754 // Convert generic CPU variants into the empty string.
Colin Crosseeabb892015-11-20 13:07:51 -08001755 if a.CpuVariant == a.ArchType.Name || a.CpuVariant == "generic" {
1756 a.CpuVariant = ""
1757 }
1758
Liz Kammer2c2afe22022-02-11 11:35:03 -05001759 if a.ArchVariant != "" {
1760 if validArchVariants := archVariants[archType]; !InList(a.ArchVariant, validArchVariants) {
1761 return Arch{}, fmt.Errorf("[%q] unknown arch variant %q, support variants: %q", archType, a.ArchVariant, validArchVariants)
1762 }
1763 }
1764
1765 if a.CpuVariant != "" {
1766 if validCpuVariants := cpuVariants[archType]; !InList(a.CpuVariant, validCpuVariants) {
1767 return Arch{}, fmt.Errorf("[%q] unknown cpu variant %q, support variants: %q", archType, a.CpuVariant, validCpuVariants)
1768 }
1769 }
1770
Colin Crossa6845402020-11-16 15:08:19 -08001771 // Filter empty ABIs out of the list.
Colin Crosseeabb892015-11-20 13:07:51 -08001772 for i := 0; i < len(a.Abi); i++ {
1773 if a.Abi[i] == "" {
1774 a.Abi = append(a.Abi[:i], a.Abi[i+1:]...)
1775 i--
1776 }
1777 }
1778
Liz Kammere8303bd2022-02-16 09:02:48 -05001779 // Set ArchFeatures from the arch type. for Android OS, other os-es do not specify features
1780 if os == Android {
1781 if featureMap, ok := androidArchFeatureMap[archType]; ok {
Dan Willemsen01a3c252019-01-11 19:02:16 -08001782 a.ArchFeatures = featureMap[a.ArchVariant]
1783 }
Colin Crossc5c24ad2015-11-20 15:35:00 -08001784 }
1785
Colin Crosseeabb892015-11-20 13:07:51 -08001786 return a, nil
Colin Cross4225f652015-09-17 14:33:42 -07001787}
1788
Colin Crossa6845402020-11-16 15:08:19 -08001789// filterMultilibTargets takes a list of Targets and a multilib value and returns a new list of
1790// Targets containing only those that have the given multilib value.
Colin Cross69617d32016-09-06 10:39:07 -07001791func filterMultilibTargets(targets []Target, multilib string) []Target {
1792 var ret []Target
1793 for _, t := range targets {
1794 if t.Arch.ArchType.Multilib == multilib {
1795 ret = append(ret, t)
1796 }
1797 }
1798 return ret
1799}
1800
Colin Crossa6845402020-11-16 15:08:19 -08001801// getCommonTargets returns the set of Os specific common architecture targets for each Os in a list
1802// of targets.
Nan Zhangdb0b9a32017-02-27 10:12:13 -08001803func getCommonTargets(targets []Target) []Target {
1804 var ret []Target
1805 set := make(map[string]bool)
1806
1807 for _, t := range targets {
1808 if _, found := set[t.Os.String()]; !found {
1809 set[t.Os.String()] = true
Colin Cross39a18142022-06-24 18:43:40 -07001810 common := commonTargetMap[t.Os.String()]
1811 common.HostCross = t.HostCross
1812 ret = append(ret, common)
Nan Zhangdb0b9a32017-02-27 10:12:13 -08001813 }
1814 }
1815
1816 return ret
1817}
1818
Sam Delmericocc271e22022-06-01 15:45:02 +00001819// FirstTarget takes a list of Targets and a list of multilib values and returns a list of Targets
Colin Crossc0f0eb82022-07-19 14:41:11 -07001820// that contains zero or one Target for each OsType and HostCross, selecting the one that matches
1821// the earliest filter.
Sam Delmericocc271e22022-06-01 15:45:02 +00001822func FirstTarget(targets []Target, filters ...string) []Target {
Jiyong Park22101982020-09-17 19:09:58 +09001823 // find the first target from each OS
1824 var ret []Target
Colin Crossc0f0eb82022-07-19 14:41:11 -07001825 type osHostCross struct {
1826 os OsType
1827 hostCross bool
1828 }
1829 set := make(map[osHostCross]bool)
Jiyong Park22101982020-09-17 19:09:58 +09001830
Colin Cross6b4a32d2017-12-05 13:42:45 -08001831 for _, filter := range filters {
1832 buildTargets := filterMultilibTargets(targets, filter)
Jiyong Park22101982020-09-17 19:09:58 +09001833 for _, t := range buildTargets {
Colin Crossc0f0eb82022-07-19 14:41:11 -07001834 key := osHostCross{t.Os, t.HostCross}
1835 if _, found := set[key]; !found {
1836 set[key] = true
Jiyong Park22101982020-09-17 19:09:58 +09001837 ret = append(ret, t)
1838 }
Colin Cross6b4a32d2017-12-05 13:42:45 -08001839 }
1840 }
Jiyong Park22101982020-09-17 19:09:58 +09001841 return ret
Colin Cross6b4a32d2017-12-05 13:42:45 -08001842}
1843
Colin Crossa6845402020-11-16 15:08:19 -08001844// decodeMultilibTargets uses the module's multilib setting to select one or more targets from a
1845// list of Targets.
Colin Crossee0bc3b2018-10-02 22:01:37 -07001846func decodeMultilibTargets(multilib string, targets []Target, prefer32 bool) ([]Target, error) {
Colin Crossa6845402020-11-16 15:08:19 -08001847 var buildTargets []Target
Colin Cross6b4a32d2017-12-05 13:42:45 -08001848
Colin Cross4225f652015-09-17 14:33:42 -07001849 switch multilib {
1850 case "common":
Colin Cross6b4a32d2017-12-05 13:42:45 -08001851 buildTargets = getCommonTargets(targets)
1852 case "common_first":
1853 buildTargets = getCommonTargets(targets)
1854 if prefer32 {
Sam Delmericocc271e22022-06-01 15:45:02 +00001855 buildTargets = append(buildTargets, FirstTarget(targets, "lib32", "lib64")...)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001856 } else {
Sam Delmericocc271e22022-06-01 15:45:02 +00001857 buildTargets = append(buildTargets, FirstTarget(targets, "lib64", "lib32")...)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001858 }
Colin Cross4225f652015-09-17 14:33:42 -07001859 case "both":
Colin Cross8b74d172016-09-13 09:59:14 -07001860 if prefer32 {
1861 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib32")...)
1862 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib64")...)
1863 } else {
1864 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib64")...)
1865 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib32")...)
1866 }
Colin Cross4225f652015-09-17 14:33:42 -07001867 case "32":
Colin Cross69617d32016-09-06 10:39:07 -07001868 buildTargets = filterMultilibTargets(targets, "lib32")
Colin Cross4225f652015-09-17 14:33:42 -07001869 case "64":
Colin Cross69617d32016-09-06 10:39:07 -07001870 buildTargets = filterMultilibTargets(targets, "lib64")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001871 case "first":
1872 if prefer32 {
Sam Delmericocc271e22022-06-01 15:45:02 +00001873 buildTargets = FirstTarget(targets, "lib32", "lib64")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001874 } else {
Sam Delmericocc271e22022-06-01 15:45:02 +00001875 buildTargets = FirstTarget(targets, "lib64", "lib32")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001876 }
Victor Chang9448e8f2020-09-14 15:34:16 +01001877 case "first_prefer32":
Sam Delmericocc271e22022-06-01 15:45:02 +00001878 buildTargets = FirstTarget(targets, "lib32", "lib64")
Colin Cross69617d32016-09-06 10:39:07 -07001879 case "prefer32":
Colin Cross3dceee32018-09-06 10:19:57 -07001880 buildTargets = filterMultilibTargets(targets, "lib32")
1881 if len(buildTargets) == 0 {
1882 buildTargets = filterMultilibTargets(targets, "lib64")
1883 }
Dan Willemsen47450072021-10-19 20:24:49 -07001884 case "darwin_universal":
1885 buildTargets = filterMultilibTargets(targets, "lib64")
1886 // Reverse the targets so that the first architecture can depend on the second
1887 // architecture module in order to merge the outputs.
Colin Crossb5e3f7d2023-07-06 15:37:53 -07001888 ReverseSliceInPlace(buildTargets)
Dan Willemsen47450072021-10-19 20:24:49 -07001889 case "darwin_universal_common_first":
1890 archTargets := filterMultilibTargets(targets, "lib64")
Colin Crossb5e3f7d2023-07-06 15:37:53 -07001891 ReverseSliceInPlace(archTargets)
Dan Willemsen47450072021-10-19 20:24:49 -07001892 buildTargets = append(getCommonTargets(targets), archTargets...)
Colin Cross4225f652015-09-17 14:33:42 -07001893 default:
Victor Chang9448e8f2020-09-14 15:34:16 +01001894 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 -07001895 multilib)
Colin Cross4225f652015-09-17 14:33:42 -07001896 }
1897
Colin Crossa1ad8d12016-06-01 17:09:44 -07001898 return buildTargets, nil
Colin Cross4225f652015-09-17 14:33:42 -07001899}
Jingwen Chen5d864492021-02-24 07:20:12 -05001900
Chris Parsonsc424b762021-04-29 18:06:50 -04001901func (m *ModuleBase) getArchPropertySet(propertySet interface{}, archType ArchType) interface{} {
1902 archString := archType.Field
1903 for i := range m.archProperties {
1904 if m.archProperties[i] == nil {
1905 // Skip over nil properties
1906 continue
1907 }
1908
1909 // Not archProperties are usable; this function looks for properties of a very specific
1910 // form, and ignores the rest.
1911 for _, archProperty := range m.archProperties[i] {
1912 // archPropValue is a property struct, we are looking for the form:
1913 // `arch: { arm: { key: value, ... }}`
1914 archPropValue := reflect.ValueOf(archProperty).Elem()
1915
1916 // Unwrap src so that it should looks like a pointer to `arm: { key: value, ... }`
1917 src := archPropValue.FieldByName("Arch").Elem()
1918
1919 // Step into non-nil pointers to structs in the src value.
1920 if src.Kind() == reflect.Ptr {
1921 if src.IsNil() {
1922 continue
1923 }
1924 src = src.Elem()
1925 }
1926
1927 // Find the requested field (e.g. arm, x86) in the src struct.
1928 src = src.FieldByName(archString)
1929
1930 // We only care about structs.
1931 if !src.IsValid() || src.Kind() != reflect.Struct {
1932 continue
1933 }
1934
1935 // If the value of the field is a struct then step into the
1936 // BlueprintEmbed field. The special "BlueprintEmbed" name is
1937 // used by createArchPropTypeDesc to embed the arch properties
1938 // in the parent struct, so the src arch prop should be in this
1939 // field.
1940 //
1941 // See createArchPropTypeDesc for more details on how Arch-specific
1942 // module properties are processed from the nested props and written
1943 // into the module's archProperties.
1944 src = src.FieldByName("BlueprintEmbed")
1945
1946 // Clone the destination prop, since we want a unique prop struct per arch.
1947 propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1948
1949 // Copy the located property struct into the cloned destination property struct.
1950 err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)
1951 if err != nil {
1952 // This is fine, it just means the src struct doesn't match the type of propertySet.
1953 continue
1954 }
1955
1956 return propertySetClone
1957 }
1958 }
1959 // No property set was found specific to the given arch, so return an empty
1960 // property set.
1961 return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1962}
1963
1964// getMultilibPropertySet returns a property set struct matching the type of
1965// `propertySet`, containing multilib-specific module properties for the given architecture.
1966// If no multilib-specific properties exist for the given architecture, returns an empty property
1967// set matching `propertySet`'s type.
1968func (m *ModuleBase) getMultilibPropertySet(propertySet interface{}, archType ArchType) interface{} {
1969 // archType.Multilib is lowercase (for example, lib32) but property struct field is
1970 // capitalized, such as Lib32, so use strings.Title to capitalize it.
1971 multiLibString := strings.Title(archType.Multilib)
1972
1973 for i := range m.archProperties {
1974 if m.archProperties[i] == nil {
1975 // Skip over nil properties
1976 continue
1977 }
1978
1979 // Not archProperties are usable; this function looks for properties of a very specific
1980 // form, and ignores the rest.
1981 for _, archProperties := range m.archProperties[i] {
1982 // archPropValue is a property struct, we are looking for the form:
1983 // `multilib: { lib32: { key: value, ... }}`
1984 archPropValue := reflect.ValueOf(archProperties).Elem()
1985
1986 // Unwrap src so that it should looks like a pointer to `lib32: { key: value, ... }`
1987 src := archPropValue.FieldByName("Multilib").Elem()
1988
1989 // Step into non-nil pointers to structs in the src value.
1990 if src.Kind() == reflect.Ptr {
1991 if src.IsNil() {
1992 // Ignore nil pointers.
1993 continue
1994 }
1995 src = src.Elem()
1996 }
1997
1998 // Find the requested field (e.g. lib32) in the src struct.
1999 src = src.FieldByName(multiLibString)
2000
2001 // We only care about valid struct pointers.
2002 if !src.IsValid() || src.Kind() != reflect.Ptr || src.Elem().Kind() != reflect.Struct {
2003 continue
2004 }
2005
2006 // Get the zero value for the requested property set.
2007 propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2008
2009 // Copy the located property struct into the "zero" property set struct.
2010 err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)
2011
2012 if err != nil {
2013 // This is fine, it just means the src struct doesn't match.
2014 continue
2015 }
2016
2017 return propertySetClone
2018 }
2019 }
2020
2021 // There were no multilib properties specifically matching the given archtype.
2022 // Return zeroed value.
2023 return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2024}
2025
Liz Kammerb6dbc872021-05-14 15:14:40 -04002026// ArchVariantContext defines the limited context necessary to retrieve arch_variant properties.
2027type ArchVariantContext interface {
2028 ModuleErrorf(fmt string, args ...interface{})
2029 PropertyErrorf(property, fmt string, args ...interface{})
2030}
2031
Liz Kammer9abd62d2021-05-21 08:37:59 -04002032// ArchVariantProperties represents a map of arch-variant config strings to a property interface{}.
2033type ArchVariantProperties map[string]interface{}
2034
2035// ConfigurationAxisToArchVariantProperties represents a map of bazel.ConfigurationAxis to
2036// ArchVariantProperties, such that each independent arch-variant axis maps to the
2037// configs/properties for that axis.
2038type ConfigurationAxisToArchVariantProperties map[bazel.ConfigurationAxis]ArchVariantProperties
2039
2040// GetArchVariantProperties returns a ConfigurationAxisToArchVariantProperties where the
2041// arch-variant properties correspond to the values of the properties of the 'propertySet' struct
2042// that are specific to that axis/configuration. Each axis is independent, containing
2043// non-overlapping configs that correspond to the various "arch-variant" support, at this time:
Colin Crossd079e0b2022-08-16 10:27:33 -07002044//
2045// arches (including multilib)
2046// oses
2047// arch+os combinations
Jingwen Chen5d864492021-02-24 07:20:12 -05002048//
Liz Kammer9abd62d2021-05-21 08:37:59 -04002049// For example, passing a struct { Foo bool, Bar string } will return an interface{} that can be
2050// type asserted back into the same struct, containing the config-specific property value specified
2051// by the module if defined.
Chris Parsonsc424b762021-04-29 18:06:50 -04002052//
2053// Arch-specific properties may come from an arch stanza or a multilib stanza; properties
2054// in these stanzas are combined.
2055// For example: `arch: { x86: { Foo: ["bar"] } }, multilib: { lib32: {` Foo: ["baz"] } }`
2056// will result in `Foo: ["bar", "baz"]` being returned for architecture x86, if the given
2057// propertyset contains `Foo []string`.
Liz Kammer9abd62d2021-05-21 08:37:59 -04002058func (m *ModuleBase) GetArchVariantProperties(ctx ArchVariantContext, propertySet interface{}) ConfigurationAxisToArchVariantProperties {
Jingwen Chen5d864492021-02-24 07:20:12 -05002059 // Return value of the arch types to the prop values for that arch.
Liz Kammer9abd62d2021-05-21 08:37:59 -04002060 axisToProps := ConfigurationAxisToArchVariantProperties{}
Jingwen Chen5d864492021-02-24 07:20:12 -05002061
2062 // Nothing to do for non-arch-specific modules.
2063 if !m.ArchSpecific() {
Liz Kammer9abd62d2021-05-21 08:37:59 -04002064 return axisToProps
Jingwen Chen5d864492021-02-24 07:20:12 -05002065 }
2066
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002067 dstType := reflect.ValueOf(propertySet).Type()
2068 var archProperties []interface{}
2069
2070 // First find the property set in the module that corresponds to the requested
Usta851a3272022-01-05 23:42:33 -05002071 // one. m.archProperties[i] corresponds to m.GetProperties()[i].
2072 for i, generalProp := range m.GetProperties() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002073 srcType := reflect.ValueOf(generalProp).Type()
2074 if srcType == dstType {
2075 archProperties = m.archProperties[i]
Liz Kammer135bf552021-08-11 10:46:06 -04002076 axisToProps[bazel.NoConfigAxis] = ArchVariantProperties{"": generalProp}
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002077 break
2078 }
2079 }
2080
2081 if archProperties == nil {
2082 // This module does not have the property set requested
Liz Kammer9abd62d2021-05-21 08:37:59 -04002083 return axisToProps
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002084 }
2085
Liz Kammer9abd62d2021-05-21 08:37:59 -04002086 archToProp := ArchVariantProperties{}
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002087 // For each arch type (x86, arm64, etc.)
Chris Parsonsc424b762021-04-29 18:06:50 -04002088 for _, arch := range ArchTypeList() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002089 // Arch properties are sometimes sharded (see createArchPropTypeDesc() ).
Cole Faustc843b992022-08-02 18:06:50 -07002090 // Iterate over every shard and extract a struct with the same type as the
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002091 // input one that contains the data specific to that arch.
2092 propertyStructs := make([]reflect.Value, 0)
Cole Faustc843b992022-08-02 18:06:50 -07002093 archFeaturePropertyStructs := make(map[string][]reflect.Value, 0)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002094 for _, archProperty := range archProperties {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02002095 archTypeStruct, ok := getArchTypeStruct(ctx, archProperty, arch)
2096 if ok {
2097 propertyStructs = append(propertyStructs, archTypeStruct)
Cole Faustc843b992022-08-02 18:06:50 -07002098
2099 // For each feature this arch supports (arm: neon, x86: ssse3, sse4, ...)
2100 for _, feature := range archFeatures[arch] {
2101 prefix := "arch." + arch.Name + "." + feature
2102 if featureProperties, ok := getChildPropertyStruct(ctx, archTypeStruct, feature, prefix); ok {
2103 archFeaturePropertyStructs[feature] = append(archFeaturePropertyStructs[feature], featureProperties)
2104 }
2105 }
Lukacs T. Berki5f518392021-05-17 11:44:58 +02002106 }
2107 multilibStruct, ok := getMultilibStruct(ctx, archProperty, arch)
2108 if ok {
2109 propertyStructs = append(propertyStructs, multilibStruct)
2110 }
Jingwen Chen5d864492021-02-24 07:20:12 -05002111 }
2112
Cole Faustc843b992022-08-02 18:06:50 -07002113 archToProp[arch.Name] = mergeStructs(ctx, propertyStructs, propertySet)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002114
Cole Faustc843b992022-08-02 18:06:50 -07002115 // In soong, if multiple features match the current configuration, they're
2116 // all used. In bazel, we have to have unambiguous select() statements, so
2117 // we can't have two features that are both active in the same select().
2118 // One alternative is to split out each feature into a separate select(),
2119 // but then it's difficult to support exclude_srcs, which may need to
2120 // exclude things from the regular arch select() statement if a certain
2121 // feature is active. Instead, keep the features in the same select
2122 // statement as the arches, but emit the power set of all possible
2123 // combinations of features, so that bazel can match the most precise one.
2124 allFeatures := make([]string, 0, len(archFeaturePropertyStructs))
2125 for feature := range archFeaturePropertyStructs {
2126 allFeatures = append(allFeatures, feature)
2127 }
2128 for _, features := range bazel.PowerSetWithoutEmptySet(allFeatures) {
2129 sort.Strings(features)
2130 propsForCurrentFeatureSet := make([]reflect.Value, 0)
2131 propsForCurrentFeatureSet = append(propsForCurrentFeatureSet, propertyStructs...)
2132 for _, feature := range features {
2133 propsForCurrentFeatureSet = append(propsForCurrentFeatureSet, archFeaturePropertyStructs[feature]...)
2134 }
2135 archToProp[arch.Name+"-"+strings.Join(features, "-")] =
2136 mergeStructs(ctx, propsForCurrentFeatureSet, propertySet)
2137 }
Jingwen Chen5d864492021-02-24 07:20:12 -05002138 }
Liz Kammer9abd62d2021-05-21 08:37:59 -04002139 axisToProps[bazel.ArchConfigurationAxis] = archToProp
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002140
Liz Kammer9abd62d2021-05-21 08:37:59 -04002141 osToProp := ArchVariantProperties{}
2142 archOsToProp := ArchVariantProperties{}
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002143
Liz Kammerfdd72e62021-10-11 15:41:03 -04002144 linuxStructs := getTargetStructs(ctx, archProperties, "Linux")
2145 bionicStructs := getTargetStructs(ctx, archProperties, "Bionic")
2146 hostStructs := getTargetStructs(ctx, archProperties, "Host")
Colin Crossa98d36d2022-03-07 14:39:49 -08002147 hostLinuxStructs := getTargetStructs(ctx, archProperties, "Host_linux")
Liz Kammerfdd72e62021-10-11 15:41:03 -04002148 hostNotWindowsStructs := getTargetStructs(ctx, archProperties, "Not_windows")
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002149
Liz Kammer9abd62d2021-05-21 08:37:59 -04002150 // For android, linux, ...
2151 for _, os := range osTypeList {
2152 if os == CommonOS {
2153 // It looks like this OS value is not used in Blueprint files
2154 continue
2155 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002156 osStructs := make([]reflect.Value, 0)
Liz Kammerfdd72e62021-10-11 15:41:03 -04002157
2158 osSpecificStructs := getTargetStructs(ctx, archProperties, os.Field)
2159 if os.Class == Host {
2160 osStructs = append(osStructs, hostStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002161 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002162 if os.Linux() {
2163 osStructs = append(osStructs, linuxStructs...)
2164 }
2165 if os.Bionic() {
2166 osStructs = append(osStructs, bionicStructs...)
2167 }
Colin Crossa98d36d2022-03-07 14:39:49 -08002168 if os.Linux() && os.Class == Host {
2169 osStructs = append(osStructs, hostLinuxStructs...)
2170 }
Liz Kammerfdd72e62021-10-11 15:41:03 -04002171
2172 if os == LinuxMusl {
2173 osStructs = append(osStructs, getTargetStructs(ctx, archProperties, "Musl")...)
2174 }
2175 if os == Linux {
2176 osStructs = append(osStructs, getTargetStructs(ctx, archProperties, "Glibc")...)
2177 }
2178
2179 osStructs = append(osStructs, osSpecificStructs...)
2180
2181 if os.Class == Host && os != Windows {
2182 osStructs = append(osStructs, hostNotWindowsStructs...)
2183 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002184 osToProp[os.Name] = mergeStructs(ctx, osStructs, propertySet)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002185
Liz Kammer9abd62d2021-05-21 08:37:59 -04002186 // For arm, x86, ...
2187 for _, arch := range osArchTypeMap[os] {
Chris Parsonsa37e1952021-09-28 16:47:36 -04002188 osArchStructs := make([]reflect.Value, 0)
2189
Chris Parsonsa37e1952021-09-28 16:47:36 -04002190 // Auto-combine with Linux_ and Bionic_ targets. This potentially results in
2191 // repetition and select() bloat, but use of Linux_* and Bionic_* targets is rare.
2192 // TODO(b/201423152): Look into cleanup.
2193 if os.Linux() {
2194 targetField := "Linux_" + arch.Name
Liz Kammerfdd72e62021-10-11 15:41:03 -04002195 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2196 osArchStructs = append(osArchStructs, targetStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002197 }
2198 if os.Bionic() {
2199 targetField := "Bionic_" + arch.Name
Liz Kammerfdd72e62021-10-11 15:41:03 -04002200 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2201 osArchStructs = append(osArchStructs, targetStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002202 }
Colin Cross2d295a22022-03-07 14:46:20 -08002203 if os == LinuxMusl {
2204 targetField := "Musl_" + arch.Name
2205 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2206 osArchStructs = append(osArchStructs, targetStructs...)
2207 }
2208 if os == Linux {
2209 targetField := "Glibc_" + arch.Name
2210 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2211 osArchStructs = append(osArchStructs, targetStructs...)
2212 }
Chris Parsonsa37e1952021-09-28 16:47:36 -04002213
Liz Kammerfdd72e62021-10-11 15:41:03 -04002214 targetField := GetCompoundTargetField(os, arch)
2215 targetName := fmt.Sprintf("%s_%s", os.Name, arch.Name)
2216 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2217 osArchStructs = append(osArchStructs, targetStructs...)
2218
Chris Parsonsa37e1952021-09-28 16:47:36 -04002219 archOsToProp[targetName] = mergeStructs(ctx, osArchStructs, propertySet)
Liz Kammer9abd62d2021-05-21 08:37:59 -04002220 }
2221 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002222
Liz Kammer9abd62d2021-05-21 08:37:59 -04002223 axisToProps[bazel.OsConfigurationAxis] = osToProp
2224 axisToProps[bazel.OsArchConfigurationAxis] = archOsToProp
Liz Kammer9abd62d2021-05-21 08:37:59 -04002225 return axisToProps
Jingwen Chen5d864492021-02-24 07:20:12 -05002226}
Jingwen Chen91220d72021-03-24 02:18:33 -04002227
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002228// Returns a struct matching the propertySet interface, containing properties specific to the targetName
2229// For example, given these arguments:
Colin Crossd079e0b2022-08-16 10:27:33 -07002230//
2231// propertySet = BaseCompilerProperties
2232// targetName = "android_arm"
2233//
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002234// And given this Android.bp fragment:
Colin Crossd079e0b2022-08-16 10:27:33 -07002235//
2236// target:
2237// android_arm: {
2238// srcs: ["foo.c"],
2239// }
2240// android_arm64: {
2241// srcs: ["bar.c"],
2242// }
2243// }
2244//
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002245// This would return a BaseCompilerProperties with BaseCompilerProperties.Srcs = ["foo.c"]
Liz Kammerfdd72e62021-10-11 15:41:03 -04002246func getTargetStructs(ctx ArchVariantContext, archProperties []interface{}, targetName string) []reflect.Value {
2247 var propertyStructs []reflect.Value
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002248 for _, archProperty := range archProperties {
2249 archPropValues := reflect.ValueOf(archProperty).Elem()
2250 targetProp := archPropValues.FieldByName("Target").Elem()
2251 targetStruct, ok := getChildPropertyStruct(ctx, targetProp, targetName, targetName)
2252 if ok {
2253 propertyStructs = append(propertyStructs, targetStruct)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002254 } else {
Liz Kammerfdd72e62021-10-11 15:41:03 -04002255 return []reflect.Value{}
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002256 }
2257 }
2258
Liz Kammerfdd72e62021-10-11 15:41:03 -04002259 return propertyStructs
Chris Parsonsa37e1952021-09-28 16:47:36 -04002260}
2261
2262func mergeStructs(ctx ArchVariantContext, propertyStructs []reflect.Value, propertySet interface{}) interface{} {
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002263 // Create a new instance of the requested property set
2264 value := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2265
2266 // Merge all the structs together
2267 for _, propertyStruct := range propertyStructs {
2268 mergePropertyStruct(ctx, value, propertyStruct)
2269 }
2270
2271 return value
2272}
Liz Kammere8303bd2022-02-16 09:02:48 -05002273
2274func printArchTypeStarlarkDict(dict map[ArchType][]string) string {
2275 valDict := make(map[string]string, len(dict))
2276 for k, v := range dict {
2277 valDict[k.String()] = starlark_fmt.PrintStringList(v, 1)
2278 }
2279 return starlark_fmt.PrintDict(valDict, 0)
2280}
2281
2282func printArchTypeNestedStarlarkDict(dict map[ArchType]map[string][]string) string {
2283 valDict := make(map[string]string, len(dict))
2284 for k, v := range dict {
2285 valDict[k.String()] = starlark_fmt.PrintStringListDict(v, 1)
2286 }
2287 return starlark_fmt.PrintDict(valDict, 0)
2288}
2289
Liz Kammer992918d2022-11-11 10:37:54 -05002290func printArchConfigList(arches []archConfig) string {
2291 jsonOut, err := json.MarshalIndent(arches, "", starlark_fmt.Indention(1))
2292 if err != nil {
2293 panic(fmt.Errorf("Error converting arch configs %#v to json: %q", arches, err))
2294 }
2295 return fmt.Sprintf("json.decode('''%s''')", string(jsonOut))
2296}
2297
Liz Kammere8303bd2022-02-16 09:02:48 -05002298func StarlarkArchConfigurations() string {
2299 return fmt.Sprintf(`
2300_arch_to_variants = %s
2301
2302_arch_to_cpu_variants = %s
2303
2304_arch_to_features = %s
2305
2306_android_arch_feature_for_arch_variant = %s
2307
Liz Kammer992918d2022-11-11 10:37:54 -05002308_aml_arches = %s
2309
2310_ndk_arches = %s
2311
Liz Kammere8303bd2022-02-16 09:02:48 -05002312arch_to_variants = _arch_to_variants
2313arch_to_cpu_variants = _arch_to_cpu_variants
2314arch_to_features = _arch_to_features
2315android_arch_feature_for_arch_variants = _android_arch_feature_for_arch_variant
Liz Kammer992918d2022-11-11 10:37:54 -05002316aml_arches = _aml_arches
2317ndk_arches = _ndk_arches
Liz Kammere8303bd2022-02-16 09:02:48 -05002318`, printArchTypeStarlarkDict(archVariants),
2319 printArchTypeStarlarkDict(cpuVariants),
2320 printArchTypeStarlarkDict(archFeatures),
2321 printArchTypeNestedStarlarkDict(androidArchFeatureMap),
Liz Kammer992918d2022-11-11 10:37:54 -05002322 printArchConfigList(getAmlAbisConfig()),
2323 printArchConfigList(getNdkAbisConfig()),
Liz Kammere8303bd2022-02-16 09:02:48 -05002324 )
2325}