blob: b5bd2f080944a70ac8254bde806d7605c57bbe4c [file] [log] [blame]
Colin Cross3f40fa42015-01-30 17:27:36 -08001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
Colin Cross635c3b02016-05-18 15:37:25 -070015package android
Colin Cross3f40fa42015-01-30 17:27:36 -080016
17import (
Colin Cross74ba9622019-02-11 15:11:14 -080018 "encoding"
Colin Cross3f40fa42015-01-30 17:27:36 -080019 "fmt"
20 "reflect"
21 "runtime"
22 "strings"
Colin Crossf6566ed2015-03-24 11:13:38 -070023
Colin Crosscb0ac952021-07-20 13:17:15 -070024 "android/soong/bazel"
Liz Kammere8303bd2022-02-16 09:02:48 -050025 "android/soong/starlark_fmt"
Colin Crosscb0ac952021-07-20 13:17:15 -070026
Colin Cross0f7d2ef2019-10-16 11:03:10 -070027 "github.com/google/blueprint"
Colin Cross617b88a2020-08-24 18:04:09 -070028 "github.com/google/blueprint/bootstrap"
Colin Crossf6566ed2015-03-24 11:13:38 -070029 "github.com/google/blueprint/proptools"
Colin Cross3f40fa42015-01-30 17:27:36 -080030)
31
Colin Cross3f40fa42015-01-30 17:27:36 -080032/*
33Example blueprints file containing all variant property groups, with comment listing what type
34of variants get properties in that group:
35
36module {
37 arch: {
38 arm: {
39 // Host or device variants with arm architecture
40 },
41 arm64: {
42 // Host or device variants with arm64 architecture
43 },
Colin Cross3f40fa42015-01-30 17:27:36 -080044 x86: {
45 // Host or device variants with x86 architecture
46 },
47 x86_64: {
48 // Host or device variants with x86_64 architecture
49 },
50 },
51 multilib: {
52 lib32: {
53 // Host or device variants for 32-bit architectures
54 },
55 lib64: {
56 // Host or device variants for 64-bit architectures
57 },
58 },
59 target: {
60 android: {
Martin Stjernholme284b482020-09-23 21:03:27 +010061 // Device variants (implies Bionic)
Colin Cross3f40fa42015-01-30 17:27:36 -080062 },
63 host: {
64 // Host variants
65 },
Martin Stjernholme284b482020-09-23 21:03:27 +010066 bionic: {
67 // Bionic (device and host) variants
68 },
69 linux_bionic: {
70 // Bionic host variants
71 },
72 linux: {
73 // Bionic (device and host) and Linux glibc variants
74 },
Dan Willemsen5746bd42017-10-02 19:42:01 -070075 linux_glibc: {
Martin Stjernholme284b482020-09-23 21:03:27 +010076 // Linux host variants (using non-Bionic libc)
Colin Cross3f40fa42015-01-30 17:27:36 -080077 },
78 darwin: {
79 // Darwin host variants
80 },
81 windows: {
82 // Windows host variants
83 },
84 not_windows: {
85 // Non-windows host variants
86 },
Martin Stjernholme284b482020-09-23 21:03:27 +010087 android_arm: {
88 // Any <os>_<arch> combination restricts to that os and arch
89 },
Colin Cross3f40fa42015-01-30 17:27:36 -080090 },
91}
92*/
Colin Cross7d5136f2015-05-11 13:39:40 -070093
Colin Cross3f40fa42015-01-30 17:27:36 -080094// An Arch indicates a single CPU architecture.
95type Arch struct {
Colin Crossa6845402020-11-16 15:08:19 -080096 // The type of the architecture (arm, arm64, x86, or x86_64).
97 ArchType ArchType
98
99 // The variant of the architecture, for example "armv7-a" or "armv7-a-neon" for arm.
100 ArchVariant string
101
102 // The variant of the CPU, for example "cortex-a53" for arm64.
103 CpuVariant string
104
105 // The list of Android app ABIs supported by the CPU architecture, for example "arm64-v8a".
106 Abi []string
107
108 // The list of arch-specific features supported by the CPU architecture, for example "neon".
Colin Crossc5c24ad2015-11-20 15:35:00 -0800109 ArchFeatures []string
Colin Cross3f40fa42015-01-30 17:27:36 -0800110}
111
Colin Crossa6845402020-11-16 15:08:19 -0800112// String returns the Arch as a string. The value is used as the name of the variant created
113// by archMutator.
Colin Cross3f40fa42015-01-30 17:27:36 -0800114func (a Arch) String() string {
Colin Crossd3ba0392015-05-07 14:11:29 -0700115 s := a.ArchType.String()
Colin Cross3f40fa42015-01-30 17:27:36 -0800116 if a.ArchVariant != "" {
117 s += "_" + a.ArchVariant
118 }
119 if a.CpuVariant != "" {
120 s += "_" + a.CpuVariant
121 }
122 return s
123}
124
Colin Crossa6845402020-11-16 15:08:19 -0800125// ArchType is used to define the 4 supported architecture types (arm, arm64, x86, x86_64), as
126// well as the "common" architecture used for modules that support multiple architectures, for
127// example Java modules.
Colin Cross3f40fa42015-01-30 17:27:36 -0800128type ArchType struct {
Colin Crossa6845402020-11-16 15:08:19 -0800129 // Name is the name of the architecture type, "arm", "arm64", "x86", or "x86_64".
130 Name string
131
132 // Field is the name of the field used in properties that refer to the architecture, e.g. "Arm64".
133 Field string
134
135 // Multilib is either "lib32" or "lib64" for 32-bit or 64-bit architectures.
Colin Crossec193632015-07-06 17:49:43 -0700136 Multilib string
Colin Cross3f40fa42015-01-30 17:27:36 -0800137}
138
Colin Crossa6845402020-11-16 15:08:19 -0800139// String returns the name of the ArchType.
140func (a ArchType) String() string {
141 return a.Name
142}
143
144const COMMON_VARIANT = "common"
145
146var (
147 archTypeList []ArchType
148
149 Arm = newArch("arm", "lib32")
150 Arm64 = newArch("arm64", "lib64")
151 X86 = newArch("x86", "lib32")
152 X86_64 = newArch("x86_64", "lib64")
153
154 Common = ArchType{
155 Name: COMMON_VARIANT,
156 }
157)
158
159var archTypeMap = map[string]ArchType{}
160
Colin Crossec193632015-07-06 17:49:43 -0700161func newArch(name, multilib string) ArchType {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700162 archType := ArchType{
Colin Crossec193632015-07-06 17:49:43 -0700163 Name: name,
Dan Willemsenb1957a52016-06-23 23:44:54 -0700164 Field: proptools.FieldNameForProperty(name),
Colin Crossec193632015-07-06 17:49:43 -0700165 Multilib: multilib,
Colin Cross3f40fa42015-01-30 17:27:36 -0800166 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700167 archTypeList = append(archTypeList, archType)
Colin Crossa6845402020-11-16 15:08:19 -0800168 archTypeMap[name] = archType
Dan Willemsenb1957a52016-06-23 23:44:54 -0700169 return archType
Colin Cross3f40fa42015-01-30 17:27:36 -0800170}
171
Ustaeabf0f32021-12-06 15:17:23 -0500172// ArchTypeList returns a slice copy of the 4 supported ArchTypes for arm,
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000173// arm64, x86 and x86_64.
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700174func ArchTypeList() []ArchType {
175 return append([]ArchType(nil), archTypeList...)
176}
177
Colin Crossa6845402020-11-16 15:08:19 -0800178// MarshalText allows an ArchType to be serialized through any encoder that supports
179// encoding.TextMarshaler.
Colin Cross74ba9622019-02-11 15:11:14 -0800180func (a ArchType) MarshalText() ([]byte, error) {
Jeongik Chabec4d032021-04-15 08:55:38 +0900181 return []byte(a.String()), nil
Colin Cross74ba9622019-02-11 15:11:14 -0800182}
183
Colin Crossa6845402020-11-16 15:08:19 -0800184var _ encoding.TextMarshaler = ArchType{}
Colin Cross74ba9622019-02-11 15:11:14 -0800185
Colin Crossa6845402020-11-16 15:08:19 -0800186// UnmarshalText allows an ArchType to be deserialized through any decoder that supports
187// encoding.TextUnmarshaler.
Colin Cross74ba9622019-02-11 15:11:14 -0800188func (a *ArchType) UnmarshalText(text []byte) error {
189 if u, ok := archTypeMap[string(text)]; ok {
190 *a = u
191 return nil
192 }
193
194 return fmt.Errorf("unknown ArchType %q", text)
195}
196
Colin Crossa6845402020-11-16 15:08:19 -0800197var _ encoding.TextUnmarshaler = &ArchType{}
Colin Crossa1ad8d12016-06-01 17:09:44 -0700198
Colin Crossa6845402020-11-16 15:08:19 -0800199// OsClass is an enum that describes whether a variant of a module runs on the host, on the device,
200// or is generic.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700201type OsClass int
202
203const (
Colin Crossa6845402020-11-16 15:08:19 -0800204 // Generic is used for variants of modules that are not OS-specific.
Dan Willemsen0e2d97b2016-11-28 17:50:06 -0800205 Generic OsClass = iota
Colin Crossa6845402020-11-16 15:08:19 -0800206 // Device is used for variants of modules that run on the device.
Dan Willemsen0e2d97b2016-11-28 17:50:06 -0800207 Device
Colin Crossa6845402020-11-16 15:08:19 -0800208 // Host is used for variants of modules that run on the host.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700209 Host
Colin Crossa1ad8d12016-06-01 17:09:44 -0700210)
211
Colin Crossa6845402020-11-16 15:08:19 -0800212// String returns the OsClass as a string.
Colin Cross67a5c132017-05-09 13:45:28 -0700213func (class OsClass) String() string {
214 switch class {
215 case Generic:
216 return "generic"
217 case Device:
218 return "device"
219 case Host:
220 return "host"
Colin Cross67a5c132017-05-09 13:45:28 -0700221 default:
222 panic(fmt.Errorf("unknown class %d", class))
223 }
224}
225
Colin Crossa6845402020-11-16 15:08:19 -0800226// OsType describes an OS variant of a module.
227type OsType struct {
228 // Name is the name of the OS. It is also used as the name of the property in Android.bp
229 // files.
230 Name string
231
232 // Field is the name of the OS converted to an exported field name, i.e. with the first
233 // character capitalized.
234 Field string
235
236 // Class is the OsClass of the OS.
237 Class OsClass
238
239 // DefaultDisabled is set when the module variants for the OS should not be created unless
240 // the module explicitly requests them. This is used to limit Windows cross compilation to
241 // only modules that need it.
242 DefaultDisabled bool
243}
244
245// String returns the name of the OsType.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700246func (os OsType) String() string {
247 return os.Name
Colin Cross54c71122016-06-01 17:09:44 -0700248}
249
Colin Crossa6845402020-11-16 15:08:19 -0800250// Bionic returns true if the OS uses the Bionic libc runtime, i.e. if the OS is Android or
251// is Linux with Bionic.
Dan Willemsen866b5632017-09-22 12:28:24 -0700252func (os OsType) Bionic() bool {
253 return os == Android || os == LinuxBionic
254}
255
Colin Crossa6845402020-11-16 15:08:19 -0800256// Linux returns true if the OS uses the Linux kernel, i.e. if the OS is Android or is Linux
257// with or without the Bionic libc runtime.
Dan Willemsen866b5632017-09-22 12:28:24 -0700258func (os OsType) Linux() bool {
Colin Cross528d67e2021-07-23 22:23:07 +0000259 return os == Android || os == Linux || os == LinuxBionic || os == LinuxMusl
Dan Willemsen866b5632017-09-22 12:28:24 -0700260}
261
Colin Crossa6845402020-11-16 15:08:19 -0800262// newOsType constructs an OsType and adds it to the global lists.
263func newOsType(name string, class OsClass, defDisabled bool, archTypes ...ArchType) OsType {
264 checkCalledFromInit()
Colin Crossa1ad8d12016-06-01 17:09:44 -0700265 os := OsType{
266 Name: name,
Colin Crossa6845402020-11-16 15:08:19 -0800267 Field: proptools.FieldNameForProperty(name),
Colin Crossa1ad8d12016-06-01 17:09:44 -0700268 Class: class,
Dan Willemsen0a37a2a2016-11-13 10:16:05 -0800269
270 DefaultDisabled: defDisabled,
Colin Cross54c71122016-06-01 17:09:44 -0700271 }
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000272 osTypeList = append(osTypeList, os)
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800273
274 if _, found := commonTargetMap[name]; found {
275 panic(fmt.Errorf("Found Os type duplicate during OsType registration: %q", name))
276 } else {
Colin Crosse9fe2942020-11-10 18:12:15 -0800277 commonTargetMap[name] = Target{Os: os, Arch: CommonArch}
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800278 }
Colin Crossa6845402020-11-16 15:08:19 -0800279 osArchTypeMap[os] = archTypes
Nan Zhangdb0b9a32017-02-27 10:12:13 -0800280
Colin Crossa1ad8d12016-06-01 17:09:44 -0700281 return os
282}
283
Colin Crossa6845402020-11-16 15:08:19 -0800284// osByName returns the OsType that has the given name, or NoOsType if none match.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700285func osByName(name string) OsType {
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000286 for _, os := range osTypeList {
Colin Crossa1ad8d12016-06-01 17:09:44 -0700287 if os.Name == name {
288 return os
289 }
290 }
291
292 return NoOsType
Dan Willemsen490fd492015-11-24 17:53:15 -0800293}
294
Colin Crossa6845402020-11-16 15:08:19 -0800295var (
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000296 // osTypeList contains a list of all the supported OsTypes, including ones not supported
Colin Crossa6845402020-11-16 15:08:19 -0800297 // by the current build host or the target device.
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000298 osTypeList []OsType
Colin Crossa6845402020-11-16 15:08:19 -0800299 // commonTargetMap maps names of OsTypes to the corresponding common Target, i.e. the
300 // Target with the same OsType and the common ArchType.
301 commonTargetMap = make(map[string]Target)
302 // osArchTypeMap maps OsTypes to the list of supported ArchTypes for that OS.
303 osArchTypeMap = map[OsType][]ArchType{}
304
305 // NoOsType is a placeholder for when no OS is needed.
306 NoOsType OsType
307 // Linux is the OS for the Linux kernel plus the glibc runtime.
308 Linux = newOsType("linux_glibc", Host, false, X86, X86_64)
Colin Cross528d67e2021-07-23 22:23:07 +0000309 // LinuxMusl is the OS for the Linux kernel plus the musl runtime.
Colin Crossa9b2aac2022-06-15 17:25:51 -0700310 LinuxMusl = newOsType("linux_musl", Host, false, X86, X86_64, Arm64, Arm)
Colin Crossa6845402020-11-16 15:08:19 -0800311 // Darwin is the OS for MacOS/Darwin host machines.
Dan Willemsen8528f4e2021-10-19 00:22:06 -0700312 Darwin = newOsType("darwin", Host, false, Arm64, X86_64)
Colin Crossa6845402020-11-16 15:08:19 -0800313 // LinuxBionic is the OS for the Linux kernel plus the Bionic libc runtime, but without the
314 // rest of Android.
315 LinuxBionic = newOsType("linux_bionic", Host, false, Arm64, X86_64)
316 // Windows the OS for Windows host machines.
317 Windows = newOsType("windows", Host, true, X86, X86_64)
318 // Android is the OS for target devices that run all of Android, including the Linux kernel
319 // and the Bionic libc runtime.
320 Android = newOsType("android", Device, false, Arm, Arm64, X86, X86_64)
Colin Crossa6845402020-11-16 15:08:19 -0800321
322 // CommonOS is a pseudo OSType for a common OS variant, which is OsType agnostic and which
323 // has dependencies on all the OS variants.
324 CommonOS = newOsType("common_os", Generic, false)
Colin Crosse9fe2942020-11-10 18:12:15 -0800325
326 // CommonArch is the Arch for all modules that are os-specific but not arch specific,
327 // for example most Java modules.
328 CommonArch = Arch{ArchType: Common}
dimitry1f33e402019-03-26 12:39:31 +0100329)
330
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000331// OsTypeList returns a slice copy of the supported OsTypes.
332func OsTypeList() []OsType {
333 return append([]OsType(nil), osTypeList...)
334}
335
Colin Crossa6845402020-11-16 15:08:19 -0800336// Target specifies the OS and architecture that a module is being compiled for.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700337type Target struct {
Colin Crossa6845402020-11-16 15:08:19 -0800338 // Os the OS that the module is being compiled for (e.g. "linux_glibc", "android").
339 Os OsType
340 // Arch is the architecture that the module is being compiled for.
341 Arch Arch
342 // NativeBridge is NativeBridgeEnabled if the architecture is supported using NativeBridge
343 // (i.e. arm on x86) for this device.
344 NativeBridge NativeBridgeSupport
345 // NativeBridgeHostArchName is the name of the real architecture that is used to implement
346 // the NativeBridge architecture. For example, for arm on x86 this would be "x86".
dimitry8d6dde82019-07-11 10:23:53 +0200347 NativeBridgeHostArchName string
Colin Crossa6845402020-11-16 15:08:19 -0800348 // NativeBridgeRelativePath is the name of the subdirectory that will contain NativeBridge
349 // libraries and binaries.
dimitry8d6dde82019-07-11 10:23:53 +0200350 NativeBridgeRelativePath string
Jiyong Park1613e552020-09-14 19:43:17 +0900351
352 // HostCross is true when the target cannot run natively on the current build host.
353 // For example, linux_glibc_x86 returns true on a regular x86/i686/Linux machines, but returns false
354 // on Mac (different OS), or on 64-bit only i686/Linux machines (unsupported arch).
355 HostCross bool
Colin Crossd3ba0392015-05-07 14:11:29 -0700356}
357
Colin Crossa6845402020-11-16 15:08:19 -0800358// NativeBridgeSupport is an enum that specifies if a Target supports NativeBridge.
359type NativeBridgeSupport bool
360
361const (
362 NativeBridgeDisabled NativeBridgeSupport = false
363 NativeBridgeEnabled NativeBridgeSupport = true
364)
365
366// String returns the OS and arch variations used for the Target.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700367func (target Target) String() string {
Colin Crossa195f912019-10-16 11:07:20 -0700368 return target.OsVariation() + "_" + target.ArchVariation()
369}
370
Colin Crossa6845402020-11-16 15:08:19 -0800371// OsVariation returns the name of the variation used by the osMutator for the Target.
Colin Crossa195f912019-10-16 11:07:20 -0700372func (target Target) OsVariation() string {
373 return target.Os.String()
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700374}
375
Colin Crossa6845402020-11-16 15:08:19 -0800376// ArchVariation returns the name of the variation used by the archMutator for the Target.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700377func (target Target) ArchVariation() string {
378 var variation string
dimitry1f33e402019-03-26 12:39:31 +0100379 if target.NativeBridge {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700380 variation = "native_bridge_"
dimitry1f33e402019-03-26 12:39:31 +0100381 }
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700382 variation += target.Arch.String()
383
Colin Crossa195f912019-10-16 11:07:20 -0700384 return variation
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700385}
386
Colin Crossa6845402020-11-16 15:08:19 -0800387// Variations returns a list of blueprint.Variations for the osMutator and archMutator for the
388// Target.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700389func (target Target) Variations() []blueprint.Variation {
390 return []blueprint.Variation{
Colin Crossa195f912019-10-16 11:07:20 -0700391 {Mutator: "os", Variation: target.OsVariation()},
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700392 {Mutator: "arch", Variation: target.ArchVariation()},
393 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800394}
395
Colin Crossa6845402020-11-16 15:08:19 -0800396// osMutator splits an arch-specific module into a variant for each OS that is enabled for the
397// module. It uses the HostOrDevice value passed to InitAndroidArchModule and the
398// device_supported and host_supported properties to determine which OsTypes are enabled for this
399// module, then searches through the Targets to determine which have enabled Targets for this
400// module.
Colin Cross617b88a2020-08-24 18:04:09 -0700401func osMutator(bpctx blueprint.BottomUpMutatorContext) {
Colin Crossa195f912019-10-16 11:07:20 -0700402 var module Module
403 var ok bool
Colin Cross617b88a2020-08-24 18:04:09 -0700404 if module, ok = bpctx.Module().(Module); !ok {
Colin Crossa6845402020-11-16 15:08:19 -0800405 // The module is not a Soong module, it is a Blueprint module.
Colin Cross617b88a2020-08-24 18:04:09 -0700406 if bootstrap.IsBootstrapModule(bpctx.Module()) {
407 // Bootstrap Go modules are always the build OS or linux bionic.
408 config := bpctx.Config().(Config)
409 osNames := []string{config.BuildOSTarget.OsVariation()}
410 for _, hostCrossTarget := range config.Targets[LinuxBionic] {
411 if hostCrossTarget.Arch.ArchType == config.BuildOSTarget.Arch.ArchType {
412 osNames = append(osNames, hostCrossTarget.OsVariation())
413 }
414 }
415 osNames = FirstUniqueStrings(osNames)
416 bpctx.CreateVariations(osNames...)
417 }
Colin Crossa195f912019-10-16 11:07:20 -0700418 return
419 }
420
Colin Cross617b88a2020-08-24 18:04:09 -0700421 // Bootstrap Go module support above requires this mutator to be a
422 // blueprint.BottomUpMutatorContext because android.BottomUpMutatorContext
423 // filters out non-Soong modules. Now that we've handled them, create a
424 // normal android.BottomUpMutatorContext.
Liz Kammer356f7d42021-01-26 09:18:53 -0500425 mctx := bottomUpMutatorContextFactory(bpctx, module, false, false)
Colin Cross617b88a2020-08-24 18:04:09 -0700426
Colin Crossa195f912019-10-16 11:07:20 -0700427 base := module.base()
428
Colin Crossa6845402020-11-16 15:08:19 -0800429 // Nothing to do for modules that are not architecture specific (e.g. a genrule).
Colin Crossa195f912019-10-16 11:07:20 -0700430 if !base.ArchSpecific() {
431 return
432 }
433
Colin Crossa6845402020-11-16 15:08:19 -0800434 // Collect a list of OSTypes supported by this module based on the HostOrDevice value
435 // passed to InitAndroidArchModule and the device_supported and host_supported properties.
Colin Crossa195f912019-10-16 11:07:20 -0700436 var moduleOSList []OsType
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000437 for _, os := range osTypeList {
Jiyong Park1613e552020-09-14 19:43:17 +0900438 for _, t := range mctx.Config().Targets[os] {
Colin Cross08d6f8f2020-11-19 02:33:19 +0000439 if base.supportsTarget(t) {
Jiyong Park1613e552020-09-14 19:43:17 +0900440 moduleOSList = append(moduleOSList, os)
441 break
Colin Crossa195f912019-10-16 11:07:20 -0700442 }
443 }
Colin Crossa195f912019-10-16 11:07:20 -0700444 }
445
Colin Crossa6845402020-11-16 15:08:19 -0800446 // If there are no supported OSes then disable the module.
Colin Crossa195f912019-10-16 11:07:20 -0700447 if len(moduleOSList) == 0 {
Inseob Kimeec88e12020-01-22 11:11:29 +0900448 base.Disable()
Colin Crossa195f912019-10-16 11:07:20 -0700449 return
450 }
451
Colin Crossa6845402020-11-16 15:08:19 -0800452 // Convert the list of supported OsTypes to the variation names.
Colin Crossa195f912019-10-16 11:07:20 -0700453 osNames := make([]string, len(moduleOSList))
Colin Crossa195f912019-10-16 11:07:20 -0700454 for i, os := range moduleOSList {
455 osNames[i] = os.String()
456 }
457
Paul Duffin1356d8c2020-02-25 19:26:33 +0000458 createCommonOSVariant := base.commonProperties.CreateCommonOSVariant
459 if createCommonOSVariant {
Colin Crossa6845402020-11-16 15:08:19 -0800460 // A CommonOS variant was requested so add it to the list of OS variants to
Paul Duffin1356d8c2020-02-25 19:26:33 +0000461 // create. It needs to be added to the end because it needs to depend on the
462 // the other variants in the list returned by CreateVariations(...) and inter
463 // variant dependencies can only be created from a later variant in that list to
464 // an earlier one. That is because variants are always processed in the order in
465 // which they are returned from CreateVariations(...).
466 osNames = append(osNames, CommonOS.Name)
467 moduleOSList = append(moduleOSList, CommonOS)
Colin Crossa195f912019-10-16 11:07:20 -0700468 }
469
Colin Crossa6845402020-11-16 15:08:19 -0800470 // Create the variations, annotate each one with which OS it was created for, and
471 // squash the appropriate OS-specific properties into the top level properties.
Paul Duffin1356d8c2020-02-25 19:26:33 +0000472 modules := mctx.CreateVariations(osNames...)
473 for i, m := range modules {
474 m.base().commonProperties.CompileOS = moduleOSList[i]
475 m.base().setOSProperties(mctx)
476 }
477
478 if createCommonOSVariant {
479 // A CommonOS variant was requested so add dependencies from it (the last one in
480 // the list) to the OS type specific variants.
481 last := len(modules) - 1
482 commonOSVariant := modules[last]
483 commonOSVariant.base().commonProperties.CommonOSVariant = true
484 for _, module := range modules[0:last] {
485 // Ignore modules that are enabled. Note, this will only avoid adding
486 // dependencies on OsType variants that are explicitly disabled in their
487 // properties. The CommonOS variant will still depend on disabled variants
488 // if they are disabled afterwards, e.g. in archMutator if
489 if module.Enabled() {
490 mctx.AddInterVariantDependency(commonOsToOsSpecificVariantTag, commonOSVariant, module)
491 }
492 }
493 }
494}
495
Colin Crossc179ea62020-10-09 10:54:15 -0700496type archDepTag struct {
497 blueprint.BaseDependencyTag
498 name string
499}
Paul Duffin1356d8c2020-02-25 19:26:33 +0000500
Colin Crossc179ea62020-10-09 10:54:15 -0700501// Identifies the dependency from CommonOS variant to the os specific variants.
502var commonOsToOsSpecificVariantTag = archDepTag{name: "common os to os specific"}
503
Paul Duffin1356d8c2020-02-25 19:26:33 +0000504// Get the OsType specific variants for the current CommonOS variant.
505//
506// The returned list will only contain enabled OsType specific variants of the
507// module referenced in the supplied context. An empty list is returned if there
508// are no enabled variants or the supplied context is not for an CommonOS
509// variant.
510func GetOsSpecificVariantsOfCommonOSVariant(mctx BaseModuleContext) []Module {
511 var variants []Module
512 mctx.VisitDirectDeps(func(m Module) {
513 if mctx.OtherModuleDependencyTag(m) == commonOsToOsSpecificVariantTag {
514 if m.Enabled() {
515 variants = append(variants, m)
516 }
517 }
518 })
Paul Duffin1356d8c2020-02-25 19:26:33 +0000519 return variants
Colin Crossa195f912019-10-16 11:07:20 -0700520}
521
Dan Willemsen47450072021-10-19 20:24:49 -0700522var DarwinUniversalVariantTag = archDepTag{name: "darwin universal binary"}
523
Colin Crossee0bc3b2018-10-02 22:01:37 -0700524// archMutator splits a module into a variant for each Target requested by the module. Target selection
Colin Crossa6845402020-11-16 15:08:19 -0800525// for a module is in three levels, OsClass, multilib, and then Target.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700526// OsClass selection is determined by:
527// - The HostOrDeviceSupported value passed in to InitAndroidArchModule by the module type factory, which selects
528// whether the module type can compile for host, device or both.
529// - The host_supported and device_supported properties on the module.
Roland Levillainf5b635d2019-06-05 14:42:57 +0100530// 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 -0700531// for the module, the Device OsClass is selected.
532// Within each selected OsClass, the multilib selection is determined by:
Jaewoong Jung02b2d4d2019-06-06 15:19:57 -0700533// - The compile_multilib property if it set (which may be overridden by target.android.compile_multilib or
Colin Crossee0bc3b2018-10-02 22:01:37 -0700534// target.host.compile_multilib).
535// - The default multilib passed to InitAndroidArchModule if compile_multilib was not set.
536// Valid multilib values include:
537// "both": compile for all Targets supported by the OsClass (generally x86_64 and x86, or arm64 and arm).
538// "first": compile for only a single preferred Target supported by the OsClass. This is generally x86_64 or arm64,
Elliott Hughes79ae3412020-04-17 15:49:49 -0700539// but may be arm for a 32-bit only build.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700540// "32": compile for only a single 32-bit Target supported by the OsClass.
541// "64": compile for only a single 64-bit Target supported by the OsClass.
Colin Crossa6845402020-11-16 15:08:19 -0800542// "common": compile a for a single Target that will work on all Targets supported by the OsClass (for example Java).
543// "common_first": compile a for a Target that will work on all Targets supported by the OsClass
544// (same as "common"), plus a second Target for the preferred Target supported by the OsClass
545// (same as "first"). This is used for java_binary that produces a common .jar and a wrapper
546// executable script.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700547//
548// Once the list of Targets is determined, the module is split into a variant for each Target.
549//
550// Modules can be initialized with InitAndroidMultiTargetsArchModule, in which case they will be split by OsClass,
551// 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 -0700552func archMutator(bpctx blueprint.BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700553 var module Module
Colin Cross3f40fa42015-01-30 17:27:36 -0800554 var ok bool
Colin Cross617b88a2020-08-24 18:04:09 -0700555 if module, ok = bpctx.Module().(Module); !ok {
556 if bootstrap.IsBootstrapModule(bpctx.Module()) {
557 // Bootstrap Go modules are always the build architecture.
558 bpctx.CreateVariations(bpctx.Config().(Config).BuildOSTarget.ArchVariation())
559 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800560 return
561 }
562
Colin Cross617b88a2020-08-24 18:04:09 -0700563 // Bootstrap Go module support above requires this mutator to be a
564 // blueprint.BottomUpMutatorContext because android.BottomUpMutatorContext
565 // filters out non-Soong modules. Now that we've handled them, create a
566 // normal android.BottomUpMutatorContext.
Liz Kammer356f7d42021-01-26 09:18:53 -0500567 mctx := bottomUpMutatorContextFactory(bpctx, module, false, false)
Colin Cross617b88a2020-08-24 18:04:09 -0700568
Colin Cross5eca7cb2018-10-02 14:02:10 -0700569 base := module.base()
570
571 if !base.ArchSpecific() {
Colin Crossb9db4802016-06-03 01:50:47 +0000572 return
573 }
574
Colin Crossa195f912019-10-16 11:07:20 -0700575 os := base.commonProperties.CompileOS
Paul Duffin1356d8c2020-02-25 19:26:33 +0000576 if os == CommonOS {
577 // Make sure that the target related properties are initialized for the
578 // CommonOS variant.
579 addTargetProperties(module, commonTargetMap[os.Name], nil, true)
580
581 // Do not create arch specific variants for the CommonOS variant.
582 return
583 }
584
Colin Crossa195f912019-10-16 11:07:20 -0700585 osTargets := mctx.Config().Targets[os]
Colin Crossfb0c16e2019-11-20 17:12:35 -0800586 image := base.commonProperties.ImageVariation
Colin Crossa6845402020-11-16 15:08:19 -0800587 // Filter NativeBridge targets unless they are explicitly supported.
588 // Skip creating native bridge variants for non-core modules.
Paul Duffine3d1ae42021-09-03 17:47:17 +0100589 if os == Android && !(base.IsNativeBridgeSupported() && image == CoreVariation) {
Colin Cross83bead42019-12-18 10:45:46 -0800590
Colin Crossa195f912019-10-16 11:07:20 -0700591 var targets []Target
592 for _, t := range osTargets {
593 if !t.NativeBridge {
594 targets = append(targets, t)
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700595 }
596 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700597
Colin Crossa195f912019-10-16 11:07:20 -0700598 osTargets = targets
599 }
Colin Crossee0bc3b2018-10-02 22:01:37 -0700600
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700601 // only the primary arch in the ramdisk / vendor_ramdisk / recovery partition
Inseob Kim08758f02021-04-08 21:13:22 +0900602 if os == Android && (module.InstallInRecovery() || module.InstallInRamdisk() || module.InstallInVendorRamdisk() || module.InstallInDebugRamdisk()) {
Colin Crossa195f912019-10-16 11:07:20 -0700603 osTargets = []Target{osTargets[0]}
604 }
dimitry1f33e402019-03-26 12:39:31 +0100605
Jaewoong Jung003d8082021-02-24 17:39:54 -0800606 // Windows builds always prefer 32-bit
607 prefer32 := os == Windows
dimitry1f33e402019-03-26 12:39:31 +0100608
Colin Crossa6845402020-11-16 15:08:19 -0800609 // Determine the multilib selection for this module.
Christopher Ferris98f10222022-07-13 23:16:52 -0700610 ignorePrefer32OnDevice := mctx.Config().IgnorePrefer32OnDevice()
611 multilib, extraMultilib := decodeMultilib(base, os, ignorePrefer32OnDevice)
Colin Crossa6845402020-11-16 15:08:19 -0800612
613 // Convert the multilib selection into a list of Targets.
Colin Crossa195f912019-10-16 11:07:20 -0700614 targets, err := decodeMultilibTargets(multilib, osTargets, prefer32)
615 if err != nil {
616 mctx.ModuleErrorf("%s", err.Error())
617 }
Colin Cross5eca7cb2018-10-02 14:02:10 -0700618
Colin Crossa6845402020-11-16 15:08:19 -0800619 // If the module is using extraMultilib, decode the extraMultilib selection into
620 // a separate list of Targets.
Colin Crossa195f912019-10-16 11:07:20 -0700621 var multiTargets []Target
622 if extraMultilib != "" {
623 multiTargets, err = decodeMultilibTargets(extraMultilib, osTargets, prefer32)
Colin Crossa1ad8d12016-06-01 17:09:44 -0700624 if err != nil {
625 mctx.ModuleErrorf("%s", err.Error())
626 }
Colin Crossb9db4802016-06-03 01:50:47 +0000627 }
628
Colin Crossa6845402020-11-16 15:08:19 -0800629 // Recovery is always the primary architecture, filter out any other architectures.
Inseob Kim20fb5d42021-02-02 20:07:58 +0900630 // Common arch is also allowed
Colin Crossfb0c16e2019-11-20 17:12:35 -0800631 if image == RecoveryVariation {
632 primaryArch := mctx.Config().DevicePrimaryArchType()
Inseob Kim20fb5d42021-02-02 20:07:58 +0900633 targets = filterToArch(targets, primaryArch, Common)
634 multiTargets = filterToArch(multiTargets, primaryArch, Common)
Colin Crossfb0c16e2019-11-20 17:12:35 -0800635 }
636
Colin Crossa6845402020-11-16 15:08:19 -0800637 // If there are no supported targets disable the module.
Colin Crossa195f912019-10-16 11:07:20 -0700638 if len(targets) == 0 {
Inseob Kimeec88e12020-01-22 11:11:29 +0900639 base.Disable()
Dan Willemsen3f32f032016-07-11 14:36:48 -0700640 return
641 }
642
Colin Crossa6845402020-11-16 15:08:19 -0800643 // Convert the targets into a list of arch variation names.
Colin Crossa195f912019-10-16 11:07:20 -0700644 targetNames := make([]string, len(targets))
Colin Crossa195f912019-10-16 11:07:20 -0700645 for i, target := range targets {
646 targetNames[i] = target.ArchVariation()
Colin Crossa1ad8d12016-06-01 17:09:44 -0700647 }
648
Colin Crossa6845402020-11-16 15:08:19 -0800649 // Create the variations, annotate each one with which Target it was created for, and
650 // squash the appropriate arch-specific properties into the top level properties.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700651 modules := mctx.CreateVariations(targetNames...)
Colin Cross3f40fa42015-01-30 17:27:36 -0800652 for i, m := range modules {
Paul Duffin1356d8c2020-02-25 19:26:33 +0000653 addTargetProperties(m, targets[i], multiTargets, i == 0)
Colin Cross617b88a2020-08-24 18:04:09 -0700654 m.base().setArchProperties(mctx)
Dan Willemsen8528f4e2021-10-19 00:22:06 -0700655
656 // Install support doesn't understand Darwin+Arm64
657 if os == Darwin && targets[i].HostCross {
658 m.base().commonProperties.SkipInstall = true
659 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800660 }
Dan Willemsen47450072021-10-19 20:24:49 -0700661
662 // Create a dependency for Darwin Universal binaries from the primary to secondary
663 // architecture. The module itself will be responsible for calling lipo to merge the outputs.
664 if os == Darwin {
665 if multilib == "darwin_universal" && len(modules) == 2 {
666 mctx.AddInterVariantDependency(DarwinUniversalVariantTag, modules[1], modules[0])
667 } else if multilib == "darwin_universal_common_first" && len(modules) == 3 {
668 mctx.AddInterVariantDependency(DarwinUniversalVariantTag, modules[2], modules[1])
669 }
670 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800671}
672
Colin Crossa6845402020-11-16 15:08:19 -0800673// addTargetProperties annotates a variant with the Target is is being compiled for, the list
674// of additional Targets it is supporting (if any), and whether it is the primary Target for
675// the module.
Paul Duffin1356d8c2020-02-25 19:26:33 +0000676func addTargetProperties(m Module, target Target, multiTargets []Target, primaryTarget bool) {
677 m.base().commonProperties.CompileTarget = target
678 m.base().commonProperties.CompileMultiTargets = multiTargets
679 m.base().commonProperties.CompilePrimary = primaryTarget
680}
681
Colin Crossa6845402020-11-16 15:08:19 -0800682// decodeMultilib returns the appropriate compile_multilib property for the module, or the default
683// multilib from the factory's call to InitAndroidArchModule if none was set. For modules that
684// called InitAndroidMultiTargetsArchModule it always returns "common" for multilib, and returns
685// the actual multilib in extraMultilib.
Christopher Ferris98f10222022-07-13 23:16:52 -0700686func decodeMultilib(base *ModuleBase, os OsType, ignorePrefer32OnDevice bool) (multilib, extraMultilib string) {
Colin Crossa6845402020-11-16 15:08:19 -0800687 // First check the "android.compile_multilib" or "host.compile_multilib" properties.
Dan Willemsen47450072021-10-19 20:24:49 -0700688 switch os.Class {
Colin Crossee0bc3b2018-10-02 22:01:37 -0700689 case Device:
690 multilib = String(base.commonProperties.Target.Android.Compile_multilib)
Jiyong Park1613e552020-09-14 19:43:17 +0900691 case Host:
Colin Crossee0bc3b2018-10-02 22:01:37 -0700692 multilib = String(base.commonProperties.Target.Host.Compile_multilib)
693 }
Colin Crossa6845402020-11-16 15:08:19 -0800694
695 // If those aren't set, try the "compile_multilib" property.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700696 if multilib == "" {
697 multilib = String(base.commonProperties.Compile_multilib)
698 }
Colin Crossa6845402020-11-16 15:08:19 -0800699
700 // If that wasn't set, use the default multilib set by the factory.
Colin Crossee0bc3b2018-10-02 22:01:37 -0700701 if multilib == "" {
702 multilib = base.commonProperties.Default_multilib
703 }
704
Christopher Ferris98f10222022-07-13 23:16:52 -0700705 // If a device is configured with multiple targets, this option
706 // force all device targets that prefer32 to be compiled only as
707 // the first target.
708 if ignorePrefer32OnDevice && os.Class == Device && (multilib == "prefer32" || multilib == "first_prefer32") {
709 multilib = "first"
710 }
711
Colin Crossee0bc3b2018-10-02 22:01:37 -0700712 if base.commonProperties.UseTargetVariants {
Dan Willemsen47450072021-10-19 20:24:49 -0700713 // Darwin has the concept of "universal binaries" which is implemented in Soong by
714 // building both x86_64 and arm64 variants, and having select module types know how to
715 // merge the outputs of their corresponding variants together into a final binary. Most
716 // module types don't need to understand this logic, as we only build a small portion
717 // of the tree for Darwin, and only module types writing macho files need to do the
718 // merging.
719 //
720 // This logic is not enabled for:
721 // "common", as it's not an arch-specific variant
722 // "32", as Darwin never has a 32-bit variant
723 // !UseTargetVariants, as the module has opted into handling the arch-specific logic on
724 // its own.
725 if os == Darwin && multilib != "common" && multilib != "32" {
726 if multilib == "common_first" {
727 multilib = "darwin_universal_common_first"
728 } else {
729 multilib = "darwin_universal"
730 }
731 }
732
Colin Crossee0bc3b2018-10-02 22:01:37 -0700733 return multilib, ""
734 } else {
735 // For app modules a single arch variant will be created per OS class which is expected to handle all the
736 // selected arches. Return the common-type as multilib and any Android.bp provided multilib as extraMultilib
737 if multilib == base.commonProperties.Default_multilib {
738 multilib = "first"
739 }
740 return base.commonProperties.Default_multilib, multilib
741 }
742}
743
Colin Crossa6845402020-11-16 15:08:19 -0800744// filterToArch takes a list of Targets and an ArchType, and returns a modified list that contains
Inseob Kim20fb5d42021-02-02 20:07:58 +0900745// only Targets that have the specified ArchTypes.
746func filterToArch(targets []Target, archs ...ArchType) []Target {
Colin Crossfb0c16e2019-11-20 17:12:35 -0800747 for i := 0; i < len(targets); i++ {
Inseob Kim20fb5d42021-02-02 20:07:58 +0900748 found := false
749 for _, arch := range archs {
750 if targets[i].Arch.ArchType == arch {
751 found = true
752 break
753 }
754 }
755 if !found {
Colin Crossfb0c16e2019-11-20 17:12:35 -0800756 targets = append(targets[:i], targets[i+1:]...)
757 i--
758 }
759 }
760 return targets
761}
762
Colin Crossa6845402020-11-16 15:08:19 -0800763// archPropRoot is a struct type used as the top level of the arch-specific properties. It
764// contains the "arch", "multilib", and "target" property structs. It is used to split up the
765// property structs to limit how much is allocated when a single arch-specific property group is
766// used. The types are interface{} because they will hold instances of runtime-created types.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800767type archPropRoot struct {
768 Arch, Multilib, Target interface{}
769}
770
Colin Crossa6845402020-11-16 15:08:19 -0800771// archPropTypeDesc holds the runtime-created types for the property structs to instantiate to
772// create an archPropRoot property struct.
773type archPropTypeDesc struct {
774 arch, multilib, target reflect.Type
775}
776
Colin Crosscbbd13f2020-01-17 14:08:22 -0800777// createArchPropTypeDesc takes a reflect.Type that is either a struct or a pointer to a struct, and
778// returns lists of reflect.Types that contains the arch-variant properties inside structs for each
779// arch, multilib and target property.
Colin Crossa6845402020-11-16 15:08:19 -0800780//
781// This is a relatively expensive operation, so the results are cached in the global
782// archPropTypeMap. It is constructed entirely based on compile-time data, so there is no need
783// to isolate the results between multiple tests running in parallel.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800784func createArchPropTypeDesc(props reflect.Type) []archPropTypeDesc {
Colin Crossb1d8c992020-01-21 11:43:29 -0800785 // Each property struct shard will be nested many times under the runtime generated arch struct,
786 // which can hit the limit of 64kB for the name of runtime generated structs. They are nested
787 // 97 times now, which may grow in the future, plus there is some overhead for the containing
788 // type. This number may need to be reduced if too many are added, but reducing it too far
789 // could cause problems if a single deeply nested property no longer fits in the name.
790 const maxArchTypeNameSize = 500
791
Colin Crossa6845402020-11-16 15:08:19 -0800792 // Convert the type to a new set of types that contains only the arch-specific properties
Usta Shrestha0b52d832022-02-04 21:37:39 -0500793 // (those that are tagged with `android:"arch_variant"`), and sharded into multiple types
Colin Crossa6845402020-11-16 15:08:19 -0800794 // to keep the runtime-generated names under the limit.
Colin Crossb1d8c992020-01-21 11:43:29 -0800795 propShards, _ := proptools.FilterPropertyStructSharded(props, maxArchTypeNameSize, filterArchStruct)
Colin Crossa6845402020-11-16 15:08:19 -0800796
797 // If the type has no arch-specific properties there is nothing to do.
Colin Crosscb988072019-01-24 14:58:11 -0800798 if len(propShards) == 0 {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700799 return nil
800 }
801
Colin Crosscbbd13f2020-01-17 14:08:22 -0800802 var ret []archPropTypeDesc
Colin Crossc17727d2018-10-24 12:42:09 -0700803 for _, props := range propShards {
Dan Willemsenb1957a52016-06-23 23:44:54 -0700804
Colin Crossa6845402020-11-16 15:08:19 -0800805 // variantFields takes a list of variant property field names and returns a list the
806 // StructFields with the names and the type of the current shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700807 variantFields := func(names []string) []reflect.StructField {
808 ret := make([]reflect.StructField, len(names))
Dan Willemsenb1957a52016-06-23 23:44:54 -0700809
Colin Crossc17727d2018-10-24 12:42:09 -0700810 for i, name := range names {
811 ret[i].Name = name
812 ret[i].Type = props
Dan Willemsen866b5632017-09-22 12:28:24 -0700813 }
Colin Crossc17727d2018-10-24 12:42:09 -0700814
815 return ret
816 }
817
Colin Crossa6845402020-11-16 15:08:19 -0800818 // Create a type that contains the properties in this shard repeated for each
819 // architecture, architecture variant, and architecture feature.
Colin Crossc17727d2018-10-24 12:42:09 -0700820 archFields := make([]reflect.StructField, len(archTypeList))
821 for i, arch := range archTypeList {
Colin Crossa6845402020-11-16 15:08:19 -0800822 var variants []string
Colin Crossc17727d2018-10-24 12:42:09 -0700823
824 for _, archVariant := range archVariants[arch] {
825 archVariant := variantReplacer.Replace(archVariant)
826 variants = append(variants, proptools.FieldNameForProperty(archVariant))
827 }
Liz Kammer2c2afe22022-02-11 11:35:03 -0500828 for _, cpuVariant := range cpuVariants[arch] {
829 cpuVariant := variantReplacer.Replace(cpuVariant)
830 variants = append(variants, proptools.FieldNameForProperty(cpuVariant))
831 }
Colin Crossc17727d2018-10-24 12:42:09 -0700832 for _, feature := range archFeatures[arch] {
833 feature := variantReplacer.Replace(feature)
834 variants = append(variants, proptools.FieldNameForProperty(feature))
835 }
836
Colin Crossa6845402020-11-16 15:08:19 -0800837 // Create the StructFields for each architecture variant architecture feature
838 // (e.g. "arch.arm.cortex-a53" or "arch.arm.neon").
Colin Crossc17727d2018-10-24 12:42:09 -0700839 fields := variantFields(variants)
840
Colin Crossa6845402020-11-16 15:08:19 -0800841 // Create the StructField for the architecture itself (e.g. "arch.arm"). The special
842 // "BlueprintEmbed" name is used by Blueprint to put the properties in the
843 // parent struct.
Colin Crossc17727d2018-10-24 12:42:09 -0700844 fields = append([]reflect.StructField{{
845 Name: "BlueprintEmbed",
846 Type: props,
847 Anonymous: true,
848 }}, fields...)
849
850 archFields[i] = reflect.StructField{
851 Name: arch.Field,
852 Type: reflect.StructOf(fields),
853 }
854 }
Colin Crossa6845402020-11-16 15:08:19 -0800855
856 // Create the type of the "arch" property struct for this shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700857 archType := reflect.StructOf(archFields)
858
Colin Crossa6845402020-11-16 15:08:19 -0800859 // Create the type for the "multilib" property struct for this shard, containing the
860 // "multilib.lib32" and "multilib.lib64" property structs.
Colin Crossc17727d2018-10-24 12:42:09 -0700861 multilibType := reflect.StructOf(variantFields([]string{"Lib32", "Lib64"}))
862
Colin Crossa6845402020-11-16 15:08:19 -0800863 // Start with a list of the special targets
Colin Crossc17727d2018-10-24 12:42:09 -0700864 targets := []string{
865 "Host",
866 "Android64",
867 "Android32",
868 "Bionic",
Colin Cross528d67e2021-07-23 22:23:07 +0000869 "Glibc",
870 "Musl",
Colin Crossc17727d2018-10-24 12:42:09 -0700871 "Linux",
Colin Crossa98d36d2022-03-07 14:39:49 -0800872 "Host_linux",
Colin Crossc17727d2018-10-24 12:42:09 -0700873 "Not_windows",
874 "Arm_on_x86",
875 "Arm_on_x86_64",
Victor Khimenkoc26fcf42020-05-07 22:16:33 +0200876 "Native_bridge",
Colin Crossc17727d2018-10-24 12:42:09 -0700877 }
Jingwen Chen2f6a21e2021-04-05 07:33:05 +0000878 for _, os := range osTypeList {
Colin Crossa6845402020-11-16 15:08:19 -0800879 // Add all the OSes.
Colin Crossc17727d2018-10-24 12:42:09 -0700880 targets = append(targets, os.Field)
881
Colin Crossa6845402020-11-16 15:08:19 -0800882 // Add the OS/Arch combinations, e.g. "android_arm64".
Colin Crossc17727d2018-10-24 12:42:09 -0700883 for _, archType := range osArchTypeMap[os] {
Liz Kammer9abd62d2021-05-21 08:37:59 -0400884 targets = append(targets, GetCompoundTargetField(os, archType))
Colin Crossc17727d2018-10-24 12:42:09 -0700885
Colin Cross1aa45b02022-02-10 10:33:10 -0800886 // Also add the special "linux_<arch>", "bionic_<arch>" , "glibc_<arch>", and
887 // "musl_<arch>" property structs.
Colin Crossc17727d2018-10-24 12:42:09 -0700888 if os.Linux() {
889 target := "Linux_" + archType.Name
890 if !InList(target, targets) {
891 targets = append(targets, target)
892 }
893 }
Colin Crossa98d36d2022-03-07 14:39:49 -0800894 if os.Linux() && os.Class == Host {
895 target := "Host_linux_" + archType.Name
896 if !InList(target, targets) {
897 targets = append(targets, target)
898 }
899 }
Colin Crossc17727d2018-10-24 12:42:09 -0700900 if os.Bionic() {
901 target := "Bionic_" + archType.Name
902 if !InList(target, targets) {
903 targets = append(targets, target)
904 }
Dan Willemsen866b5632017-09-22 12:28:24 -0700905 }
Colin Cross1aa45b02022-02-10 10:33:10 -0800906 if os == Linux {
907 target := "Glibc_" + archType.Name
908 if !InList(target, targets) {
909 targets = append(targets, target)
910 }
911 }
912 if os == LinuxMusl {
913 target := "Musl_" + archType.Name
914 if !InList(target, targets) {
915 targets = append(targets, target)
916 }
917 }
Dan Willemsen866b5632017-09-22 12:28:24 -0700918 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700919 }
Dan Willemsenb1957a52016-06-23 23:44:54 -0700920
Colin Crossa6845402020-11-16 15:08:19 -0800921 // Create the type for the "target" property struct for this shard.
Colin Crossc17727d2018-10-24 12:42:09 -0700922 targetType := reflect.StructOf(variantFields(targets))
Colin Crosscbbd13f2020-01-17 14:08:22 -0800923
Colin Crossa6845402020-11-16 15:08:19 -0800924 // Return a descriptor of the 3 runtime-created types.
Colin Crosscbbd13f2020-01-17 14:08:22 -0800925 ret = append(ret, archPropTypeDesc{
926 arch: reflect.PtrTo(archType),
927 multilib: reflect.PtrTo(multilibType),
928 target: reflect.PtrTo(targetType),
929 })
Colin Crossc17727d2018-10-24 12:42:09 -0700930 }
931 return ret
Dan Willemsenb1957a52016-06-23 23:44:54 -0700932}
933
Colin Crossa6845402020-11-16 15:08:19 -0800934// variantReplacer converts architecture variant or architecture feature names into names that
935// are valid for an Android.bp file.
936var variantReplacer = strings.NewReplacer("-", "_", ".", "_")
937
938// filterArchStruct returns true if the given field is an architecture specific property.
Colin Cross74449102019-09-25 11:26:40 -0700939func filterArchStruct(field reflect.StructField, prefix string) (bool, reflect.StructField) {
940 if proptools.HasTag(field, "android", "arch_variant") {
941 // The arch_variant field isn't necessary past this point
942 // Instead of wasting space, just remove it. Go also has a
943 // 16-bit limit on structure name length. The name is constructed
944 // based on the Go source representation of the structure, so
945 // the tag names count towards that length.
Colin Crossb4fecbf2020-01-21 11:38:47 -0800946
947 androidTag := field.Tag.Get("android")
948 values := strings.Split(androidTag, ",")
949
950 if string(field.Tag) != `android:"`+strings.Join(values, ",")+`"` {
951 panic(fmt.Errorf("unexpected tag format %q", field.Tag))
Colin Cross74449102019-09-25 11:26:40 -0700952 }
Colin Crossb4fecbf2020-01-21 11:38:47 -0800953 // these tags don't need to be present in the runtime generated struct type.
Liz Kammerff966b12022-07-29 10:49:16 -0400954 values = RemoveListFromList(values, []string{"arch_variant", "variant_prepend", "path"})
955 if len(values) > 0 {
Colin Crossb4fecbf2020-01-21 11:38:47 -0800956 panic(fmt.Errorf("unknown tags %q in field %q", values, prefix+field.Name))
957 }
958
Liz Kammerff966b12022-07-29 10:49:16 -0400959 field.Tag = ``
Colin Cross74449102019-09-25 11:26:40 -0700960 return true, field
961 }
962 return false, field
963}
964
Colin Crossa6845402020-11-16 15:08:19 -0800965// archPropTypeMap contains a cache of the results of createArchPropTypeDesc for each type. It is
966// shared across all Contexts, but is constructed based only on compile-time information so there
967// is no risk of contaminating one Context with data from another.
Dan Willemsenb1957a52016-06-23 23:44:54 -0700968var archPropTypeMap OncePer
969
Colin Crossa6845402020-11-16 15:08:19 -0800970// initArchModule adds the architecture-specific property structs to a Module.
971func initArchModule(m Module) {
Colin Cross3f40fa42015-01-30 17:27:36 -0800972
973 base := m.base()
974
Ustaeabf0f32021-12-06 15:17:23 -0500975 if len(base.archProperties) != 0 {
976 panic(fmt.Errorf("module %s already has archProperties", m.Name()))
977 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800978
Ustaeabf0f32021-12-06 15:17:23 -0500979 getStructType := func(properties interface{}) reflect.Type {
Colin Cross3f40fa42015-01-30 17:27:36 -0800980 propertiesValue := reflect.ValueOf(properties)
Colin Cross62496a02016-08-08 15:49:17 -0700981 t := propertiesValue.Type()
Colin Cross3f40fa42015-01-30 17:27:36 -0800982 if propertiesValue.Kind() != reflect.Ptr {
Colin Crossca860ac2016-01-04 14:34:37 -0800983 panic(fmt.Errorf("properties must be a pointer to a struct, got %T",
984 propertiesValue.Interface()))
Colin Cross3f40fa42015-01-30 17:27:36 -0800985 }
986
987 propertiesValue = propertiesValue.Elem()
988 if propertiesValue.Kind() != reflect.Struct {
Ustaeabf0f32021-12-06 15:17:23 -0500989 panic(fmt.Errorf("properties must be a pointer to a struct, got a pointer to %T",
Colin Crossca860ac2016-01-04 14:34:37 -0800990 propertiesValue.Interface()))
Colin Cross3f40fa42015-01-30 17:27:36 -0800991 }
Ustaeabf0f32021-12-06 15:17:23 -0500992 return t
993 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800994
Usta851a3272022-01-05 23:42:33 -0500995 for _, properties := range m.GetProperties() {
Ustaeabf0f32021-12-06 15:17:23 -0500996 t := getStructType(properties)
Colin Crossa6845402020-11-16 15:08:19 -0800997 // Get or create the arch-specific property struct types for this property struct type.
Colin Cross571cccf2019-02-04 11:22:08 -0800998 archPropTypes := archPropTypeMap.Once(NewCustomOnceKey(t), func() interface{} {
Colin Crosscbbd13f2020-01-17 14:08:22 -0800999 return createArchPropTypeDesc(t)
1000 }).([]archPropTypeDesc)
Colin Cross3f40fa42015-01-30 17:27:36 -08001001
Colin Crossa6845402020-11-16 15:08:19 -08001002 // Instantiate one of each arch-specific property struct type and add it to the
1003 // properties for the Module.
Colin Crossc17727d2018-10-24 12:42:09 -07001004 var archProperties []interface{}
1005 for _, t := range archPropTypes {
Colin Crosscbbd13f2020-01-17 14:08:22 -08001006 archProperties = append(archProperties, &archPropRoot{
1007 Arch: reflect.Zero(t.arch).Interface(),
1008 Multilib: reflect.Zero(t.multilib).Interface(),
1009 Target: reflect.Zero(t.target).Interface(),
1010 })
Dan Willemsenb1957a52016-06-23 23:44:54 -07001011 }
Colin Crossc17727d2018-10-24 12:42:09 -07001012 base.archProperties = append(base.archProperties, archProperties)
1013 m.AddProperties(archProperties...)
Colin Cross3f40fa42015-01-30 17:27:36 -08001014 }
1015
Colin Cross3f40fa42015-01-30 17:27:36 -08001016}
1017
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001018func maybeBlueprintEmbed(src reflect.Value) reflect.Value {
Colin Crossa6845402020-11-16 15:08:19 -08001019 // If the value of the field is a struct (as opposed to a pointer to a struct) then step
1020 // into the BlueprintEmbed field.
Dan Willemsenb1957a52016-06-23 23:44:54 -07001021 if src.Kind() == reflect.Struct {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001022 return src.FieldByName("BlueprintEmbed")
1023 } else {
1024 return src
Colin Cross06a931b2015-10-28 17:23:31 -07001025 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001026}
1027
1028// Merges the property struct in srcValue into dst.
Liz Kammerb6dbc872021-05-14 15:14:40 -04001029func mergePropertyStruct(ctx ArchVariantContext, dst interface{}, srcValue reflect.Value) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001030 src := maybeBlueprintEmbed(srcValue).Interface()
Colin Cross06a931b2015-10-28 17:23:31 -07001031
Colin Crossa6845402020-11-16 15:08:19 -08001032 // order checks the `android:"variant_prepend"` tag to handle properties where the
1033 // arch-specific value needs to come before the generic value, for example for lists of
1034 // include directories.
Colin Cross6ee75b62016-05-05 15:57:15 -07001035 order := func(property string,
1036 dstField, srcField reflect.StructField,
1037 dstValue, srcValue interface{}) (proptools.Order, error) {
1038 if proptools.HasTag(dstField, "android", "variant_prepend") {
1039 return proptools.Prepend, nil
1040 } else {
1041 return proptools.Append, nil
1042 }
1043 }
1044
Colin Crossa6845402020-11-16 15:08:19 -08001045 // Squash the located property struct into the destination property struct.
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001046 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src, nil, order)
Colin Cross06a931b2015-10-28 17:23:31 -07001047 if err != nil {
1048 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1049 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1050 } else {
1051 panic(err)
1052 }
1053 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001054}
Colin Cross85a88972015-11-23 13:29:51 -08001055
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001056// Returns the immediate child of the input property struct that corresponds to
1057// the sub-property "field".
Liz Kammerb6dbc872021-05-14 15:14:40 -04001058func getChildPropertyStruct(ctx ArchVariantContext,
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001059 src reflect.Value, field, userFriendlyField string) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001060
1061 // Step into non-nil pointers to structs in the src value.
1062 if src.Kind() == reflect.Ptr {
1063 if src.IsNil() {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001064 return reflect.Value{}, false
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001065 }
1066 src = src.Elem()
1067 }
1068
1069 // Find the requested field in the src struct.
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001070 child := src.FieldByName(proptools.FieldNameForProperty(field))
1071 if !child.IsValid() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001072 ctx.ModuleErrorf("field %q does not exist", userFriendlyField)
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001073 return reflect.Value{}, false
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001074 }
1075
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001076 if child.IsZero() {
1077 return reflect.Value{}, false
1078 }
1079
1080 return child, true
Colin Cross06a931b2015-10-28 17:23:31 -07001081}
1082
Colin Crossa6845402020-11-16 15:08:19 -08001083// Squash the appropriate OS-specific property structs into the matching top level property structs
1084// based on the CompileOS value that was annotated on the variant.
Colin Crossa195f912019-10-16 11:07:20 -07001085func (m *ModuleBase) setOSProperties(ctx BottomUpMutatorContext) {
1086 os := m.commonProperties.CompileOS
1087
Ustadca02192021-12-20 12:56:46 -05001088 for i := range m.archProperties {
Usta851a3272022-01-05 23:42:33 -05001089 genProps := m.GetProperties()[i]
Colin Crossa195f912019-10-16 11:07:20 -07001090 if m.archProperties[i] == nil {
1091 continue
1092 }
1093 for _, archProperties := range m.archProperties[i] {
1094 archPropValues := reflect.ValueOf(archProperties).Elem()
1095
Colin Crosscbbd13f2020-01-17 14:08:22 -08001096 targetProp := archPropValues.FieldByName("Target").Elem()
Colin Crossa195f912019-10-16 11:07:20 -07001097
1098 // Handle host-specific properties in the form:
1099 // target: {
1100 // host: {
1101 // key: value,
1102 // },
1103 // },
Jiyong Park1613e552020-09-14 19:43:17 +09001104 if os.Class == Host {
Colin Crossa195f912019-10-16 11:07:20 -07001105 field := "Host"
1106 prefix := "target.host"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001107 if hostProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1108 mergePropertyStruct(ctx, genProps, hostProperties)
1109 }
Colin Crossa195f912019-10-16 11:07:20 -07001110 }
1111
1112 // Handle target OS generalities of the form:
1113 // target: {
1114 // bionic: {
1115 // key: value,
1116 // },
1117 // }
1118 if os.Linux() {
1119 field := "Linux"
1120 prefix := "target.linux"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001121 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1122 mergePropertyStruct(ctx, genProps, linuxProperties)
1123 }
Colin Crossa195f912019-10-16 11:07:20 -07001124 }
1125
Colin Crossa98d36d2022-03-07 14:39:49 -08001126 if os.Linux() && os.Class == Host {
1127 field := "Host_linux"
1128 prefix := "target.host_linux"
1129 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1130 mergePropertyStruct(ctx, genProps, linuxProperties)
1131 }
1132 }
1133
Colin Crossa195f912019-10-16 11:07:20 -07001134 if os.Bionic() {
1135 field := "Bionic"
1136 prefix := "target.bionic"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001137 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1138 mergePropertyStruct(ctx, genProps, bionicProperties)
1139 }
Colin Crossa195f912019-10-16 11:07:20 -07001140 }
1141
Colin Cross528d67e2021-07-23 22:23:07 +00001142 if os == Linux {
1143 field := "Glibc"
1144 prefix := "target.glibc"
1145 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1146 mergePropertyStruct(ctx, genProps, bionicProperties)
1147 }
1148 }
1149
1150 if os == LinuxMusl {
1151 field := "Musl"
1152 prefix := "target.musl"
1153 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1154 mergePropertyStruct(ctx, genProps, bionicProperties)
1155 }
Colin Cross528d67e2021-07-23 22:23:07 +00001156 }
1157
Colin Crossa195f912019-10-16 11:07:20 -07001158 // Handle target OS properties in the form:
1159 // target: {
1160 // linux_glibc: {
1161 // key: value,
1162 // },
1163 // not_windows: {
1164 // key: value,
1165 // },
1166 // android {
1167 // key: value,
1168 // },
1169 // },
1170 field := os.Field
1171 prefix := "target." + os.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001172 if osProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1173 mergePropertyStruct(ctx, genProps, osProperties)
1174 }
Colin Crossa195f912019-10-16 11:07:20 -07001175
Jiyong Park1613e552020-09-14 19:43:17 +09001176 if os.Class == Host && os != Windows {
Colin Crossa195f912019-10-16 11:07:20 -07001177 field := "Not_windows"
1178 prefix := "target.not_windows"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001179 if notWindowsProperties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1180 mergePropertyStruct(ctx, genProps, notWindowsProperties)
1181 }
Colin Crossa195f912019-10-16 11:07:20 -07001182 }
1183
1184 // Handle 64-bit device properties in the form:
1185 // target {
1186 // android64 {
1187 // key: value,
1188 // },
1189 // android32 {
1190 // key: value,
1191 // },
1192 // },
1193 // WARNING: this is probably not what you want to use in your blueprints file, it selects
1194 // options for all targets on a device that supports 64-bit binaries, not just the targets
1195 // that are being compiled for 64-bit. Its expected use case is binaries like linker and
1196 // debuggerd that need to know when they are a 32-bit process running on a 64-bit device
1197 if os.Class == Device {
1198 if ctx.Config().Android64() {
1199 field := "Android64"
1200 prefix := "target.android64"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001201 if android64Properties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1202 mergePropertyStruct(ctx, genProps, android64Properties)
1203 }
Colin Crossa195f912019-10-16 11:07:20 -07001204 } else {
1205 field := "Android32"
1206 prefix := "target.android32"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001207 if android32Properties, ok := getChildPropertyStruct(ctx, targetProp, field, prefix); ok {
1208 mergePropertyStruct(ctx, genProps, android32Properties)
1209 }
Colin Crossa195f912019-10-16 11:07:20 -07001210 }
1211 }
1212 }
1213 }
1214}
1215
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001216// Returns the struct containing the properties specific to the given
1217// architecture type. These look like this in Blueprint files:
1218// arch: {
1219// arm64: {
1220// key: value,
1221// },
1222// },
1223// This struct will also contain sub-structs containing to the architecture/CPU
1224// variants and features that themselves contain properties specific to those.
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001225func getArchTypeStruct(ctx ArchVariantContext, archProperties interface{}, archType ArchType) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001226 archPropValues := reflect.ValueOf(archProperties).Elem()
1227 archProp := archPropValues.FieldByName("Arch").Elem()
1228 prefix := "arch." + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001229 return getChildPropertyStruct(ctx, archProp, archType.Name, prefix)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001230}
1231
1232// Returns the struct containing the properties specific to a given multilib
1233// value. These look like this in the Blueprint file:
1234// multilib: {
1235// lib32: {
1236// key: value,
1237// },
1238// },
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001239func getMultilibStruct(ctx ArchVariantContext, archProperties interface{}, archType ArchType) (reflect.Value, bool) {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001240 archPropValues := reflect.ValueOf(archProperties).Elem()
1241 multilibProp := archPropValues.FieldByName("Multilib").Elem()
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001242 return getChildPropertyStruct(ctx, multilibProp, archType.Multilib, "multilib."+archType.Multilib)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001243}
1244
Liz Kammer9abd62d2021-05-21 08:37:59 -04001245func GetCompoundTargetField(os OsType, arch ArchType) string {
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04001246 return os.Field + "_" + arch.Name
1247}
1248
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001249// Returns the structs corresponding to the properties specific to the given
1250// architecture and OS in archProperties.
1251func getArchProperties(ctx BaseMutatorContext, archProperties interface{}, arch Arch, os OsType, nativeBridgeEnabled bool) []reflect.Value {
1252 result := make([]reflect.Value, 0)
1253 archPropValues := reflect.ValueOf(archProperties).Elem()
1254
1255 targetProp := archPropValues.FieldByName("Target").Elem()
1256
1257 archType := arch.ArchType
1258
1259 if arch.ArchType != Common {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001260 archStruct, ok := getArchTypeStruct(ctx, archProperties, arch.ArchType)
1261 if ok {
1262 result = append(result, archStruct)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001263
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001264 // Handle arch-variant-specific properties in the form:
1265 // arch: {
1266 // arm: {
1267 // variant: {
1268 // key: value,
1269 // },
1270 // },
1271 // },
1272 v := variantReplacer.Replace(arch.ArchVariant)
1273 if v != "" {
1274 prefix := "arch." + archType.Name + "." + v
1275 if variantProperties, ok := getChildPropertyStruct(ctx, archStruct, v, prefix); ok {
1276 result = append(result, variantProperties)
1277 }
1278 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001279
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001280 // Handle cpu-variant-specific properties in the form:
1281 // arch: {
1282 // arm: {
1283 // variant: {
1284 // key: value,
1285 // },
1286 // },
1287 // },
1288 if arch.CpuVariant != arch.ArchVariant {
1289 c := variantReplacer.Replace(arch.CpuVariant)
1290 if c != "" {
1291 prefix := "arch." + archType.Name + "." + c
1292 if cpuVariantProperties, ok := getChildPropertyStruct(ctx, archStruct, c, prefix); ok {
1293 result = append(result, cpuVariantProperties)
1294 }
1295 }
1296 }
1297
1298 // Handle arch-feature-specific properties in the form:
1299 // arch: {
1300 // arm: {
1301 // feature: {
1302 // key: value,
1303 // },
1304 // },
1305 // },
1306 for _, feature := range arch.ArchFeatures {
1307 prefix := "arch." + archType.Name + "." + feature
1308 if featureProperties, ok := getChildPropertyStruct(ctx, archStruct, feature, prefix); ok {
1309 result = append(result, featureProperties)
1310 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001311 }
1312 }
1313
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001314 if multilibProperties, ok := getMultilibStruct(ctx, archProperties, archType); ok {
1315 result = append(result, multilibProperties)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001316 }
1317
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001318 // Handle combined OS-feature and arch specific properties in the form:
1319 // target: {
1320 // bionic_x86: {
1321 // key: value,
1322 // },
1323 // }
1324 if os.Linux() {
1325 field := "Linux_" + arch.ArchType.Name
1326 userFriendlyField := "target.linux_" + arch.ArchType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001327 if linuxProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1328 result = append(result, linuxProperties)
1329 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001330 }
1331
1332 if os.Bionic() {
1333 field := "Bionic_" + archType.Name
1334 userFriendlyField := "target.bionic_" + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001335 if bionicProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1336 result = append(result, bionicProperties)
1337 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001338 }
1339
1340 // Handle combined OS and arch specific properties in the form:
1341 // target: {
1342 // linux_glibc_x86: {
1343 // key: value,
1344 // },
1345 // linux_glibc_arm: {
1346 // key: value,
1347 // },
1348 // android_arm {
1349 // key: value,
1350 // },
1351 // android_x86 {
1352 // key: value,
1353 // },
1354 // },
Liz Kammer9abd62d2021-05-21 08:37:59 -04001355 field := GetCompoundTargetField(os, archType)
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001356 userFriendlyField := "target." + os.Name + "_" + archType.Name
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001357 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1358 result = append(result, osArchProperties)
1359 }
Colin Cross528d67e2021-07-23 22:23:07 +00001360
Colin Cross1aa45b02022-02-10 10:33:10 -08001361 if os == Linux {
1362 field := "Glibc_" + archType.Name
1363 userFriendlyField := "target.glibc_" + "_" + archType.Name
1364 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1365 result = append(result, osArchProperties)
1366 }
1367 }
1368
Colin Cross528d67e2021-07-23 22:23:07 +00001369 if os == LinuxMusl {
Colin Cross1aa45b02022-02-10 10:33:10 -08001370 field := "Musl_" + archType.Name
1371 userFriendlyField := "target.musl_" + "_" + archType.Name
1372 if osArchProperties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1373 result = append(result, osArchProperties)
1374 }
Colin Cross528d67e2021-07-23 22:23:07 +00001375 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001376 }
1377
1378 // Handle arm on x86 properties in the form:
1379 // target {
1380 // arm_on_x86 {
1381 // key: value,
1382 // },
1383 // arm_on_x86_64 {
1384 // key: value,
1385 // },
1386 // },
1387 if os.Class == Device {
1388 if arch.ArchType == X86 && (hasArmAbi(arch) ||
1389 hasArmAndroidArch(ctx.Config().Targets[Android])) {
1390 field := "Arm_on_x86"
1391 userFriendlyField := "target.arm_on_x86"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001392 if armOnX86Properties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1393 result = append(result, armOnX86Properties)
1394 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001395 }
1396 if arch.ArchType == X86_64 && (hasArmAbi(arch) ||
1397 hasArmAndroidArch(ctx.Config().Targets[Android])) {
1398 field := "Arm_on_x86_64"
1399 userFriendlyField := "target.arm_on_x86_64"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001400 if armOnX8664Properties, ok := getChildPropertyStruct(ctx, targetProp, field, userFriendlyField); ok {
1401 result = append(result, armOnX8664Properties)
1402 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001403 }
1404 if os == Android && nativeBridgeEnabled {
1405 userFriendlyField := "Native_bridge"
1406 prefix := "target.native_bridge"
Lukacs T. Berki5f518392021-05-17 11:44:58 +02001407 if nativeBridgeProperties, ok := getChildPropertyStruct(ctx, targetProp, userFriendlyField, prefix); ok {
1408 result = append(result, nativeBridgeProperties)
1409 }
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001410 }
1411 }
1412
1413 return result
1414}
1415
Colin Crossa6845402020-11-16 15:08:19 -08001416// Squash the appropriate arch-specific property structs into the matching top level property
1417// structs based on the CompileTarget value that was annotated on the variant.
Colin Cross4157e882019-06-06 16:57:04 -07001418func (m *ModuleBase) setArchProperties(ctx BottomUpMutatorContext) {
1419 arch := m.Arch()
1420 os := m.Os()
Colin Crossd3ba0392015-05-07 14:11:29 -07001421
Ustadca02192021-12-20 12:56:46 -05001422 for i := range m.archProperties {
Usta851a3272022-01-05 23:42:33 -05001423 genProps := m.GetProperties()[i]
Colin Cross4157e882019-06-06 16:57:04 -07001424 if m.archProperties[i] == nil {
Dan Willemsenb1957a52016-06-23 23:44:54 -07001425 continue
1426 }
Dan Willemsenb1957a52016-06-23 23:44:54 -07001427
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001428 propStructs := make([]reflect.Value, 0)
1429 for _, archProperty := range m.archProperties[i] {
1430 propStructShard := getArchProperties(ctx, archProperty, arch, os, m.Target().NativeBridge == NativeBridgeEnabled)
1431 propStructs = append(propStructs, propStructShard...)
1432 }
Dan Willemsenb1957a52016-06-23 23:44:54 -07001433
Lukacs T. Berki598dd002021-05-05 09:00:01 +02001434 for _, propStruct := range propStructs {
1435 mergePropertyStruct(ctx, genProps, propStruct)
Colin Crossbb2e2b72016-12-08 17:23:53 -08001436 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001437 }
1438}
1439
Colin Cross0c66bc62021-07-20 09:47:41 -07001440// determineBuildOS stores the OS and architecture used for host targets used during the build into
Colin Cross528d67e2021-07-23 22:23:07 +00001441// config based on the runtime OS and architecture determined by Go and the product configuration.
Colin Cross0c66bc62021-07-20 09:47:41 -07001442func determineBuildOS(config *config) {
1443 config.BuildOS = func() OsType {
1444 switch runtime.GOOS {
1445 case "linux":
Colin Cross528d67e2021-07-23 22:23:07 +00001446 if Bool(config.productVariables.HostMusl) {
1447 return LinuxMusl
1448 }
Colin Cross0c66bc62021-07-20 09:47:41 -07001449 return Linux
1450 case "darwin":
1451 return Darwin
1452 default:
1453 panic(fmt.Sprintf("unsupported OS: %s", runtime.GOOS))
1454 }
1455 }()
1456
1457 config.BuildArch = func() ArchType {
1458 switch runtime.GOARCH {
1459 case "amd64":
1460 return X86_64
1461 default:
1462 panic(fmt.Sprintf("unsupported Arch: %s", runtime.GOARCH))
1463 }
1464 }()
1465
1466}
1467
Colin Crossa6845402020-11-16 15:08:19 -08001468// Convert the arch product variables into a list of targets for each OsType.
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001469func decodeTargetProductVariables(config *config) (map[OsType][]Target, error) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001470 variables := config.productVariables
Dan Willemsen490fd492015-11-24 17:53:15 -08001471
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001472 targets := make(map[OsType][]Target)
Colin Crossa1ad8d12016-06-01 17:09:44 -07001473 var targetErr error
1474
Liz Kammerb7f33662022-02-28 14:16:16 -05001475 type targetConfig struct {
1476 os OsType
1477 archName string
1478 archVariant *string
1479 cpuVariant *string
1480 abi []string
1481 nativeBridgeEnabled NativeBridgeSupport
1482 nativeBridgeHostArchName *string
1483 nativeBridgeRelativePath *string
1484 }
1485
1486 addTarget := func(target targetConfig) {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001487 if targetErr != nil {
1488 return
Dan Willemsen490fd492015-11-24 17:53:15 -08001489 }
Colin Crossa1ad8d12016-06-01 17:09:44 -07001490
Liz Kammerb7f33662022-02-28 14:16:16 -05001491 arch, err := decodeArch(target.os, target.archName, target.archVariant, target.cpuVariant, target.abi)
Colin Crossa1ad8d12016-06-01 17:09:44 -07001492 if err != nil {
1493 targetErr = err
1494 return
1495 }
Liz Kammerb7f33662022-02-28 14:16:16 -05001496 nativeBridgeRelativePathStr := String(target.nativeBridgeRelativePath)
1497 nativeBridgeHostArchNameStr := String(target.nativeBridgeHostArchName)
dimitry8d6dde82019-07-11 10:23:53 +02001498
1499 // Use guest arch as relative install path by default
Liz Kammerb7f33662022-02-28 14:16:16 -05001500 if target.nativeBridgeEnabled && nativeBridgeRelativePathStr == "" {
dimitry8d6dde82019-07-11 10:23:53 +02001501 nativeBridgeRelativePathStr = arch.ArchType.String()
1502 }
Colin Crossa1ad8d12016-06-01 17:09:44 -07001503
Jiyong Park1613e552020-09-14 19:43:17 +09001504 // A target is considered as HostCross if it's a host target which can't run natively on
1505 // the currently configured build machine (either because the OS is different or because of
1506 // the unsupported arch)
1507 hostCross := false
Liz Kammerb7f33662022-02-28 14:16:16 -05001508 if target.os.Class == Host {
Jiyong Park1613e552020-09-14 19:43:17 +09001509 var osSupported bool
Liz Kammerb7f33662022-02-28 14:16:16 -05001510 if target.os == config.BuildOS {
Jiyong Park1613e552020-09-14 19:43:17 +09001511 osSupported = true
Liz Kammerb7f33662022-02-28 14:16:16 -05001512 } else if config.BuildOS.Linux() && target.os.Linux() {
Jiyong Park1613e552020-09-14 19:43:17 +09001513 // LinuxBionic and Linux are compatible
1514 osSupported = true
1515 } else {
1516 osSupported = false
1517 }
1518
1519 var archSupported bool
1520 if arch.ArchType == Common {
1521 archSupported = true
1522 } else if arch.ArchType.Name == *variables.HostArch {
1523 archSupported = true
1524 } else if variables.HostSecondaryArch != nil && arch.ArchType.Name == *variables.HostSecondaryArch {
1525 archSupported = true
1526 } else {
1527 archSupported = false
1528 }
1529 if !osSupported || !archSupported {
1530 hostCross = true
1531 }
1532 }
1533
Liz Kammerb7f33662022-02-28 14:16:16 -05001534 targets[target.os] = append(targets[target.os],
Colin Crossa1ad8d12016-06-01 17:09:44 -07001535 Target{
Liz Kammerb7f33662022-02-28 14:16:16 -05001536 Os: target.os,
dimitry8d6dde82019-07-11 10:23:53 +02001537 Arch: arch,
Liz Kammerb7f33662022-02-28 14:16:16 -05001538 NativeBridge: target.nativeBridgeEnabled,
dimitry8d6dde82019-07-11 10:23:53 +02001539 NativeBridgeHostArchName: nativeBridgeHostArchNameStr,
1540 NativeBridgeRelativePath: nativeBridgeRelativePathStr,
Jiyong Park1613e552020-09-14 19:43:17 +09001541 HostCross: hostCross,
Colin Crossa1ad8d12016-06-01 17:09:44 -07001542 })
Dan Willemsen490fd492015-11-24 17:53:15 -08001543 }
1544
Colin Cross4225f652015-09-17 14:33:42 -07001545 if variables.HostArch == nil {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001546 return nil, fmt.Errorf("No host primary architecture set")
Colin Cross4225f652015-09-17 14:33:42 -07001547 }
1548
Colin Crossa6845402020-11-16 15:08:19 -08001549 // The primary host target, which must always exist.
Liz Kammerb7f33662022-02-28 14:16:16 -05001550 addTarget(targetConfig{os: config.BuildOS, archName: *variables.HostArch, nativeBridgeEnabled: NativeBridgeDisabled})
Colin Cross4225f652015-09-17 14:33:42 -07001551
Colin Crossa6845402020-11-16 15:08:19 -08001552 // An optional secondary host target.
Colin Crosseeabb892015-11-20 13:07:51 -08001553 if variables.HostSecondaryArch != nil && *variables.HostSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001554 addTarget(targetConfig{os: config.BuildOS, archName: *variables.HostSecondaryArch, nativeBridgeEnabled: NativeBridgeDisabled})
Dan Willemsen490fd492015-11-24 17:53:15 -08001555 }
1556
Colin Crossa6845402020-11-16 15:08:19 -08001557 // Optional cross-compiled host targets, generally Windows.
Colin Crossff3ae9d2018-04-10 16:15:18 -07001558 if String(variables.CrossHost) != "" {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001559 crossHostOs := osByName(*variables.CrossHost)
1560 if crossHostOs == NoOsType {
1561 return nil, fmt.Errorf("Unknown cross host OS %q", *variables.CrossHost)
1562 }
1563
Colin Crossff3ae9d2018-04-10 16:15:18 -07001564 if String(variables.CrossHostArch) == "" {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001565 return nil, fmt.Errorf("No cross-host primary architecture set")
Dan Willemsen490fd492015-11-24 17:53:15 -08001566 }
1567
Colin Crossa6845402020-11-16 15:08:19 -08001568 // The primary cross-compiled host target.
Liz Kammerb7f33662022-02-28 14:16:16 -05001569 addTarget(targetConfig{os: crossHostOs, archName: *variables.CrossHostArch, nativeBridgeEnabled: NativeBridgeDisabled})
Dan Willemsen490fd492015-11-24 17:53:15 -08001570
Colin Crossa6845402020-11-16 15:08:19 -08001571 // An optional secondary cross-compiled host target.
Dan Willemsen490fd492015-11-24 17:53:15 -08001572 if variables.CrossHostSecondaryArch != nil && *variables.CrossHostSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001573 addTarget(targetConfig{os: crossHostOs, archName: *variables.CrossHostSecondaryArch, nativeBridgeEnabled: NativeBridgeDisabled})
Dan Willemsen490fd492015-11-24 17:53:15 -08001574 }
1575 }
1576
Colin Crossa6845402020-11-16 15:08:19 -08001577 // Optional device targets
Dan Willemsen3f32f032016-07-11 14:36:48 -07001578 if variables.DeviceArch != nil && *variables.DeviceArch != "" {
Colin Crossa6845402020-11-16 15:08:19 -08001579 // The primary device target.
Liz Kammerb7f33662022-02-28 14:16:16 -05001580 addTarget(targetConfig{
1581 os: Android,
1582 archName: *variables.DeviceArch,
1583 archVariant: variables.DeviceArchVariant,
1584 cpuVariant: variables.DeviceCpuVariant,
1585 abi: variables.DeviceAbi,
1586 nativeBridgeEnabled: NativeBridgeDisabled,
1587 })
Colin Cross4225f652015-09-17 14:33:42 -07001588
Colin Crossa6845402020-11-16 15:08:19 -08001589 // An optional secondary device target.
Dan Willemsen3f32f032016-07-11 14:36:48 -07001590 if variables.DeviceSecondaryArch != nil && *variables.DeviceSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001591 addTarget(targetConfig{
1592 os: Android,
1593 archName: *variables.DeviceSecondaryArch,
1594 archVariant: variables.DeviceSecondaryArchVariant,
1595 cpuVariant: variables.DeviceSecondaryCpuVariant,
1596 abi: variables.DeviceSecondaryAbi,
1597 nativeBridgeEnabled: NativeBridgeDisabled,
1598 })
Colin Cross4225f652015-09-17 14:33:42 -07001599 }
dimitry1f33e402019-03-26 12:39:31 +01001600
Colin Crossa6845402020-11-16 15:08:19 -08001601 // An optional NativeBridge device target.
dimitry1f33e402019-03-26 12:39:31 +01001602 if variables.NativeBridgeArch != nil && *variables.NativeBridgeArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001603 addTarget(targetConfig{
1604 os: Android,
1605 archName: *variables.NativeBridgeArch,
1606 archVariant: variables.NativeBridgeArchVariant,
1607 cpuVariant: variables.NativeBridgeCpuVariant,
1608 abi: variables.NativeBridgeAbi,
1609 nativeBridgeEnabled: NativeBridgeEnabled,
1610 nativeBridgeHostArchName: variables.DeviceArch,
1611 nativeBridgeRelativePath: variables.NativeBridgeRelativePath,
1612 })
dimitry1f33e402019-03-26 12:39:31 +01001613 }
1614
Colin Crossa6845402020-11-16 15:08:19 -08001615 // An optional secondary NativeBridge device target.
dimitry1f33e402019-03-26 12:39:31 +01001616 if variables.DeviceSecondaryArch != nil && *variables.DeviceSecondaryArch != "" &&
1617 variables.NativeBridgeSecondaryArch != nil && *variables.NativeBridgeSecondaryArch != "" {
Liz Kammerb7f33662022-02-28 14:16:16 -05001618 addTarget(targetConfig{
1619 os: Android,
1620 archName: *variables.NativeBridgeSecondaryArch,
1621 archVariant: variables.NativeBridgeSecondaryArchVariant,
1622 cpuVariant: variables.NativeBridgeSecondaryCpuVariant,
1623 abi: variables.NativeBridgeSecondaryAbi,
1624 nativeBridgeEnabled: NativeBridgeEnabled,
1625 nativeBridgeHostArchName: variables.DeviceSecondaryArch,
1626 nativeBridgeRelativePath: variables.NativeBridgeSecondaryRelativePath,
1627 })
dimitry1f33e402019-03-26 12:39:31 +01001628 }
Colin Cross4225f652015-09-17 14:33:42 -07001629 }
1630
Colin Crossa1ad8d12016-06-01 17:09:44 -07001631 if targetErr != nil {
1632 return nil, targetErr
1633 }
1634
1635 return targets, nil
Colin Cross4225f652015-09-17 14:33:42 -07001636}
1637
Colin Crossbb2e2b72016-12-08 17:23:53 -08001638// hasArmAbi returns true if arch has at least one arm ABI
1639func hasArmAbi(arch Arch) bool {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001640 return PrefixInList(arch.Abi, "arm")
Colin Crossbb2e2b72016-12-08 17:23:53 -08001641}
1642
Lev Rumyantsev34581212021-10-13 09:47:59 -07001643// hasArmAndroidArch returns true if targets has at least
1644// one arm Android arch (possibly native bridged)
Colin Cross4247f0d2017-04-13 16:56:14 -07001645func hasArmAndroidArch(targets []Target) bool {
1646 for _, target := range targets {
Lev Rumyantsev34581212021-10-13 09:47:59 -07001647 if target.Os == Android &&
1648 (target.Arch.ArchType == Arm || target.Arch.ArchType == Arm64) {
Victor Khimenko5eb8ec12018-03-21 20:30:54 +01001649 return true
1650 }
1651 }
1652 return false
1653}
1654
Colin Crossa6845402020-11-16 15:08:19 -08001655// archConfig describes a built-in configuration.
Dan Albert4098deb2016-10-19 14:04:41 -07001656type archConfig struct {
1657 arch string
1658 archVariant string
1659 cpuVariant string
1660 abi []string
1661}
1662
Dan Albertf1d14c72020-07-30 14:32:55 -07001663// getNdkAbisConfig returns the list of archConfigs that are used for bulding
1664// the API stubs and static libraries that are included in the NDK. These are
1665// built *without Neon*, because non-Neon is still supported and building these
1666// with Neon will break those users.
Dan Albert4098deb2016-10-19 14:04:41 -07001667func getNdkAbisConfig() []archConfig {
1668 return []archConfig{
Tamas Petzbca786d2021-01-20 18:56:33 +01001669 {"arm64", "armv8-a-branchprot", "", []string{"arm64-v8a"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001670 {"arm", "armv7-a", "", []string{"armeabi-v7a"}},
Dan Albert4098deb2016-10-19 14:04:41 -07001671 {"x86_64", "", "", []string{"x86_64"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001672 {"x86", "", "", []string{"x86"}},
Dan Albert4098deb2016-10-19 14:04:41 -07001673 }
1674}
1675
Colin Crossa6845402020-11-16 15:08:19 -08001676// getAmlAbisConfig returns a list of archConfigs for the ABIs supported by mainline modules.
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001677func getAmlAbisConfig() []archConfig {
1678 return []archConfig{
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001679 {"arm64", "armv8-a", "", []string{"arm64-v8a"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001680 {"arm", "armv7-a-neon", "", []string{"armeabi-v7a"}},
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001681 {"x86_64", "", "", []string{"x86_64"}},
Inseob Kim5219c0e2021-06-17 00:33:00 +09001682 {"x86", "", "", []string{"x86"}},
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001683 }
1684}
1685
Colin Crossa6845402020-11-16 15:08:19 -08001686// decodeArchSettings converts a list of archConfigs into a list of Targets for the given OsType.
Liz Kammerb7f33662022-02-28 14:16:16 -05001687func decodeAndroidArchSettings(archConfigs []archConfig) ([]Target, error) {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001688 var ret []Target
Dan Willemsen322acaf2016-01-12 23:07:05 -08001689
Dan Albert4098deb2016-10-19 14:04:41 -07001690 for _, config := range archConfigs {
Liz Kammerb7f33662022-02-28 14:16:16 -05001691 arch, err := decodeArch(Android, config.arch, &config.archVariant,
Colin Crossa74ca042019-01-31 14:31:51 -08001692 &config.cpuVariant, config.abi)
Dan Willemsen322acaf2016-01-12 23:07:05 -08001693 if err != nil {
1694 return nil, err
1695 }
Colin Cross3b19f5d2019-09-17 14:45:31 -07001696
Colin Crossa1ad8d12016-06-01 17:09:44 -07001697 ret = append(ret, Target{
1698 Os: Android,
1699 Arch: arch,
1700 })
Dan Willemsen322acaf2016-01-12 23:07:05 -08001701 }
1702
1703 return ret, nil
1704}
1705
Colin Crossa6845402020-11-16 15:08:19 -08001706// decodeArch converts a set of strings from product variables into an Arch struct.
Colin Crossa74ca042019-01-31 14:31:51 -08001707func decodeArch(os OsType, arch string, archVariant, cpuVariant *string, abi []string) (Arch, error) {
Colin Crossa6845402020-11-16 15:08:19 -08001708 // Verify the arch is valid
Colin Crosseeabb892015-11-20 13:07:51 -08001709 archType, ok := archTypeMap[arch]
1710 if !ok {
1711 return Arch{}, fmt.Errorf("unknown arch %q", arch)
1712 }
Colin Cross4225f652015-09-17 14:33:42 -07001713
Colin Crosseeabb892015-11-20 13:07:51 -08001714 a := Arch{
Colin Cross4225f652015-09-17 14:33:42 -07001715 ArchType: archType,
Colin Crossa6845402020-11-16 15:08:19 -08001716 ArchVariant: String(archVariant),
1717 CpuVariant: String(cpuVariant),
Colin Crossa74ca042019-01-31 14:31:51 -08001718 Abi: abi,
Colin Crosseeabb892015-11-20 13:07:51 -08001719 }
1720
Colin Crossa6845402020-11-16 15:08:19 -08001721 // Convert generic arch variants into the empty string.
Colin Crosseeabb892015-11-20 13:07:51 -08001722 if a.ArchVariant == a.ArchType.Name || a.ArchVariant == "generic" {
1723 a.ArchVariant = ""
1724 }
1725
Colin Crossa6845402020-11-16 15:08:19 -08001726 // Convert generic CPU variants into the empty string.
Colin Crosseeabb892015-11-20 13:07:51 -08001727 if a.CpuVariant == a.ArchType.Name || a.CpuVariant == "generic" {
1728 a.CpuVariant = ""
1729 }
1730
Liz Kammer2c2afe22022-02-11 11:35:03 -05001731 if a.ArchVariant != "" {
1732 if validArchVariants := archVariants[archType]; !InList(a.ArchVariant, validArchVariants) {
1733 return Arch{}, fmt.Errorf("[%q] unknown arch variant %q, support variants: %q", archType, a.ArchVariant, validArchVariants)
1734 }
1735 }
1736
1737 if a.CpuVariant != "" {
1738 if validCpuVariants := cpuVariants[archType]; !InList(a.CpuVariant, validCpuVariants) {
1739 return Arch{}, fmt.Errorf("[%q] unknown cpu variant %q, support variants: %q", archType, a.CpuVariant, validCpuVariants)
1740 }
1741 }
1742
Colin Crossa6845402020-11-16 15:08:19 -08001743 // Filter empty ABIs out of the list.
Colin Crosseeabb892015-11-20 13:07:51 -08001744 for i := 0; i < len(a.Abi); i++ {
1745 if a.Abi[i] == "" {
1746 a.Abi = append(a.Abi[:i], a.Abi[i+1:]...)
1747 i--
1748 }
1749 }
1750
Liz Kammere8303bd2022-02-16 09:02:48 -05001751 // Set ArchFeatures from the arch type. for Android OS, other os-es do not specify features
1752 if os == Android {
1753 if featureMap, ok := androidArchFeatureMap[archType]; ok {
Dan Willemsen01a3c252019-01-11 19:02:16 -08001754 a.ArchFeatures = featureMap[a.ArchVariant]
1755 }
Colin Crossc5c24ad2015-11-20 15:35:00 -08001756 }
1757
Colin Crosseeabb892015-11-20 13:07:51 -08001758 return a, nil
Colin Cross4225f652015-09-17 14:33:42 -07001759}
1760
Colin Crossa6845402020-11-16 15:08:19 -08001761// filterMultilibTargets takes a list of Targets and a multilib value and returns a new list of
1762// Targets containing only those that have the given multilib value.
Colin Cross69617d32016-09-06 10:39:07 -07001763func filterMultilibTargets(targets []Target, multilib string) []Target {
1764 var ret []Target
1765 for _, t := range targets {
1766 if t.Arch.ArchType.Multilib == multilib {
1767 ret = append(ret, t)
1768 }
1769 }
1770 return ret
1771}
1772
Colin Crossa6845402020-11-16 15:08:19 -08001773// getCommonTargets returns the set of Os specific common architecture targets for each Os in a list
1774// of targets.
Nan Zhangdb0b9a32017-02-27 10:12:13 -08001775func getCommonTargets(targets []Target) []Target {
1776 var ret []Target
1777 set := make(map[string]bool)
1778
1779 for _, t := range targets {
1780 if _, found := set[t.Os.String()]; !found {
1781 set[t.Os.String()] = true
Colin Cross39a18142022-06-24 18:43:40 -07001782 common := commonTargetMap[t.Os.String()]
1783 common.HostCross = t.HostCross
1784 ret = append(ret, common)
Nan Zhangdb0b9a32017-02-27 10:12:13 -08001785 }
1786 }
1787
1788 return ret
1789}
1790
Sam Delmericocc271e22022-06-01 15:45:02 +00001791// FirstTarget takes a list of Targets and a list of multilib values and returns a list of Targets
Colin Cross3b56c922022-07-20 17:37:37 +00001792// that contains zero or one Target for each OsType, selecting the one that matches the earliest
1793// filter.
Sam Delmericocc271e22022-06-01 15:45:02 +00001794func FirstTarget(targets []Target, filters ...string) []Target {
Jiyong Park22101982020-09-17 19:09:58 +09001795 // find the first target from each OS
1796 var ret []Target
Colin Cross3b56c922022-07-20 17:37:37 +00001797 hasHost := false
1798 set := make(map[OsType]bool)
Jiyong Park22101982020-09-17 19:09:58 +09001799
Colin Cross6b4a32d2017-12-05 13:42:45 -08001800 for _, filter := range filters {
1801 buildTargets := filterMultilibTargets(targets, filter)
Jiyong Park22101982020-09-17 19:09:58 +09001802 for _, t := range buildTargets {
Colin Cross3b56c922022-07-20 17:37:37 +00001803 if _, found := set[t.Os]; !found {
1804 hasHost = hasHost || (t.Os.Class == Host)
1805 set[t.Os] = true
Jiyong Park22101982020-09-17 19:09:58 +09001806 ret = append(ret, t)
1807 }
Colin Cross6b4a32d2017-12-05 13:42:45 -08001808 }
1809 }
Jiyong Park22101982020-09-17 19:09:58 +09001810 return ret
Colin Cross6b4a32d2017-12-05 13:42:45 -08001811}
1812
Colin Crossa6845402020-11-16 15:08:19 -08001813// decodeMultilibTargets uses the module's multilib setting to select one or more targets from a
1814// list of Targets.
Colin Crossee0bc3b2018-10-02 22:01:37 -07001815func decodeMultilibTargets(multilib string, targets []Target, prefer32 bool) ([]Target, error) {
Colin Crossa6845402020-11-16 15:08:19 -08001816 var buildTargets []Target
Colin Cross6b4a32d2017-12-05 13:42:45 -08001817
Colin Cross4225f652015-09-17 14:33:42 -07001818 switch multilib {
1819 case "common":
Colin Cross6b4a32d2017-12-05 13:42:45 -08001820 buildTargets = getCommonTargets(targets)
1821 case "common_first":
1822 buildTargets = getCommonTargets(targets)
1823 if prefer32 {
Sam Delmericocc271e22022-06-01 15:45:02 +00001824 buildTargets = append(buildTargets, FirstTarget(targets, "lib32", "lib64")...)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001825 } else {
Sam Delmericocc271e22022-06-01 15:45:02 +00001826 buildTargets = append(buildTargets, FirstTarget(targets, "lib64", "lib32")...)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001827 }
Colin Cross4225f652015-09-17 14:33:42 -07001828 case "both":
Colin Cross8b74d172016-09-13 09:59:14 -07001829 if prefer32 {
1830 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib32")...)
1831 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib64")...)
1832 } else {
1833 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib64")...)
1834 buildTargets = append(buildTargets, filterMultilibTargets(targets, "lib32")...)
1835 }
Colin Cross4225f652015-09-17 14:33:42 -07001836 case "32":
Colin Cross69617d32016-09-06 10:39:07 -07001837 buildTargets = filterMultilibTargets(targets, "lib32")
Colin Cross4225f652015-09-17 14:33:42 -07001838 case "64":
Colin Cross69617d32016-09-06 10:39:07 -07001839 buildTargets = filterMultilibTargets(targets, "lib64")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001840 case "first":
1841 if prefer32 {
Sam Delmericocc271e22022-06-01 15:45:02 +00001842 buildTargets = FirstTarget(targets, "lib32", "lib64")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001843 } else {
Sam Delmericocc271e22022-06-01 15:45:02 +00001844 buildTargets = FirstTarget(targets, "lib64", "lib32")
Colin Cross6b4a32d2017-12-05 13:42:45 -08001845 }
Victor Chang9448e8f2020-09-14 15:34:16 +01001846 case "first_prefer32":
Sam Delmericocc271e22022-06-01 15:45:02 +00001847 buildTargets = FirstTarget(targets, "lib32", "lib64")
Colin Cross69617d32016-09-06 10:39:07 -07001848 case "prefer32":
Colin Cross3dceee32018-09-06 10:19:57 -07001849 buildTargets = filterMultilibTargets(targets, "lib32")
1850 if len(buildTargets) == 0 {
1851 buildTargets = filterMultilibTargets(targets, "lib64")
1852 }
Dan Willemsen47450072021-10-19 20:24:49 -07001853 case "darwin_universal":
1854 buildTargets = filterMultilibTargets(targets, "lib64")
1855 // Reverse the targets so that the first architecture can depend on the second
1856 // architecture module in order to merge the outputs.
1857 reverseSliceInPlace(buildTargets)
1858 case "darwin_universal_common_first":
1859 archTargets := filterMultilibTargets(targets, "lib64")
1860 reverseSliceInPlace(archTargets)
1861 buildTargets = append(getCommonTargets(targets), archTargets...)
Colin Cross4225f652015-09-17 14:33:42 -07001862 default:
Victor Chang9448e8f2020-09-14 15:34:16 +01001863 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 -07001864 multilib)
Colin Cross4225f652015-09-17 14:33:42 -07001865 }
1866
Colin Crossa1ad8d12016-06-01 17:09:44 -07001867 return buildTargets, nil
Colin Cross4225f652015-09-17 14:33:42 -07001868}
Jingwen Chen5d864492021-02-24 07:20:12 -05001869
Chris Parsonsc424b762021-04-29 18:06:50 -04001870func (m *ModuleBase) getArchPropertySet(propertySet interface{}, archType ArchType) interface{} {
1871 archString := archType.Field
1872 for i := range m.archProperties {
1873 if m.archProperties[i] == nil {
1874 // Skip over nil properties
1875 continue
1876 }
1877
1878 // Not archProperties are usable; this function looks for properties of a very specific
1879 // form, and ignores the rest.
1880 for _, archProperty := range m.archProperties[i] {
1881 // archPropValue is a property struct, we are looking for the form:
1882 // `arch: { arm: { key: value, ... }}`
1883 archPropValue := reflect.ValueOf(archProperty).Elem()
1884
1885 // Unwrap src so that it should looks like a pointer to `arm: { key: value, ... }`
1886 src := archPropValue.FieldByName("Arch").Elem()
1887
1888 // Step into non-nil pointers to structs in the src value.
1889 if src.Kind() == reflect.Ptr {
1890 if src.IsNil() {
1891 continue
1892 }
1893 src = src.Elem()
1894 }
1895
1896 // Find the requested field (e.g. arm, x86) in the src struct.
1897 src = src.FieldByName(archString)
1898
1899 // We only care about structs.
1900 if !src.IsValid() || src.Kind() != reflect.Struct {
1901 continue
1902 }
1903
1904 // If the value of the field is a struct then step into the
1905 // BlueprintEmbed field. The special "BlueprintEmbed" name is
1906 // used by createArchPropTypeDesc to embed the arch properties
1907 // in the parent struct, so the src arch prop should be in this
1908 // field.
1909 //
1910 // See createArchPropTypeDesc for more details on how Arch-specific
1911 // module properties are processed from the nested props and written
1912 // into the module's archProperties.
1913 src = src.FieldByName("BlueprintEmbed")
1914
1915 // Clone the destination prop, since we want a unique prop struct per arch.
1916 propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1917
1918 // Copy the located property struct into the cloned destination property struct.
1919 err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)
1920 if err != nil {
1921 // This is fine, it just means the src struct doesn't match the type of propertySet.
1922 continue
1923 }
1924
1925 return propertySetClone
1926 }
1927 }
1928 // No property set was found specific to the given arch, so return an empty
1929 // property set.
1930 return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1931}
1932
1933// getMultilibPropertySet returns a property set struct matching the type of
1934// `propertySet`, containing multilib-specific module properties for the given architecture.
1935// If no multilib-specific properties exist for the given architecture, returns an empty property
1936// set matching `propertySet`'s type.
1937func (m *ModuleBase) getMultilibPropertySet(propertySet interface{}, archType ArchType) interface{} {
1938 // archType.Multilib is lowercase (for example, lib32) but property struct field is
1939 // capitalized, such as Lib32, so use strings.Title to capitalize it.
1940 multiLibString := strings.Title(archType.Multilib)
1941
1942 for i := range m.archProperties {
1943 if m.archProperties[i] == nil {
1944 // Skip over nil properties
1945 continue
1946 }
1947
1948 // Not archProperties are usable; this function looks for properties of a very specific
1949 // form, and ignores the rest.
1950 for _, archProperties := range m.archProperties[i] {
1951 // archPropValue is a property struct, we are looking for the form:
1952 // `multilib: { lib32: { key: value, ... }}`
1953 archPropValue := reflect.ValueOf(archProperties).Elem()
1954
1955 // Unwrap src so that it should looks like a pointer to `lib32: { key: value, ... }`
1956 src := archPropValue.FieldByName("Multilib").Elem()
1957
1958 // Step into non-nil pointers to structs in the src value.
1959 if src.Kind() == reflect.Ptr {
1960 if src.IsNil() {
1961 // Ignore nil pointers.
1962 continue
1963 }
1964 src = src.Elem()
1965 }
1966
1967 // Find the requested field (e.g. lib32) in the src struct.
1968 src = src.FieldByName(multiLibString)
1969
1970 // We only care about valid struct pointers.
1971 if !src.IsValid() || src.Kind() != reflect.Ptr || src.Elem().Kind() != reflect.Struct {
1972 continue
1973 }
1974
1975 // Get the zero value for the requested property set.
1976 propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1977
1978 // Copy the located property struct into the "zero" property set struct.
1979 err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)
1980
1981 if err != nil {
1982 // This is fine, it just means the src struct doesn't match.
1983 continue
1984 }
1985
1986 return propertySetClone
1987 }
1988 }
1989
1990 // There were no multilib properties specifically matching the given archtype.
1991 // Return zeroed value.
1992 return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
1993}
1994
Liz Kammerb6dbc872021-05-14 15:14:40 -04001995// ArchVariantContext defines the limited context necessary to retrieve arch_variant properties.
1996type ArchVariantContext interface {
1997 ModuleErrorf(fmt string, args ...interface{})
1998 PropertyErrorf(property, fmt string, args ...interface{})
1999}
2000
Liz Kammer9abd62d2021-05-21 08:37:59 -04002001// ArchVariantProperties represents a map of arch-variant config strings to a property interface{}.
2002type ArchVariantProperties map[string]interface{}
2003
2004// ConfigurationAxisToArchVariantProperties represents a map of bazel.ConfigurationAxis to
2005// ArchVariantProperties, such that each independent arch-variant axis maps to the
2006// configs/properties for that axis.
2007type ConfigurationAxisToArchVariantProperties map[bazel.ConfigurationAxis]ArchVariantProperties
2008
2009// GetArchVariantProperties returns a ConfigurationAxisToArchVariantProperties where the
2010// arch-variant properties correspond to the values of the properties of the 'propertySet' struct
2011// that are specific to that axis/configuration. Each axis is independent, containing
2012// non-overlapping configs that correspond to the various "arch-variant" support, at this time:
2013// arches (including multilib)
2014// oses
2015// arch+os combinations
Jingwen Chen5d864492021-02-24 07:20:12 -05002016//
Liz Kammer9abd62d2021-05-21 08:37:59 -04002017// For example, passing a struct { Foo bool, Bar string } will return an interface{} that can be
2018// type asserted back into the same struct, containing the config-specific property value specified
2019// by the module if defined.
Chris Parsonsc424b762021-04-29 18:06:50 -04002020//
2021// Arch-specific properties may come from an arch stanza or a multilib stanza; properties
2022// in these stanzas are combined.
2023// For example: `arch: { x86: { Foo: ["bar"] } }, multilib: { lib32: {` Foo: ["baz"] } }`
2024// will result in `Foo: ["bar", "baz"]` being returned for architecture x86, if the given
2025// propertyset contains `Foo []string`.
Liz Kammer9abd62d2021-05-21 08:37:59 -04002026func (m *ModuleBase) GetArchVariantProperties(ctx ArchVariantContext, propertySet interface{}) ConfigurationAxisToArchVariantProperties {
Jingwen Chen5d864492021-02-24 07:20:12 -05002027 // Return value of the arch types to the prop values for that arch.
Liz Kammer9abd62d2021-05-21 08:37:59 -04002028 axisToProps := ConfigurationAxisToArchVariantProperties{}
Jingwen Chen5d864492021-02-24 07:20:12 -05002029
2030 // Nothing to do for non-arch-specific modules.
2031 if !m.ArchSpecific() {
Liz Kammer9abd62d2021-05-21 08:37:59 -04002032 return axisToProps
Jingwen Chen5d864492021-02-24 07:20:12 -05002033 }
2034
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002035 dstType := reflect.ValueOf(propertySet).Type()
2036 var archProperties []interface{}
2037
2038 // First find the property set in the module that corresponds to the requested
Usta851a3272022-01-05 23:42:33 -05002039 // one. m.archProperties[i] corresponds to m.GetProperties()[i].
2040 for i, generalProp := range m.GetProperties() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002041 srcType := reflect.ValueOf(generalProp).Type()
2042 if srcType == dstType {
2043 archProperties = m.archProperties[i]
Liz Kammer135bf552021-08-11 10:46:06 -04002044 axisToProps[bazel.NoConfigAxis] = ArchVariantProperties{"": generalProp}
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002045 break
2046 }
2047 }
2048
2049 if archProperties == nil {
2050 // This module does not have the property set requested
Liz Kammer9abd62d2021-05-21 08:37:59 -04002051 return axisToProps
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002052 }
2053
Liz Kammer9abd62d2021-05-21 08:37:59 -04002054 archToProp := ArchVariantProperties{}
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002055 // For each arch type (x86, arm64, etc.)
Chris Parsonsc424b762021-04-29 18:06:50 -04002056 for _, arch := range ArchTypeList() {
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002057 // Arch properties are sometimes sharded (see createArchPropTypeDesc() ).
2058 // Iterate over ever shard and extract a struct with the same type as the
2059 // input one that contains the data specific to that arch.
2060 propertyStructs := make([]reflect.Value, 0)
2061 for _, archProperty := range archProperties {
Lukacs T. Berki5f518392021-05-17 11:44:58 +02002062 archTypeStruct, ok := getArchTypeStruct(ctx, archProperty, arch)
2063 if ok {
2064 propertyStructs = append(propertyStructs, archTypeStruct)
2065 }
2066 multilibStruct, ok := getMultilibStruct(ctx, archProperty, arch)
2067 if ok {
2068 propertyStructs = append(propertyStructs, multilibStruct)
2069 }
Jingwen Chen5d864492021-02-24 07:20:12 -05002070 }
2071
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002072 // Create a new instance of the requested property set
2073 value := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2074
Chris Parsonsa37e1952021-09-28 16:47:36 -04002075 archToProp[arch.Name] = mergeStructs(ctx, propertyStructs, value)
Jingwen Chen5d864492021-02-24 07:20:12 -05002076 }
Liz Kammer9abd62d2021-05-21 08:37:59 -04002077 axisToProps[bazel.ArchConfigurationAxis] = archToProp
Lukacs T. Berki598dd002021-05-05 09:00:01 +02002078
Liz Kammer9abd62d2021-05-21 08:37:59 -04002079 osToProp := ArchVariantProperties{}
2080 archOsToProp := ArchVariantProperties{}
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002081
Liz Kammerfdd72e62021-10-11 15:41:03 -04002082 linuxStructs := getTargetStructs(ctx, archProperties, "Linux")
2083 bionicStructs := getTargetStructs(ctx, archProperties, "Bionic")
2084 hostStructs := getTargetStructs(ctx, archProperties, "Host")
Colin Crossa98d36d2022-03-07 14:39:49 -08002085 hostLinuxStructs := getTargetStructs(ctx, archProperties, "Host_linux")
Liz Kammerfdd72e62021-10-11 15:41:03 -04002086 hostNotWindowsStructs := getTargetStructs(ctx, archProperties, "Not_windows")
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002087
Liz Kammer9abd62d2021-05-21 08:37:59 -04002088 // For android, linux, ...
2089 for _, os := range osTypeList {
2090 if os == CommonOS {
2091 // It looks like this OS value is not used in Blueprint files
2092 continue
2093 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002094 osStructs := make([]reflect.Value, 0)
Liz Kammerfdd72e62021-10-11 15:41:03 -04002095
2096 osSpecificStructs := getTargetStructs(ctx, archProperties, os.Field)
2097 if os.Class == Host {
2098 osStructs = append(osStructs, hostStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002099 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002100 if os.Linux() {
2101 osStructs = append(osStructs, linuxStructs...)
2102 }
2103 if os.Bionic() {
2104 osStructs = append(osStructs, bionicStructs...)
2105 }
Colin Crossa98d36d2022-03-07 14:39:49 -08002106 if os.Linux() && os.Class == Host {
2107 osStructs = append(osStructs, hostLinuxStructs...)
2108 }
Liz Kammerfdd72e62021-10-11 15:41:03 -04002109
2110 if os == LinuxMusl {
2111 osStructs = append(osStructs, getTargetStructs(ctx, archProperties, "Musl")...)
2112 }
2113 if os == Linux {
2114 osStructs = append(osStructs, getTargetStructs(ctx, archProperties, "Glibc")...)
2115 }
2116
2117 osStructs = append(osStructs, osSpecificStructs...)
2118
2119 if os.Class == Host && os != Windows {
2120 osStructs = append(osStructs, hostNotWindowsStructs...)
2121 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002122 osToProp[os.Name] = mergeStructs(ctx, osStructs, propertySet)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002123
Liz Kammer9abd62d2021-05-21 08:37:59 -04002124 // For arm, x86, ...
2125 for _, arch := range osArchTypeMap[os] {
Chris Parsonsa37e1952021-09-28 16:47:36 -04002126 osArchStructs := make([]reflect.Value, 0)
2127
Chris Parsonsa37e1952021-09-28 16:47:36 -04002128 // Auto-combine with Linux_ and Bionic_ targets. This potentially results in
2129 // repetition and select() bloat, but use of Linux_* and Bionic_* targets is rare.
2130 // TODO(b/201423152): Look into cleanup.
2131 if os.Linux() {
2132 targetField := "Linux_" + arch.Name
Liz Kammerfdd72e62021-10-11 15:41:03 -04002133 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2134 osArchStructs = append(osArchStructs, targetStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002135 }
2136 if os.Bionic() {
2137 targetField := "Bionic_" + arch.Name
Liz Kammerfdd72e62021-10-11 15:41:03 -04002138 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2139 osArchStructs = append(osArchStructs, targetStructs...)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002140 }
Colin Cross2d295a22022-03-07 14:46:20 -08002141 if os == LinuxMusl {
2142 targetField := "Musl_" + arch.Name
2143 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2144 osArchStructs = append(osArchStructs, targetStructs...)
2145 }
2146 if os == Linux {
2147 targetField := "Glibc_" + arch.Name
2148 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2149 osArchStructs = append(osArchStructs, targetStructs...)
2150 }
Chris Parsonsa37e1952021-09-28 16:47:36 -04002151
Liz Kammerfdd72e62021-10-11 15:41:03 -04002152 targetField := GetCompoundTargetField(os, arch)
2153 targetName := fmt.Sprintf("%s_%s", os.Name, arch.Name)
2154 targetStructs := getTargetStructs(ctx, archProperties, targetField)
2155 osArchStructs = append(osArchStructs, targetStructs...)
2156
Chris Parsonsa37e1952021-09-28 16:47:36 -04002157 archOsToProp[targetName] = mergeStructs(ctx, osArchStructs, propertySet)
Liz Kammer9abd62d2021-05-21 08:37:59 -04002158 }
2159 }
Chris Parsons2dde0cb2021-10-01 14:45:30 -04002160
Liz Kammer9abd62d2021-05-21 08:37:59 -04002161 axisToProps[bazel.OsConfigurationAxis] = osToProp
2162 axisToProps[bazel.OsArchConfigurationAxis] = archOsToProp
Liz Kammer9abd62d2021-05-21 08:37:59 -04002163 return axisToProps
Jingwen Chen5d864492021-02-24 07:20:12 -05002164}
Jingwen Chen91220d72021-03-24 02:18:33 -04002165
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002166// Returns a struct matching the propertySet interface, containing properties specific to the targetName
2167// For example, given these arguments:
2168// propertySet = BaseCompilerProperties
2169// targetName = "android_arm"
2170// And given this Android.bp fragment:
2171// target:
2172// android_arm: {
2173// srcs: ["foo.c"],
2174// }
2175// android_arm64: {
2176// srcs: ["bar.c"],
2177// }
2178// }
2179// This would return a BaseCompilerProperties with BaseCompilerProperties.Srcs = ["foo.c"]
Liz Kammerfdd72e62021-10-11 15:41:03 -04002180func getTargetStructs(ctx ArchVariantContext, archProperties []interface{}, targetName string) []reflect.Value {
2181 var propertyStructs []reflect.Value
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002182 for _, archProperty := range archProperties {
2183 archPropValues := reflect.ValueOf(archProperty).Elem()
2184 targetProp := archPropValues.FieldByName("Target").Elem()
2185 targetStruct, ok := getChildPropertyStruct(ctx, targetProp, targetName, targetName)
2186 if ok {
2187 propertyStructs = append(propertyStructs, targetStruct)
Chris Parsonsa37e1952021-09-28 16:47:36 -04002188 } else {
Liz Kammerfdd72e62021-10-11 15:41:03 -04002189 return []reflect.Value{}
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002190 }
2191 }
2192
Liz Kammerfdd72e62021-10-11 15:41:03 -04002193 return propertyStructs
Chris Parsonsa37e1952021-09-28 16:47:36 -04002194}
2195
2196func mergeStructs(ctx ArchVariantContext, propertyStructs []reflect.Value, propertySet interface{}) interface{} {
Rupert Shuttleworthc194ffb2021-05-19 06:49:02 -04002197 // Create a new instance of the requested property set
2198 value := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
2199
2200 // Merge all the structs together
2201 for _, propertyStruct := range propertyStructs {
2202 mergePropertyStruct(ctx, value, propertyStruct)
2203 }
2204
2205 return value
2206}
Liz Kammere8303bd2022-02-16 09:02:48 -05002207
2208func printArchTypeStarlarkDict(dict map[ArchType][]string) string {
2209 valDict := make(map[string]string, len(dict))
2210 for k, v := range dict {
2211 valDict[k.String()] = starlark_fmt.PrintStringList(v, 1)
2212 }
2213 return starlark_fmt.PrintDict(valDict, 0)
2214}
2215
2216func printArchTypeNestedStarlarkDict(dict map[ArchType]map[string][]string) string {
2217 valDict := make(map[string]string, len(dict))
2218 for k, v := range dict {
2219 valDict[k.String()] = starlark_fmt.PrintStringListDict(v, 1)
2220 }
2221 return starlark_fmt.PrintDict(valDict, 0)
2222}
2223
2224func StarlarkArchConfigurations() string {
2225 return fmt.Sprintf(`
2226_arch_to_variants = %s
2227
2228_arch_to_cpu_variants = %s
2229
2230_arch_to_features = %s
2231
2232_android_arch_feature_for_arch_variant = %s
2233
2234arch_to_variants = _arch_to_variants
2235arch_to_cpu_variants = _arch_to_cpu_variants
2236arch_to_features = _arch_to_features
2237android_arch_feature_for_arch_variants = _android_arch_feature_for_arch_variant
2238`, printArchTypeStarlarkDict(archVariants),
2239 printArchTypeStarlarkDict(cpuVariants),
2240 printArchTypeStarlarkDict(archFeatures),
2241 printArchTypeNestedStarlarkDict(androidArchFeatureMap),
2242 )
2243}