blob: 5f636151384c39956d639603085813615aadc7e6 [file] [log] [blame]
Colin Cross5049f022015-03-18 13:28:46 -07001// Copyright 2015 Google Inc. All rights reserved.
Colin Cross3f40fa42015-01-30 17:27:36 -08002//
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
15package cc
16
17// This file contains the module types for compiling C/C++ for Android, and converts the properties
18// into the flags and filenames necessary to pass to the compiler. The final creation of the rules
19// is handled in builder.go
20
21import (
Colin Cross41955e82019-05-29 14:40:35 -070022 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080023 "io"
Dan Albert9e10cd42016-08-03 14:12:14 -070024 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "strings"
26
Colin Cross97ba0732015-03-23 17:50:24 -070027 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070028 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070029
Colin Cross635c3b02016-05-18 15:37:25 -070030 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070031 "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070032 "android/soong/fuzz"
Colin Cross5049f022015-03-18 13:28:46 -070033 "android/soong/genrule"
Rob Seymour925aa092021-08-10 20:42:03 +000034 "android/soong/snapshot"
Colin Cross3f40fa42015-01-30 17:27:36 -080035)
36
Colin Cross463a90e2015-06-17 14:20:06 -070037func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000038 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070039
Paul Duffin036e7002019-12-19 19:16:28 +000040 pctx.Import("android/soong/cc/config")
41}
42
43func RegisterCCBuildComponents(ctx android.RegistrationContext) {
44 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
45
46 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000047 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090048 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070049 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010050 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070051 ctx.BottomUp("version_selector", versionSelectorMutator).Parallel()
52 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070053 ctx.BottomUp("begin", BeginMutator).Parallel()
Inseob Kimac1e9862019-12-09 18:15:47 +090054 ctx.BottomUp("sysprop_cc", SyspropMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070055 })
Colin Cross16b23492016-01-06 14:41:07 -080056
Paul Duffin036e7002019-12-19 19:16:28 +000057 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040058 for _, san := range Sanitizers {
59 san.registerMutators(ctx)
60 }
Dan Willemsen581341d2017-02-09 16:16:31 -080061
Colin Cross0b908332019-06-19 23:00:20 -070062 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090063 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080064
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080065 ctx.BottomUp("coverage", coverageMutator).Parallel()
Stephen Craneba090d12017-05-09 15:44:35 -070066
Yi Kongeb8efc92021-12-09 18:06:29 +080067 ctx.TopDown("afdo_deps", afdoDepsMutator)
68 ctx.BottomUp("afdo", afdoMutator).Parallel()
69
Stephen Craneba090d12017-05-09 15:44:35 -070070 ctx.TopDown("lto_deps", ltoDepsMutator)
71 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090072
Jooyung Han479ca172020-10-19 18:51:07 +090073 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090074 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070075 })
Colin Crossb98c8b02016-07-29 13:44:28 -070076
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080077 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
78 // sabi mutator needs to be run after apex mutator finishes.
79 ctx.TopDown("sabi_deps", sabiDepsMutator)
80 })
81
Colin Cross57898582020-10-29 18:25:19 -070082 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070083}
84
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050085// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
86// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
87// edges to these modules.
88// This object is constructed in DepsMutator, by calling to various module delegates to set
89// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
90// dependencies.
91// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
92// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080093type Deps struct {
94 SharedLibs, LateSharedLibs []string
95 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080096 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +080097 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -070098
Chris Parsons79d66a52020-06-05 17:26:16 -040099 // Used for data dependencies adjacent to tests
100 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700101 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400102
Yo Chiang219968c2020-09-22 18:45:04 +0800103 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
104 SystemSharedLibs []string
105
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500106 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800107 StaticUnwinderIfLegacy bool
108
Colin Cross5950f382016-12-13 12:50:57 -0800109 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700110
Colin Cross81413472016-04-11 14:37:39 -0700111 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700112
Dan Willemsenb40aab62016-04-20 14:21:14 -0700113 GeneratedSources []string
114 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900115 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700116
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700117 ReexportGeneratedHeaders []string
118
Colin Crossc465efd2021-06-11 18:00:04 -0700119 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700120
121 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700122 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900123
124 // List of libs that need to be excluded for APEX variant
125 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700126}
127
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500128// PathDeps is a struct containing file paths to dependencies of a module.
129// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
130// It's used to construct flags for various build statements (such as for compiling and linking).
131// It is then passed to module decorator functions responsible for registering build statements
132// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800133type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700134 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900135 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700136 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900137 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700138 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700139 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700140
Colin Cross0de8a1e2020-09-18 14:15:30 -0700141 // Transitive static library dependencies of static libraries for use in ordering.
142 TranstiveStaticLibrariesForOrdering *android.DepSet
143
Colin Cross26c34ed2016-09-30 17:10:16 -0700144 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100145 Objs Objects
146 // Paths to .o files in dependencies that provide them. Note that these lists
147 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800148 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700149 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700150
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100151 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
152 // the libs from all whole_static_lib dependencies.
153 WholeStaticLibsFromPrebuilts android.Paths
154
Colin Cross26c34ed2016-09-30 17:10:16 -0700155 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700156 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900157 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700158
Inseob Kimd110f872019-12-06 13:15:38 +0900159 Flags []string
160 IncludeDirs android.Paths
161 SystemIncludeDirs android.Paths
162 ReexportedDirs android.Paths
163 ReexportedSystemDirs android.Paths
164 ReexportedFlags []string
165 ReexportedGeneratedHeaders android.Paths
166 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700167
Colin Cross26c34ed2016-09-30 17:10:16 -0700168 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700169 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700170
Dan Willemsena0790e32018-10-12 00:24:23 -0700171 // Path to the dynamic linker binary
172 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700173
174 // For Darwin builds, the path to the second architecture's output that should
175 // be combined with this architectures's output into a FAT MachO file.
176 DarwinSecondArchOutput android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700177}
178
Colin Cross4af21ed2019-11-04 09:37:55 -0800179// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
180// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
181// command line so they can be overridden by the local module flags).
182type LocalOrGlobalFlags struct {
183 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700184 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800185 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700186 CFlags []string // Flags that apply to C and C++ source files
187 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
188 ConlyFlags []string // Flags that apply to C source files
189 CppFlags []string // Flags that apply to C++ source files
190 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700191 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800192}
193
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500194// Flags contains various types of command line flags (and settings) for use in building build
195// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800196type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500197 // Local flags (which individual modules are responsible for). These may override global flags.
198 Local LocalOrGlobalFlags
199 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800200 Global LocalOrGlobalFlags
201
202 aidlFlags []string // Flags that apply to aidl source files
203 rsFlags []string // Flags that apply to renderscript source files
204 libFlags []string // Flags to add libraries early to the link order
205 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
206 TidyFlags []string // Flags that apply to clang-tidy
207 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700208
Colin Crossc3199482017-03-30 15:03:04 -0700209 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800210 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700211 SystemIncludeFlags []string
212
Oliver Nguyen04526782020-04-21 12:40:27 -0700213 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500214 Tidy bool // True if clang-tidy is enabled.
215 GcovCoverage bool // True if coverage files should be generated.
216 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700217 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800218
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500219 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800220 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500221 // The target-device system path to the dynamic linker.
222 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800223
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700224 CFlagsDeps android.Paths // Files depended on by compiler flags
225 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800226
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500227 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700228 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800229
Colin Cross19878da2019-03-28 14:45:07 -0700230 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700231 protoC bool // Whether to use C instead of C++
232 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700233
234 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200235 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700236}
237
Colin Crossca860ac2016-01-04 14:34:37 -0800238// Properties used to compile all C or C++ modules
239type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700240 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800241 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700242
Jiyong Parkb35a8192020-08-10 15:59:36 +0900243 // The API level that this module is built against. The APIs of this API level will be
244 // visible at build time, but use of any APIs newer than min_sdk_version will render the
245 // module unloadable on older devices. In the future it will be possible to weakly-link new
246 // APIs, making the behavior match Java: such modules will load on older devices, but
247 // calling new APIs on devices that do not support them will result in a crash.
248 //
249 // This property has the same behavior as sdk_version does for Java modules. For those
250 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
251 // does for Java code.
252 //
253 // In addition, setting this property causes two variants to be built, one for the platform
254 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800255 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700256
Jiyong Parkb35a8192020-08-10 15:59:36 +0900257 // Minimum OS API level supported by this C or C++ module. This property becomes the value
258 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
259 // this property is also used to ensure that the min_sdk_version of the containing module is
260 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
261 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
262 // min_sdk_version of the containing APEX. When the module
263 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900264 Min_sdk_version *string
265
Colin Crossc511bc52020-04-07 16:50:32 +0000266 // If true, always create an sdk variant and don't create a platform variant.
267 Sdk_variant_only *bool
268
Jiyong Parkde866cb2018-12-07 23:08:36 +0900269 AndroidMkSharedLibs []string `blueprint:"mutated"`
270 AndroidMkStaticLibs []string `blueprint:"mutated"`
271 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
272 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700273 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900274 HideFromMake bool `blueprint:"mutated"`
275 PreventInstall bool `blueprint:"mutated"`
276 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700277
Yo Chiang219968c2020-09-22 18:45:04 +0800278 // Set by DepsMutator.
279 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
280
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200281 // The name of the image this module is built for, suffixed with a '.'
Justin Yun5f7f7e82019-11-18 19:52:14 +0900282 ImageVariationPrefix string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200283
284 // The VNDK version this module is built against. If empty, the module is not
285 // build against the VNDK.
286 VndkVersion string `blueprint:"mutated"`
287
288 // Suffix for the name of Android.mk entries generated by this module
289 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800290
291 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
292 // file
293 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900294
Yifan Hong39143a92020-10-26 12:43:12 -0700295 // Make this module available when building for ramdisk.
296 // On device without a dedicated recovery partition, the module is only
297 // available after switching root into
298 // /first_stage_ramdisk. To expose the module before switching root, install
299 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800300 Ramdisk_available *bool
301
Yifan Hong39143a92020-10-26 12:43:12 -0700302 // Make this module available when building for vendor ramdisk.
303 // On device without a dedicated recovery partition, the module is only
304 // available after switching root into
305 // /first_stage_ramdisk. To expose the module before switching root, install
306 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700307 Vendor_ramdisk_available *bool
308
Jiyong Parkf9332f12018-02-01 00:54:12 +0900309 // Make this module available when building for recovery
310 Recovery_available *bool
311
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200312 // Used by imageMutator, set by ImageMutatorBegin()
313 CoreVariantNeeded bool `blueprint:"mutated"`
314 RamdiskVariantNeeded bool `blueprint:"mutated"`
315 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
316 RecoveryVariantNeeded bool `blueprint:"mutated"`
317
318 // A list of variations for the "image" mutator of the form
319 //<image name> '.' <version char>, for example, 'vendor.S'
320 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900321
322 // Allows this module to use non-APEX version of libraries. Useful
323 // for building binaries that are started before APEXes are activated.
324 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900325
326 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
327 // see soong/cc/config/vndk.go
328 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900329
330 // Used by vendor snapshot to record dependencies from snapshot modules.
331 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900332 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900333 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000334
Colin Cross1bc94122021-10-28 13:25:54 -0700335 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000336
337 // Set by factories of module types that can only be referenced from variants compiled against
338 // the SDK.
339 AlwaysSdk bool `blueprint:"mutated"`
340
341 // Variant is an SDK variant created by sdkMutator
342 IsSdkVariant bool `blueprint:"mutated"`
343 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
344 // variant to have a ".sdk" suffix.
345 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700346
347 // Normally Soong uses the directory structure to decide which modules
348 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800349 // different snapshots (vendor, recovery, etc.), but this property
350 // allows a partner to exclude a module normally thought of as a
351 // framework module from the vendor snapshot.
352 Exclude_from_vendor_snapshot *bool
353
354 // Normally Soong uses the directory structure to decide which modules
355 // should be included (framework) or excluded (non-framework) from the
356 // different snapshots (vendor, recovery, etc.), but this property
357 // allows a partner to exclude a module normally thought of as a
358 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800359 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900360
361 // List of APEXes that this module has private access to for testing purpose. The module
362 // can depend on libraries that are not exported by the APEXes and use private symbols
363 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000364 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800365
366 Target struct {
367 Platform struct {
368 // List of modules required by the core variant.
369 Required []string `android:"arch_variant"`
370
371 // List of modules not required by the core variant.
372 Exclude_required []string `android:"arch_variant"`
373 } `android:"arch_variant"`
374
375 Recovery struct {
376 // List of modules required by the recovery variant.
377 Required []string `android:"arch_variant"`
378
379 // List of modules not required by the recovery variant.
380 Exclude_required []string `android:"arch_variant"`
381 } `android:"arch_variant"`
382 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700383}
384
385type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900386 // whether this module should be allowed to be directly depended by other
387 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900388 // If set to true, two variants will be built separately, one like
389 // normal, and the other limited to the set of libraries and headers
390 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700391 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900392 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700393 // so it shouldn't have any unversioned runtime dependencies, or
394 // make assumptions about the system that may not be true in the
395 // future.
396 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900397 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900398 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900399 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900400 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900401 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700402 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
403 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900404
Justin Yunebcf0c52021-01-08 18:00:19 +0900405 // This is the same as the "vendor_available" except that the install path
406 // of the vendor variant is /odm or /vendor/odm.
407 // By replacing "vendor_available: true" with "odm_available: true", the
408 // module will install its vendor variant to the /odm partition or /vendor/odm.
409 // As the modules with "odm_available: true" still create the vendor variants,
410 // they can link to the other vendor modules as the vendor_available modules do.
411 // Also, the vendor modules can link to odm_available modules.
412 //
413 // It may not be used for VNDK modules.
414 Odm_available *bool
415
Justin Yun63e9ec72020-10-29 16:49:43 +0900416 // whether this module should be allowed to be directly depended by other
417 // modules with `product_specific: true` or `product_available: true`.
418 // If set to true, an additional product variant will be built separately
419 // that is limited to the set of libraries and headers that are exposed to
420 // /product modules.
421 //
422 // The product variant may be used with a different (newer) /system,
423 // so it shouldn't have any unversioned runtime dependencies, or
424 // make assumptions about the system that may not be true in the
425 // future.
426 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900427 // If set to false, this module becomes inaccessible from /product modules.
428 //
429 // Different from the 'vendor_available' property, the modules with
430 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
431 // library without 'product_available' may not be depended on by any other
432 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900433 //
434 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
435 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
436 Product_available *bool
437
Jiyong Park5fb8c102018-04-09 12:03:06 +0900438 // whether this module is capable of being loaded with other instance
439 // (possibly an older version) of the same module in the same process.
440 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
441 // can be double loaded in a vendor process if the library is also a
442 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
443 // explicitly marked as `double_loadable: true` by the owner, or the dependency
444 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
445 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800446
447 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
448 IsLLNDK bool `blueprint:"mutated"`
449
Colin Cross78212242021-01-06 14:51:30 -0800450 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
451 // set and the module is not listed in VndkMustUseVendorVariantList.
452 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
453
454 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
455 IsVNDKCore bool `blueprint:"mutated"`
456
457 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
458 IsVNDKSP bool `blueprint:"mutated"`
459
460 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
461 // module sets the llndk.private property.
462 IsVNDKPrivate bool `blueprint:"mutated"`
463
464 // IsVNDKProduct is set if a VNDK module sets the product_available property.
465 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700466
467 // IsVendorPublicLibrary is set for the core and product variants of a library that has
468 // vendor_public_library stubs.
469 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800470}
471
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500472// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
473// to understanding details about the type of the current module.
474// For example, one might call these functions to determine whether the current module is a static
475// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800476type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800477 static() bool
478 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700479 testBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900480 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900481 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900482 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700483 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900484 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700485 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800486 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900487 minSdkVersion() string
488 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700489 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700490 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800491 IsLlndk() bool
492 IsLlndkPublic() bool
493 isImplementationForLLNDKPublic() bool
494 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900495 isVndk() bool
496 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500497 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700498 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900499 inProduct() bool
500 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800501 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700502 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900503 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700504 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700505 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800506 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800507 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800508 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800509 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800510 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700511 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700512 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900513 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800514 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700515 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700516 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800517 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800518 isCfiAssemblySupportEnabled() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800519}
520
521type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700522 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800523 ModuleContextIntf
524}
525
526type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700527 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800528 ModuleContextIntf
529}
530
Colin Cross37047f12016-12-13 17:06:13 -0800531type DepsContext interface {
532 android.BottomUpMutatorContext
533 ModuleContextIntf
534}
535
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500536// feature represents additional (optional) steps to building cc-related modules, such as invocation
537// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800538type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800539 flags(ctx ModuleContext, flags Flags) Flags
540 props() []interface{}
541}
542
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500543// compiler is the interface for a compiler helper object. Different module decorators may implement
544// this helper differently. For example, compiling a `cc_library` may use a different build
545// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800546type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700547 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800548 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800549 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700550 compilerProps() []interface{}
551
Colin Cross76fada02016-07-27 10:31:13 -0700552 appendCflags([]string)
553 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700554 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800555}
556
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500557// linker is the interface for a linker decorator object. Individual module types can provide
558// their own implementation for this decorator, and thus specify custom logic regarding build
559// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800560type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700561 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800562 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700563 linkerFlags(ctx ModuleContext, flags Flags) Flags
564 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800565 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700566
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700567 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700568 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900569 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700570
571 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900572 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000573
574 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000575 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
576}
577
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500578// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000579type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500580 sharedLibs []string
581 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
582 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700583 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800584}
585
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500586// installer is the interface for an installer helper object. This helper is responsible for
587// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800588type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700589 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700590 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000591 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800592 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700593 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700594 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900595 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100596 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900597 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800598}
599
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800600type xref interface {
601 XrefCcFiles() android.Paths
602}
603
Colin Cross6e511a92020-07-27 21:26:48 -0700604type libraryDependencyKind int
605
606const (
607 headerLibraryDependency = iota
608 sharedLibraryDependency
609 staticLibraryDependency
610)
611
612func (k libraryDependencyKind) String() string {
613 switch k {
614 case headerLibraryDependency:
615 return "headerLibraryDependency"
616 case sharedLibraryDependency:
617 return "sharedLibraryDependency"
618 case staticLibraryDependency:
619 return "staticLibraryDependency"
620 default:
621 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
622 }
623}
624
625type libraryDependencyOrder int
626
627const (
628 earlyLibraryDependency = -1
629 normalLibraryDependency = 0
630 lateLibraryDependency = 1
631)
632
633func (o libraryDependencyOrder) String() string {
634 switch o {
635 case earlyLibraryDependency:
636 return "earlyLibraryDependency"
637 case normalLibraryDependency:
638 return "normalLibraryDependency"
639 case lateLibraryDependency:
640 return "lateLibraryDependency"
641 default:
642 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
643 }
644}
645
646// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
647// tags that have a set of predefined tag objects that are reused for each dependency, a
648// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
649// That means that comparing a libraryDependencyTag for equality will only be equal if all
650// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
651// then check individual metadata fields instead.
652type libraryDependencyTag struct {
653 blueprint.BaseDependencyTag
654
655 // These are exported so that fmt.Printf("%#v") can call their String methods.
656 Kind libraryDependencyKind
657 Order libraryDependencyOrder
658
659 wholeStatic bool
660
661 reexportFlags bool
662 explicitlyVersioned bool
663 dataLib bool
664 ndk bool
665
666 staticUnwinder bool
667
668 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900669
Cindy Zhou18417cb2020-12-10 07:12:38 -0800670 // Whether or not this dependency should skip the apex dependency check
671 skipApexAllowedDependenciesCheck bool
672
Jiyong Parke3867542020-12-03 17:28:25 +0900673 // Whether or not this dependency has to be followed for the apex variants
674 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700675}
676
677// header returns true if the libraryDependencyTag is tagging a header lib dependency.
678func (d libraryDependencyTag) header() bool {
679 return d.Kind == headerLibraryDependency
680}
681
682// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
683func (d libraryDependencyTag) shared() bool {
684 return d.Kind == sharedLibraryDependency
685}
686
687// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
688func (d libraryDependencyTag) static() bool {
689 return d.Kind == staticLibraryDependency
690}
691
Colin Cross65cb3142021-12-10 23:05:02 +0000692func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
693 if d.shared() {
694 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
695 }
696 return nil
697}
698
699var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
700
Colin Crosse9fe2942020-11-10 18:12:15 -0800701// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
702// binaries or other shared libraries are installed as dependencies.
703func (d libraryDependencyTag) InstallDepNeeded() bool {
704 return d.shared()
705}
706
707var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
708
709// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700710// libraryDependencyTag. Each tag object is created globally and reused for multiple
711// dependencies (although since the object contains no references, assigning a tag to a
712// variable and modifying it will not modify the original). Users can compare the tag
713// returned by ctx.OtherModuleDependencyTag against the global original
714type dependencyTag struct {
715 blueprint.BaseDependencyTag
716 name string
717}
718
Colin Crosse9fe2942020-11-10 18:12:15 -0800719// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
720// libraryDependencyTag, but where the dependency needs to be installed when the parent is
721// installed.
722type installDependencyTag struct {
723 blueprint.BaseDependencyTag
724 android.InstallAlwaysNeededDependencyTag
725 name string
726}
727
Colin Crossc99deeb2016-04-11 15:06:20 -0700728var (
Colin Cross6e511a92020-07-27 21:26:48 -0700729 genSourceDepTag = dependencyTag{name: "gen source"}
730 genHeaderDepTag = dependencyTag{name: "gen header"}
731 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
732 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900733 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700734 reuseObjTag = dependencyTag{name: "reuse objects"}
735 staticVariantTag = dependencyTag{name: "static variant"}
736 vndkExtDepTag = dependencyTag{name: "vndk extends"}
737 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700738 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800739 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700740 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700741 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700742)
743
Roland Levillainf89cd092019-07-29 16:22:59 +0100744func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700745 ccLibDepTag, ok := depTag.(libraryDependencyTag)
746 return ok && ccLibDepTag.shared()
747}
748
749func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
750 ccLibDepTag, ok := depTag.(libraryDependencyTag)
751 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100752}
753
Zach Johnson3df4e632020-11-06 11:56:27 -0800754func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
755 ccLibDepTag, ok := depTag.(libraryDependencyTag)
756 return ok && ccLibDepTag.header()
757}
758
Roland Levillainf89cd092019-07-29 16:22:59 +0100759func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800760 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100761}
762
763func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700764 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100765 return ok && ccDepTag == testPerSrcDepTag
766}
767
Colin Crossca860ac2016-01-04 14:34:37 -0800768// Module contains the properties and members used by all C/C++ module types, and implements
769// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500770// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
771// interface.
772//
773// To define a C/C++ related module, construct a new Module object and point its delegates to
774// type-specific structs. These delegates will be invoked to register module-specific build
775// statements which may be unique to the module type. For example, module.compiler.compile() should
776// be defined so as to register build statements which are responsible for compiling the module.
777//
778// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
779// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
780// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
781// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800782type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700783 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700784
Jiyong Parkd1063c12019-07-17 20:08:41 +0900785 android.SdkBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500786 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700787
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700788 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700789 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700790
Colin Crossca860ac2016-01-04 14:34:37 -0800791 // initialize before calling Init
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400792 hod android.HostOrDeviceSupported
793 multilib android.Multilib
794 bazelable bool
Colin Crossc472d572015-03-17 15:06:21 -0700795
Paul Duffina0843f62019-12-13 19:50:38 +0000796 // Allowable SdkMemberTypes of this module type.
797 sdkMemberTypes []android.SdkMemberType
798
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500799 // decorator delegates, initialize before calling Init
800 // these may contain module-specific implementations, and effectively allow for custom
801 // type-specific logic. These members may reference different objects or the same object.
802 // Functions of these decorators will be invoked to initialize and register type-specific
803 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500804 compiler compiler
805 linker linker
806 installer installer
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000807 bazelHandler android.BazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500808
809 features []feature
810 stl *stl
811 sanitize *sanitize
812 coverage *coverage
813 sabi *sabi
814 vndkdep *vndkdep
815 lto *lto
Yi Kongeb8efc92021-12-09 18:06:29 +0800816 afdo *afdo
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500817 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800818
Colin Cross31076b32020-10-23 17:22:06 -0700819 library libraryInterface
820
Colin Cross635c3b02016-05-18 15:37:25 -0700821 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800822
Colin Crossb98c8b02016-07-29 13:44:28 -0700823 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700824
825 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800826
827 // Flags used to compile this module
828 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700829
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800830 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700831 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900832
833 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800834 // Kythe (source file indexer) paths for this compilation module
835 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700836 // Object .o file output paths for this compilation module
837 objFiles android.Paths
838 // Tidy .tidy file output paths for this compilation module
839 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900840
841 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700842 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700843
844 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700845}
846
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200847func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400848 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
849 if b, ok := c.compiler.(*baseCompiler); ok {
850 hasAidl = b.hasSrcExt(".aidl")
851 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
852 hasProto = b.hasSrcExt(".proto")
853 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
854 hasSysprop = b.hasSrcExt(".sysprop")
855 hasWinMsg = b.hasSrcExt(".mc")
856 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
857 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200858 c.AndroidModuleBase().AddJSONData(d)
859 (*d)["Cc"] = map[string]interface{}{
860 "SdkVersion": c.SdkVersion(),
861 "MinSdkVersion": c.MinSdkVersion(),
862 "VndkVersion": c.VndkVersion(),
863 "ProductSpecific": c.ProductSpecific(),
864 "SocSpecific": c.SocSpecific(),
865 "DeviceSpecific": c.DeviceSpecific(),
866 "InProduct": c.InProduct(),
867 "InVendor": c.InVendor(),
868 "InRamdisk": c.InRamdisk(),
869 "InVendorRamdisk": c.InVendorRamdisk(),
870 "InRecovery": c.InRecovery(),
871 "VendorAvailable": c.VendorAvailable(),
872 "ProductAvailable": c.ProductAvailable(),
873 "RamdiskAvailable": c.RamdiskAvailable(),
874 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
875 "RecoveryAvailable": c.RecoveryAvailable(),
876 "OdmAvailable": c.OdmAvailable(),
877 "InstallInData": c.InstallInData(),
878 "InstallInRamdisk": c.InstallInRamdisk(),
879 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
880 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
881 "InstallInRecovery": c.InstallInRecovery(),
882 "InstallInRoot": c.InstallInRoot(),
883 "IsVndk": c.IsVndk(),
884 "IsVndkExt": c.IsVndkExt(),
885 "IsVndkPrivate": c.IsVndkPrivate(),
886 "IsVndkSp": c.IsVndkSp(),
887 "IsLlndk": c.IsLlndk(),
888 "IsLlndkPublic": c.IsLlndkPublic(),
889 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
890 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
891 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
892 "ApexSdkVersion": c.apexSdkVersion,
893 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400894 "AidlSrcs": hasAidl,
895 "LexSrcs": hasLex,
896 "ProtoSrcs": hasProto,
897 "RenderscriptSrcs": hasRenderscript,
898 "SyspropSrcs": hasSysprop,
899 "WinMsgSrcs": hasWinMsg,
900 "YaccSrsc": hasYacc,
901 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200902 }
903}
904
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500905func (c *Module) SetPreventInstall() {
906 c.Properties.PreventInstall = true
907}
908
909func (c *Module) SetHideFromMake() {
910 c.Properties.HideFromMake = true
911}
912
Ivan Lozanod7586b62021-04-01 09:49:36 -0400913func (c *Module) HiddenFromMake() bool {
914 return c.Properties.HideFromMake
915}
916
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800917func (c *Module) RequiredModuleNames() []string {
918 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
919 if c.ImageVariation().Variation == android.CoreVariation {
920 required = append(required, c.Properties.Target.Platform.Required...)
921 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
922 } else if c.InRecovery() {
923 required = append(required, c.Properties.Target.Recovery.Required...)
924 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
925 }
926 return android.FirstUniqueStrings(required)
927}
928
Ivan Lozano52767be2019-10-18 14:49:46 -0700929func (c *Module) Toc() android.OptionalPath {
930 if c.linker != nil {
931 if library, ok := c.linker.(libraryInterface); ok {
932 return library.toc()
933 }
934 }
935 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
936}
937
938func (c *Module) ApiLevel() string {
939 if c.linker != nil {
940 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700941 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700942 }
943 }
944 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
945}
946
947func (c *Module) Static() bool {
948 if c.linker != nil {
949 if library, ok := c.linker.(libraryInterface); ok {
950 return library.static()
951 }
952 }
953 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
954}
955
956func (c *Module) Shared() bool {
957 if c.linker != nil {
958 if library, ok := c.linker.(libraryInterface); ok {
959 return library.shared()
960 }
961 }
962 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
963}
964
965func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000966 if c.stl != nil {
967 return c.stl.Properties.SelectedStl
968 }
969 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700970}
971
972func (c *Module) ToolchainLibrary() bool {
973 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
974 return true
975 }
976 return false
977}
978
979func (c *Module) NdkPrebuiltStl() bool {
980 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
981 return true
982 }
983 return false
984}
985
986func (c *Module) StubDecorator() bool {
987 if _, ok := c.linker.(*stubDecorator); ok {
988 return true
989 }
990 return false
991}
992
993func (c *Module) SdkVersion() string {
994 return String(c.Properties.Sdk_version)
995}
996
Artur Satayev480e25b2020-04-27 18:53:18 +0100997func (c *Module) MinSdkVersion() string {
998 return String(c.Properties.Min_sdk_version)
999}
1000
Jiyong Park5df7bd32021-08-25 16:18:46 +09001001func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001002 if linker, ok := c.linker.(*objectLinker); ok {
1003 return linker.isCrt()
1004 }
1005 return false
1006}
1007
Jiyong Park5df7bd32021-08-25 16:18:46 +09001008func (c *Module) SplitPerApiLevel() bool {
1009 return c.canUseSdk() && c.isCrt()
1010}
1011
Colin Crossc511bc52020-04-07 16:50:32 +00001012func (c *Module) AlwaysSdk() bool {
1013 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1014}
1015
Ivan Lozano183a3212019-10-18 14:18:45 -07001016func (c *Module) CcLibrary() bool {
1017 if c.linker != nil {
1018 if _, ok := c.linker.(*libraryDecorator); ok {
1019 return true
1020 }
Colin Crossd48fe732020-09-23 20:37:24 -07001021 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1022 return true
1023 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001024 }
1025 return false
1026}
1027
1028func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001029 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001030 return true
1031 }
1032 return false
1033}
1034
Ivan Lozano2b262972019-11-21 12:30:50 -08001035func (c *Module) NonCcVariants() bool {
1036 return false
1037}
1038
Ivan Lozano183a3212019-10-18 14:18:45 -07001039func (c *Module) SetStatic() {
1040 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001041 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001042 library.setStatic()
1043 return
1044 }
1045 }
1046 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1047}
1048
1049func (c *Module) SetShared() {
1050 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001051 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001052 library.setShared()
1053 return
1054 }
1055 }
1056 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1057}
1058
1059func (c *Module) BuildStaticVariant() bool {
1060 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001061 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001062 return library.buildStatic()
1063 }
1064 }
1065 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1066}
1067
1068func (c *Module) BuildSharedVariant() bool {
1069 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001070 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001071 return library.buildShared()
1072 }
1073 }
1074 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1075}
1076
1077func (c *Module) Module() android.Module {
1078 return c
1079}
1080
Jiyong Parkc20eee32018-09-05 22:36:17 +09001081func (c *Module) OutputFile() android.OptionalPath {
1082 return c.outputFile
1083}
1084
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001085func (c *Module) CoverageFiles() android.Paths {
1086 if c.linker != nil {
1087 if library, ok := c.linker.(libraryInterface); ok {
1088 return library.objs().coverageFiles
1089 }
1090 }
1091 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1092}
1093
Ivan Lozano183a3212019-10-18 14:18:45 -07001094var _ LinkableInterface = (*Module)(nil)
1095
Jiyong Park719b4462019-01-13 00:39:51 +09001096func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001097 if c.linker != nil {
1098 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001099 }
1100 return nil
1101}
1102
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001103func (c *Module) CoverageOutputFile() android.OptionalPath {
1104 if c.linker != nil {
1105 return c.linker.coverageOutputFilePath()
1106 }
1107 return android.OptionalPath{}
1108}
1109
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001110func (c *Module) RelativeInstallPath() string {
1111 if c.installer != nil {
1112 return c.installer.relativeInstallPath()
1113 }
1114 return ""
1115}
1116
Jooyung Han344d5432019-08-23 11:17:39 +09001117func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001118 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001119}
1120
Colin Cross36242852017-06-23 15:06:31 -07001121func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001122 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001123 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001124 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001125 }
1126 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001127 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001128 }
1129 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001130 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001131 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001132 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001133 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001134 }
Colin Cross16b23492016-01-06 14:41:07 -08001135 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001136 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001137 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001138 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001139 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001140 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001141 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001142 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001143 }
Justin Yun8effde42017-06-23 19:24:43 +09001144 if c.vndkdep != nil {
1145 c.AddProperties(c.vndkdep.props()...)
1146 }
Stephen Craneba090d12017-05-09 15:44:35 -07001147 if c.lto != nil {
1148 c.AddProperties(c.lto.props()...)
1149 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001150 if c.afdo != nil {
1151 c.AddProperties(c.afdo.props()...)
1152 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001153 if c.pgo != nil {
1154 c.AddProperties(c.pgo.props()...)
1155 }
Colin Crossca860ac2016-01-04 14:34:37 -08001156 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001157 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001158 }
Colin Crossc472d572015-03-17 15:06:21 -07001159
Colin Cross36242852017-06-23 15:06:31 -07001160 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001161 if c.bazelable {
1162 android.InitBazelModule(c)
1163 }
Jiyong Park7916bfc2019-09-30 19:13:12 +09001164 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001165 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001166 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001167
Colin Cross36242852017-06-23 15:06:31 -07001168 return c
Colin Crossc472d572015-03-17 15:06:21 -07001169}
1170
Ivan Lozano52767be2019-10-18 14:49:46 -07001171func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001172 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001173}
1174
Colin Crossc511bc52020-04-07 16:50:32 +00001175func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001176 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1177 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001178}
1179
1180func (c *Module) UseSdk() bool {
1181 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001182 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001183 }
1184 return false
1185}
1186
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001187func (c *Module) isCoverageVariant() bool {
1188 return c.coverage.Properties.IsCoverageVariant
1189}
1190
Colin Cross95f1ca02020-10-29 20:47:22 -07001191func (c *Module) IsNdk(config android.Config) bool {
1192 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001193}
1194
Colin Cross127bb8b2020-12-16 16:46:01 -08001195func (c *Module) IsLlndk() bool {
1196 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001197}
1198
Colin Cross127bb8b2020-12-16 16:46:01 -08001199func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001200 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001201}
1202
Colin Cross1f3f1302021-04-26 18:37:44 -07001203func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001204 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001205 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001206}
1207
Colin Cross5271fea2021-04-27 13:06:04 -07001208func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1209 lib := moduleLibraryInterface(m)
1210 return lib != nil && (lib.hasVendorPublicLibrary())
1211}
1212
1213// IsVendorPublicLibrary returns true for vendor public libraries.
1214func (c *Module) IsVendorPublicLibrary() bool {
1215 return c.VendorProperties.IsVendorPublicLibrary
1216}
1217
Ivan Lozanod7586b62021-04-01 09:49:36 -04001218func (c *Module) HasLlndkStubs() bool {
1219 lib := moduleLibraryInterface(c)
1220 return lib != nil && lib.hasLLNDKStubs()
1221}
1222
1223func (c *Module) StubsVersion() string {
1224 if lib, ok := c.linker.(versionedInterface); ok {
1225 return lib.stubsVersion()
1226 }
1227 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1228}
1229
Colin Cross127bb8b2020-12-16 16:46:01 -08001230// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1231// and does not set llndk.vendor_available: false.
1232func (c *Module) isImplementationForLLNDKPublic() bool {
1233 library, _ := c.library.(*libraryDecorator)
1234 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001235 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001236}
1237
Justin Yunfd9e8042020-12-23 18:23:14 +09001238// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001239func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001240 // Check if VNDK-core-private or VNDK-SP-private
1241 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001242 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001243 }
1244
1245 // Check if LLNDK-private
1246 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001247 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001248 }
1249
1250 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001251}
1252
Ivan Lozano52767be2019-10-18 14:49:46 -07001253func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001254 if vndkdep := c.vndkdep; vndkdep != nil {
1255 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001256 }
1257 return false
1258}
1259
Yi Kong7e53c572018-02-14 18:16:12 +08001260func (c *Module) isPgoCompile() bool {
1261 if pgo := c.pgo; pgo != nil {
1262 return pgo.Properties.PgoCompile
1263 }
1264 return false
1265}
1266
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001267func (c *Module) isNDKStubLibrary() bool {
1268 if _, ok := c.compiler.(*stubDecorator); ok {
1269 return true
1270 }
1271 return false
1272}
1273
Ivan Lozanod7586b62021-04-01 09:49:36 -04001274func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001275 if vndkdep := c.vndkdep; vndkdep != nil {
1276 return vndkdep.isVndkSp()
1277 }
1278 return false
1279}
1280
Ivan Lozanof9e21722020-12-02 09:00:51 -05001281func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001282 if vndkdep := c.vndkdep; vndkdep != nil {
1283 return vndkdep.isVndkExt()
1284 }
1285 return false
1286}
1287
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001288func (c *Module) SubName() string {
1289 return c.Properties.SubName
1290}
1291
Ivan Lozano52767be2019-10-18 14:49:46 -07001292func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001293 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001294}
1295
Logan Chienf3511742017-10-31 18:04:35 +08001296func (c *Module) getVndkExtendsModuleName() string {
1297 if vndkdep := c.vndkdep; vndkdep != nil {
1298 return vndkdep.getVndkExtendsModuleName()
1299 }
1300 return ""
1301}
1302
Jiyong Park25fc6a92018-11-18 18:02:45 +09001303func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001304 if lib := c.library; lib != nil {
1305 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001306 }
1307 return false
1308}
1309
1310func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001311 if lib := c.library; lib != nil {
1312 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001313 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001314 return false
1315}
1316
Colin Cross0477b422020-10-13 18:43:54 -07001317// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1318// the implementation. If it is an implementation library it returns its own name.
1319func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1320 name := ctx.OtherModuleName(c)
1321 if versioned, ok := c.linker.(versionedInterface); ok {
1322 name = versioned.implementationModuleName(name)
1323 }
1324 return name
1325}
1326
Martin Stjernholm2856c662020-12-02 15:03:42 +00001327// Similar to ImplementationModuleName, but uses the Make variant of the module
1328// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1329// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1330// under the premise that the prebuilt module overrides its source counterpart
1331// if it is exposed to Make).
1332func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1333 name := c.BaseModuleName()
1334 if versioned, ok := c.linker.(versionedInterface); ok {
1335 name = versioned.implementationModuleName(name)
1336 }
1337 return name
1338}
1339
Jiyong Park7d55b612021-06-11 17:22:09 +09001340func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001341 return Bool(c.Properties.Bootstrap)
1342}
1343
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001344func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001345 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1346 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1347 return false
1348 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001349 return c.linker != nil && c.linker.nativeCoverage()
1350}
1351
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001352func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001353 if p, ok := c.linker.(SnapshotInterface); ok {
1354 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001355 }
1356 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001357}
1358
Bill Peckham945441c2020-08-31 16:07:58 -07001359func (c *Module) ExcludeFromVendorSnapshot() bool {
1360 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1361}
1362
Jose Galmesf7294582020-11-13 12:07:36 -08001363func (c *Module) ExcludeFromRecoverySnapshot() bool {
1364 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1365}
1366
Jiyong Parkf1194352019-02-25 11:05:47 +09001367func isBionic(name string) bool {
1368 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001369 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001370 return true
1371 }
1372 return false
1373}
1374
Martin Stjernholm279de572019-09-10 23:18:20 +01001375func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001376 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001377 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001378 }
1379 return isBionic(name)
1380}
1381
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001382func (c *Module) XrefCcFiles() android.Paths {
1383 return c.kytheFiles
1384}
1385
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001386func (c *Module) isCfiAssemblySupportEnabled() bool {
1387 return c.sanitize != nil &&
1388 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1389}
1390
Inseob Kim800d1142021-06-14 12:03:51 +09001391func (c *Module) InstallInRoot() bool {
1392 return c.installer != nil && c.installer.installInRoot()
1393}
1394
Colin Crossca860ac2016-01-04 14:34:37 -08001395type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001396 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001397 moduleContextImpl
1398}
1399
Colin Cross37047f12016-12-13 17:06:13 -08001400type depsContext struct {
1401 android.BottomUpMutatorContext
1402 moduleContextImpl
1403}
1404
Colin Crossca860ac2016-01-04 14:34:37 -08001405type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001406 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001407 moduleContextImpl
1408}
1409
1410type moduleContextImpl struct {
1411 mod *Module
1412 ctx BaseModuleContext
1413}
1414
Colin Crossb98c8b02016-07-29 13:44:28 -07001415func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001416 return ctx.mod.toolchain(ctx.ctx)
1417}
1418
1419func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001420 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001421}
1422
1423func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001424 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001425}
1426
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001427func (ctx *moduleContextImpl) testBinary() bool {
1428 return ctx.mod.testBinary()
1429}
1430
Jiyong Park1d1119f2019-07-29 21:27:18 +09001431func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001432 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001433}
1434
Inseob Kim7f283f42020-06-01 21:53:49 +09001435func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001436 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001437}
1438
Inseob Kim1042d292020-06-01 23:23:05 +09001439func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001440 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001441}
1442
Jooyung Hanccce2f22020-03-07 03:45:53 +09001443func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001444 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001445}
1446
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001447func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001448 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001449}
1450
1451func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001452 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001453 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001454 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001455 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001456 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001457 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001458 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001459 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001460 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001461 }
1462 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001463}
1464
Jiyong Parkb35a8192020-08-10 15:59:36 +09001465func (ctx *moduleContextImpl) minSdkVersion() string {
1466 ver := ctx.mod.MinSdkVersion()
1467 if ver == "apex_inherit" && !ctx.isForPlatform() {
1468 ver = ctx.apexSdkVersion().String()
1469 }
1470 if ver == "apex_inherit" || ver == "" {
1471 ver = ctx.sdkVersion()
1472 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001473 // For crt objects, the meaning of min_sdk_version is very different from other types of
1474 // module. For them, min_sdk_version defines the oldest version that the build system will
1475 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1476 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1477 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001478 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1479 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1480 // support such an old version. The version is set to the later version in case when the
1481 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1482 // it's for an APEX.
1483 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1484 if ctx.isForPlatform() {
1485 ver = strconv.Itoa(android.FutureApiLevelInt)
1486 } else { // for apex
1487 ver = ctx.apexSdkVersion().String()
1488 if ver == "" { // in case when min_sdk_version was not set by the APEX
1489 ver = ctx.sdkVersion()
1490 }
1491 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001492 }
1493
Jiyong Parkb35a8192020-08-10 15:59:36 +09001494 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1495 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1496 minSdkVersionInt, err2 := strconv.Atoi(ver)
1497 if err == nil && err2 == nil {
1498 if sdkVersionInt < minSdkVersionInt {
1499 return strconv.Itoa(sdkVersionInt)
1500 }
1501 }
1502 return ver
1503}
1504
1505func (ctx *moduleContextImpl) isSdkVariant() bool {
1506 return ctx.mod.IsSdkVariant()
1507}
1508
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001509func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001510 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001511}
Justin Yun8effde42017-06-23 19:24:43 +09001512
Colin Cross95f1ca02020-10-29 20:47:22 -07001513func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1514 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001515}
1516
Colin Cross127bb8b2020-12-16 16:46:01 -08001517func (ctx *moduleContextImpl) IsLlndk() bool {
1518 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001519}
1520
Colin Cross127bb8b2020-12-16 16:46:01 -08001521func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1522 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001523}
1524
Colin Cross127bb8b2020-12-16 16:46:01 -08001525func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1526 return ctx.mod.isImplementationForLLNDKPublic()
1527}
1528
1529func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1530 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001531}
1532
Logan Chienf3511742017-10-31 18:04:35 +08001533func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001534 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001535}
1536
Yi Kong7e53c572018-02-14 18:16:12 +08001537func (ctx *moduleContextImpl) isPgoCompile() bool {
1538 return ctx.mod.isPgoCompile()
1539}
1540
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001541func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1542 return ctx.mod.isNDKStubLibrary()
1543}
1544
Justin Yun8effde42017-06-23 19:24:43 +09001545func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001546 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001547}
1548
Ivan Lozanof9e21722020-12-02 09:00:51 -05001549func (ctx *moduleContextImpl) IsVndkExt() bool {
1550 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001551}
1552
Colin Cross5271fea2021-04-27 13:06:04 -07001553func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1554 return ctx.mod.IsVendorPublicLibrary()
1555}
1556
Vic Yangefd249e2018-11-12 20:19:56 -08001557func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001558 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001559}
1560
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001561func (ctx *moduleContextImpl) selectedStl() string {
1562 if stl := ctx.mod.stl; stl != nil {
1563 return stl.Properties.SelectedStl
1564 }
1565 return ""
1566}
1567
Ivan Lozanobd721262018-11-27 14:33:03 -08001568func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1569 return ctx.mod.linker.useClangLld(actx)
1570}
1571
Colin Crossce75d2c2016-10-06 16:12:58 -07001572func (ctx *moduleContextImpl) baseModuleName() string {
1573 return ctx.mod.ModuleBase.BaseModuleName()
1574}
1575
Logan Chienf3511742017-10-31 18:04:35 +08001576func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1577 return ctx.mod.getVndkExtendsModuleName()
1578}
1579
Logan Chiene274fc92019-12-03 11:18:32 -08001580func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001581 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001582}
1583
Colin Crosse07f2312020-08-13 11:24:56 -07001584func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001585 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001586}
1587
Dan Albertc8060532020-07-22 22:32:17 -07001588func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001589 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001590}
1591
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001592func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001593 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001594}
1595
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001596func (ctx *moduleContextImpl) nativeCoverage() bool {
1597 return ctx.mod.nativeCoverage()
1598}
1599
Colin Cross56a83212020-09-15 18:30:11 -07001600func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1601 return ctx.mod.DirectlyInAnyApex()
1602}
1603
Colin Cross95b07f22020-12-16 11:06:50 -08001604func (ctx *moduleContextImpl) isPreventInstall() bool {
1605 return ctx.mod.Properties.PreventInstall
1606}
1607
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001608func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1609 return ctx.mod.isCfiAssemblySupportEnabled()
1610}
1611
Colin Cross635c3b02016-05-18 15:37:25 -07001612func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001613 return &Module{
1614 hod: hod,
1615 multilib: multilib,
1616 }
1617}
1618
Colin Cross635c3b02016-05-18 15:37:25 -07001619func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001620 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001621 module.features = []feature{
1622 &tidyFeature{},
1623 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001624 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001625 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001626 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001627 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001628 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001629 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001630 module.afdo = &afdo{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001631 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001632 return module
1633}
1634
Colin Crossce75d2c2016-10-06 16:12:58 -07001635func (c *Module) Prebuilt() *android.Prebuilt {
1636 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1637 return p.prebuilt()
1638 }
1639 return nil
1640}
1641
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001642func (c *Module) IsPrebuilt() bool {
1643 return c.Prebuilt() != nil
1644}
1645
Colin Crossce75d2c2016-10-06 16:12:58 -07001646func (c *Module) Name() string {
1647 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001648 if p, ok := c.linker.(interface {
1649 Name(string) string
1650 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001651 name = p.Name(name)
1652 }
1653 return name
1654}
1655
Alex Light3d673592019-01-18 14:37:31 -08001656func (c *Module) Symlinks() []string {
1657 if p, ok := c.installer.(interface {
1658 symlinkList() []string
1659 }); ok {
1660 return p.symlinkList()
1661 }
1662 return nil
1663}
1664
Roland Levillainf89cd092019-07-29 16:22:59 +01001665func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1666 test, ok := c.linker.(testPerSrc)
1667 return ok && test.isAllTestsVariation()
1668}
1669
Chris Parsons216e10a2020-07-09 17:12:52 -04001670func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001671 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001672 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001673 }); ok {
1674 return p.dataPaths()
1675 }
1676 return nil
1677}
1678
Justin Yun5f7f7e82019-11-18 19:52:14 +09001679func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1680 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1681 // "current", it will append the VNDK version to the name suffix.
1682 var vndkVersion string
1683 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001684 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001685 if c.ProductSpecific() {
1686 // If the module is product specific with 'product_specific: true',
1687 // do not add a name suffix because it is a base module.
1688 return ""
1689 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001690 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
Matthew Maurer52af5b02021-05-27 10:01:36 -07001691 nameSuffix = ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001692 } else {
1693 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001694 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001695 }
1696 if vndkVersion == "current" {
1697 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1698 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001699 if c.Properties.VndkVersion != vndkVersion && c.Properties.VndkVersion != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001700 // add version suffix only if the module is using different vndk version than the
1701 // version in product or vendor partition.
1702 nameSuffix += "." + c.Properties.VndkVersion
1703 }
1704 return nameSuffix
1705}
1706
Chris Parsons8d6e4332021-02-22 16:13:50 -05001707func (c *Module) setSubnameProperty(actx android.ModuleContext) {
Inseob Kim64c43952019-08-26 16:52:35 +09001708 c.Properties.SubName = ""
1709
1710 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07001711 c.Properties.SubName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001712 }
1713
Colin Cross127bb8b2020-12-16 16:46:01 -08001714 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001715 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001716 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1717 // added for product variant only when we have vendor and product variants with core
1718 // variant. The suffix is not added for vendor-only or product-only module.
1719 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
Colin Cross5271fea2021-04-27 13:06:04 -07001720 } else if c.IsVendorPublicLibrary() {
1721 c.Properties.SubName += vendorPublicLibrarySuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001722 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001723 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1724 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001725 c.Properties.SubName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001726 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07001727 c.Properties.SubName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001728 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001729 c.Properties.SubName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001730 } else if c.InRecovery() && !c.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08001731 c.Properties.SubName += RecoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001732 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001733 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001734 if c.SplitPerApiLevel() {
1735 c.Properties.SubName += "." + c.SdkVersion()
1736 }
Inseob Kim64c43952019-08-26 16:52:35 +09001737 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001738}
1739
1740// Returns true if Bazel was successfully used for the analysis of this module.
1741func (c *Module) maybeGenerateBazelActions(actx android.ModuleContext) bool {
Chris Parsons77acf2e2021-12-03 17:27:16 -05001742 var bazelModuleLabel string
1743 if actx.ModuleType() == "cc_library" && c.static() {
1744 // cc_library is a special case in bp2build; two targets are generated -- one for each
1745 // of the shared and static variants. The shared variant keeps the module name, but the
1746 // static variant uses a different suffixed name.
1747 bazelModuleLabel = bazelLabelForStaticModule(actx, c)
1748 } else {
1749 bazelModuleLabel = c.GetBazelLabel(actx, c)
1750 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001751 bazelActionsUsed := false
Chris Parsons18266212021-09-23 13:42:38 -04001752 // Mixed builds mode is disabled for modules outside of device OS.
1753 // TODO(b/200841190): Support non-device OS in mixed builds.
Chris Parsons494eef32021-11-09 10:29:52 -05001754 if c.MixedBuildsEnabled(actx) && c.bazelHandler != nil {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +00001755 bazelActionsUsed = c.bazelHandler.GenerateBazelBuildActions(actx, bazelModuleLabel)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001756 }
1757 return bazelActionsUsed
1758}
1759
1760func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1761 // TODO(cparsons): Any logic in this method occurring prior to querying Bazel should be
1762 // requested from Bazel instead.
1763
1764 // Handle the case of a test module split by `test_per_src` mutator.
1765 //
1766 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1767 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1768 // module and return early, as this module does not produce an output file per se.
1769 if c.IsTestPerSrcAllTestsVariation() {
1770 c.outputFile = android.OptionalPath{}
1771 return
1772 }
1773
1774 c.setSubnameProperty(actx)
1775 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1776 if !apexInfo.IsForPlatform() {
1777 c.hideApexVariantFromMake = true
1778 }
1779
Chris Parsonseefc9e62021-04-02 17:36:47 -04001780 c.makeLinkType = GetMakeLinkType(actx, c)
1781
Colin Crossca860ac2016-01-04 14:34:37 -08001782 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001783 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001784 moduleContextImpl: moduleContextImpl{
1785 mod: c,
1786 },
1787 }
1788 ctx.ctx = ctx
1789
Chris Parsons94a0bba2021-06-04 15:03:47 -04001790 if c.maybeGenerateBazelActions(actx) {
1791 c.maybeInstall(ctx, apexInfo)
1792 return
1793 }
1794
Colin Crossf18e1102017-11-16 14:33:08 -08001795 deps := c.depsToPaths(ctx)
1796 if ctx.Failed() {
1797 return
1798 }
1799
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001800 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1801 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1802 }
1803
Colin Crossca860ac2016-01-04 14:34:37 -08001804 flags := Flags{
1805 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001806 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001807 }
Colin Crossca860ac2016-01-04 14:34:37 -08001808 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001809 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001810 }
1811 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001812 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001813 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001814 if c.stl != nil {
1815 flags = c.stl.flags(ctx, flags)
1816 }
Colin Cross16b23492016-01-06 14:41:07 -08001817 if c.sanitize != nil {
1818 flags = c.sanitize.flags(ctx, flags)
1819 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001820 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001821 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001822 }
Stephen Craneba090d12017-05-09 15:44:35 -07001823 if c.lto != nil {
1824 flags = c.lto.flags(ctx, flags)
1825 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001826 if c.afdo != nil {
1827 flags = c.afdo.flags(ctx, flags)
1828 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001829 if c.pgo != nil {
1830 flags = c.pgo.flags(ctx, flags)
1831 }
Colin Crossca860ac2016-01-04 14:34:37 -08001832 for _, feature := range c.features {
1833 flags = feature.flags(ctx, flags)
1834 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001835 if ctx.Failed() {
1836 return
1837 }
1838
Colin Cross4af21ed2019-11-04 09:37:55 -08001839 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1840 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1841 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001842
Colin Cross4af21ed2019-11-04 09:37:55 -08001843 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001844
1845 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001846 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001847 }
1848 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001849 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001850 }
1851
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001852 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001853 // We need access to all the flags seen by a source file.
1854 if c.sabi != nil {
1855 flags = c.sabi.flags(ctx, flags)
1856 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001857
Colin Cross4af21ed2019-11-04 09:37:55 -08001858 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001859
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001860 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001861 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001862 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001863 if ctx.Failed() {
1864 return
1865 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001866 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07001867 c.objFiles = objs.objFiles
1868 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001869 }
1870
Colin Crossca860ac2016-01-04 14:34:37 -08001871 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001872 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001873 if ctx.Failed() {
1874 return
1875 }
Colin Cross635c3b02016-05-18 15:37:25 -07001876 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001877
Chris Parsons94a0bba2021-06-04 15:03:47 -04001878 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001879
Jose Galmes6f843bc2020-12-11 13:36:29 -08001880 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
1881 // RECOVERY_SNAPSHOT_VERSION is current.
1882 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001883 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001884 i.collectHeadersForSnapshot(ctx)
1885 }
1886 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001887 }
Colin Cross5049f022015-03-18 13:28:46 -07001888
Chris Parsons94a0bba2021-06-04 15:03:47 -04001889 c.maybeInstall(ctx, apexInfo)
1890}
1891
1892func (c *Module) maybeUnhideFromMake() {
1893 // If a lib is directly included in any of the APEXes or is not available to the
1894 // platform (which is often the case when the stub is provided as a prebuilt),
1895 // unhide the stubs variant having the latest version gets visible to make. In
1896 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1897 // force anything in the make world to link against the stubs library. (unless it
1898 // is explicitly referenced via .bootstrap suffix or the module is marked with
1899 // 'bootstrap: true').
1900 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
1901 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
1902 c.IsStubs() && !c.InVendorRamdisk() {
1903 c.Properties.HideFromMake = false // unhide
1904 // Note: this is still non-installable
1905 }
1906}
1907
1908func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07001909 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001910 // If the module has been specifically configure to not be installed then
1911 // hide from make as otherwise it will break when running inside make
1912 // as the output path to install will not be specified. Not all uninstallable
1913 // modules can be hidden from make as some are needed for resolving make side
1914 // dependencies.
1915 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001916 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001917 c.SkipInstall()
1918 }
1919
1920 // Still call c.installer.install though, the installs will be stored as PackageSpecs
1921 // to allow using the outputs in a genrule.
1922 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001923 c.installer.install(ctx, c.outputFile.Path())
1924 if ctx.Failed() {
1925 return
Colin Crossca860ac2016-01-04 14:34:37 -08001926 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001927 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001928}
1929
Colin Cross0ea8ba82019-06-06 14:33:29 -07001930func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001931 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05001932 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08001933 }
Colin Crossca860ac2016-01-04 14:34:37 -08001934 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001935}
1936
Colin Crossca860ac2016-01-04 14:34:37 -08001937func (c *Module) begin(ctx BaseModuleContext) {
1938 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001939 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001940 }
Colin Crossca860ac2016-01-04 14:34:37 -08001941 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001942 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001943 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001944 if c.stl != nil {
1945 c.stl.begin(ctx)
1946 }
Colin Cross16b23492016-01-06 14:41:07 -08001947 if c.sanitize != nil {
1948 c.sanitize.begin(ctx)
1949 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001950 if c.coverage != nil {
1951 c.coverage.begin(ctx)
1952 }
Stephen Craneba090d12017-05-09 15:44:35 -07001953 if c.lto != nil {
1954 c.lto.begin(ctx)
1955 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001956 if c.afdo != nil {
1957 c.afdo.begin(ctx)
1958 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001959 if c.pgo != nil {
1960 c.pgo.begin(ctx)
1961 }
Dan Albert92fe7402020-07-15 13:33:30 -07001962 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001963 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001964 if err != nil {
1965 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001966 c.Properties.Sdk_version = nil
1967 } else {
1968 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001969 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001970 }
Colin Crossca860ac2016-01-04 14:34:37 -08001971}
1972
Colin Cross37047f12016-12-13 17:06:13 -08001973func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001974 deps := Deps{}
1975
1976 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001977 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001978 }
1979 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001980 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001981 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001982 if c.stl != nil {
1983 deps = c.stl.deps(ctx, deps)
1984 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001985 if c.coverage != nil {
1986 deps = c.coverage.deps(ctx, deps)
1987 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001988
Colin Crossb6715442017-10-24 11:13:31 -07001989 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1990 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1991 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1992 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1993 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1994 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001995 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001996
Liz Kammer356f7d42021-01-26 09:18:53 -05001997 // In Bazel conversion mode, we dependency and build validations will occur in Bazel, so there is
1998 // no need to do so in Soong.
1999 if ctx.BazelConversionMode() {
2000 return deps
2001 }
2002
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002003 for _, lib := range deps.ReexportSharedLibHeaders {
2004 if !inList(lib, deps.SharedLibs) {
2005 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2006 }
2007 }
2008
2009 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002010 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2011 ctx.PropertyErrorf("export_static_lib_headers", "Static library not in static_libs or whole_static_libs: '%s'", lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002012 }
2013 }
2014
Colin Cross5950f382016-12-13 12:50:57 -08002015 for _, lib := range deps.ReexportHeaderLibHeaders {
2016 if !inList(lib, deps.HeaderLibs) {
2017 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2018 }
2019 }
2020
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002021 for _, gen := range deps.ReexportGeneratedHeaders {
2022 if !inList(gen, deps.GeneratedHeaders) {
2023 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2024 }
2025 }
2026
Colin Crossc99deeb2016-04-11 15:06:20 -07002027 return deps
2028}
2029
Dan Albert7e9d2952016-08-04 13:02:36 -07002030func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002031 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002032 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002033 moduleContextImpl: moduleContextImpl{
2034 mod: c,
2035 },
2036 }
2037 ctx.ctx = ctx
2038
Colin Crossca860ac2016-01-04 14:34:37 -08002039 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002040}
2041
Jiyong Park7ed9de32018-10-15 22:25:07 +09002042// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002043func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002044 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2045 version := name[sharp+1:]
2046 libname := name[:sharp]
2047 return libname, version
2048 }
2049 return name, ""
2050}
2051
Dan Albert92fe7402020-07-15 13:33:30 -07002052func GetCrtVariations(ctx android.BottomUpMutatorContext,
2053 m LinkableInterface) []blueprint.Variation {
2054 if ctx.Os() != android.Android {
2055 return nil
2056 }
2057 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002058 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2059 minSdkVersion := m.MinSdkVersion()
2060 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2061 minSdkVersion = m.SdkVersion()
2062 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002063 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2064 if err != nil {
2065 ctx.PropertyErrorf("min_sdk_version", err.Error())
2066 }
Dan Albert92fe7402020-07-15 13:33:30 -07002067 return []blueprint.Variation{
2068 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002069 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002070 }
2071 }
2072 return []blueprint.Variation{
2073 {Mutator: "sdk", Variation: ""},
2074 }
2075}
2076
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002077func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2078 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002079
2080 variations = append([]blueprint.Variation(nil), variations...)
2081
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002082 if version != "" && CanBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002083 // Version is explicitly specified. i.e. libFoo#30
2084 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002085 if tag, ok := depTag.(libraryDependencyTag); ok {
2086 tag.explicitlyVersioned = true
2087 } else {
2088 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2089 }
Colin Crosse7257d22020-09-24 09:56:18 -07002090 }
Colin Crosse7257d22020-09-24 09:56:18 -07002091
Colin Cross0de8a1e2020-09-18 14:15:30 -07002092 if far {
2093 ctx.AddFarVariationDependencies(variations, depTag, name)
2094 } else {
2095 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002096 }
2097}
2098
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002099func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002100 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002101 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002102 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002103 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2104 // between the modules in the snapshot and the snapshot itself.
2105 var snapshotModule []blueprint.Module
2106 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2107 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2108 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2109 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2110 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002111 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002112 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2113 *snapshotInfo = &snapshot
2114 // republish the snapshot for use in later mutators on this module
2115 actx.SetProvider(SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002116 }
2117 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002118 if *snapshotInfo == nil {
2119 *snapshotInfo = &SnapshotInfo{}
2120 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002121 return **snapshotInfo
2122}
2123
2124func RewriteSnapshotLib(lib string, snapshotMap map[string]string) string {
2125 if snapshot, ok := snapshotMap[lib]; ok {
2126 return snapshot
2127 }
2128
2129 return lib
2130}
2131
2132// RewriteLibs takes a list of names of shared libraries and scans it for three types
2133// of names:
2134//
2135// 1. Name of an NDK library that refers to a prebuilt module.
2136// For each of these, it adds the name of the prebuilt module (which will be in
2137// prebuilts/ndk) to the list of nonvariant libs.
2138// 2. Name of an NDK library that refers to an ndk_library module.
2139// For each of these, it adds the name of the ndk_library module to the list of
2140// variant libs.
2141// 3. Anything else (so anything that isn't an NDK library).
2142// It adds these to the nonvariantLibs list.
2143//
2144// The caller can then know to add the variantLibs dependencies differently from the
2145// nonvariantLibs
2146func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2147 variantLibs = []string{}
2148
2149 nonvariantLibs = []string{}
2150 for _, entry := range list {
2151 // strip #version suffix out
2152 name, _ := StubsLibNameAndVersion(entry)
2153 if c.InRecovery() {
2154 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2155 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2156 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2157 } else if c.UseVndk() {
2158 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2159 } else {
2160 // put name#version back
2161 nonvariantLibs = append(nonvariantLibs, entry)
2162 }
2163 }
2164 return nonvariantLibs, variantLibs
2165}
2166
Colin Cross1e676be2016-10-12 14:38:15 -07002167func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002168 if !c.Enabled() {
2169 return
2170 }
2171
Colin Cross37047f12016-12-13 17:06:13 -08002172 ctx := &depsContext{
2173 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002174 moduleContextImpl: moduleContextImpl{
2175 mod: c,
2176 },
2177 }
2178 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002179
Colin Crossc99deeb2016-04-11 15:06:20 -07002180 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002181
Yo Chiang219968c2020-09-22 18:45:04 +08002182 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2183
Colin Crosse0edaf92021-01-11 17:31:17 -08002184 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002185
Dan Albert914449f2016-06-17 16:45:24 -07002186 variantNdkLibs := []string{}
2187 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002188 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002189 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2190 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2191 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002192
2193 for idx, lib := range deps.RuntimeLibs {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002194 deps.RuntimeLibs[idx] = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002195 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002196 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002197
Colin Cross32ec36c2016-12-15 07:39:51 -08002198 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002199 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002200 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002201 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002202 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002203
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002204 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002205
Jiyong Park1ad8e162020-12-01 23:40:09 +09002206 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002207 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002208 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002209 } else {
2210 actx.AddVariationDependencies(nil, depTag, lib)
2211 }
2212 }
2213
Dan Albertf1d14c72020-07-30 14:32:55 -07002214 if c.isNDKStubLibrary() {
2215 // NDK stubs depend on their implementation because the ABI dumps are
2216 // generated from the implementation library.
2217 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2218 c.ImageVariation(),
2219 blueprint.Variation{Mutator: "link", Variation: "shared"},
2220 ), stubImplementation, c.BaseModuleName())
2221 }
2222
Inseob Kim07def122020-11-23 14:43:02 +09002223 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
2224 // C++ implementation library and one Java implementation library. When a module links against
2225 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
2226 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
2227 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09002228 syspropImplLibraries := syspropImplLibraries(actx.Config())
2229
Jiyong Park5d1598f2019-02-25 22:14:17 +09002230 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002231 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09002232 if impl, ok := syspropImplLibraries[lib]; ok {
2233 lib = impl
2234 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002235
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002236 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002237
Jiyong Park5d1598f2019-02-25 22:14:17 +09002238 actx.AddVariationDependencies([]blueprint.Variation{
2239 {Mutator: "link", Variation: "static"},
2240 }, depTag, lib)
2241 }
2242
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002243 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002244 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002245 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002246 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002247 }
Jiyong Parke3867542020-12-03 17:28:25 +09002248 if inList(lib, deps.ExcludeLibsForApex) {
2249 depTag.excludeInApex = true
2250 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002251
2252 if impl, ok := syspropImplLibraries[lib]; ok {
2253 lib = impl
2254 }
2255
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002256 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002257
Dan Willemsen59339a22018-07-22 21:18:45 -07002258 actx.AddVariationDependencies([]blueprint.Variation{
2259 {Mutator: "link", Variation: "static"},
2260 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002261 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002262
Jooyung Han75568392020-03-20 04:29:24 +09002263 // staticUnwinderDep is treated as staticDep for Q apexes
2264 // so that native libraries/binaries are linked with static unwinder
2265 // because Q libc doesn't have unwinder APIs
2266 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002267 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002268 actx.AddVariationDependencies([]blueprint.Variation{
2269 {Mutator: "link", Variation: "static"},
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002270 }, depTag, RewriteSnapshotLib(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002271 }
2272
Jiyong Park7ed9de32018-10-15 22:25:07 +09002273 // shared lib names without the #version suffix
2274 var sharedLibNames []string
2275
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002276 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002277 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002278 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002279 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002280 }
Jiyong Parke3867542020-12-03 17:28:25 +09002281 if inList(lib, deps.ExcludeLibsForApex) {
2282 depTag.excludeInApex = true
2283 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002284
2285 if impl, ok := syspropImplLibraries[lib]; ok {
2286 lib = impl
2287 }
2288
Jiyong Park73c54ee2019-10-22 20:31:18 +09002289 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002290 sharedLibNames = append(sharedLibNames, name)
2291
Colin Crosse7257d22020-09-24 09:56:18 -07002292 variations := []blueprint.Variation{
2293 {Mutator: "link", Variation: "shared"},
2294 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002295 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002296 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002297
Colin Crossfe9acfe2021-06-14 16:13:03 -07002298 for _, lib := range deps.LateStaticLibs {
2299 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2300 actx.AddVariationDependencies([]blueprint.Variation{
2301 {Mutator: "link", Variation: "static"},
2302 }, depTag, RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
2303 }
2304
Jiyong Park7ed9de32018-10-15 22:25:07 +09002305 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002306 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002307 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2308 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2309 // linking against both the stubs lib and the non-stubs lib at the same time.
2310 continue
2311 }
Colin Cross6e511a92020-07-27 21:26:48 -07002312 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002313 variations := []blueprint.Variation{
2314 {Mutator: "link", Variation: "shared"},
2315 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002316 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002317 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002318
Dan Willemsen59339a22018-07-22 21:18:45 -07002319 actx.AddVariationDependencies([]blueprint.Variation{
2320 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002321 }, dataLibDepTag, deps.DataLibs...)
2322
Colin Crossc8caa062021-09-24 16:50:14 -07002323 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2324
Chris Parsons79d66a52020-06-05 17:26:16 -04002325 actx.AddVariationDependencies([]blueprint.Variation{
2326 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002327 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002328
Colin Cross68861832016-07-08 10:41:41 -07002329 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002330
2331 for _, gen := range deps.GeneratedHeaders {
2332 depTag := genHeaderDepTag
2333 if inList(gen, deps.ReexportGeneratedHeaders) {
2334 depTag = genHeaderExportDepTag
2335 }
2336 actx.AddDependency(c, depTag, gen)
2337 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002338
Dan Albert92fe7402020-07-15 13:33:30 -07002339 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002340 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002341 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002342 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002343 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002344 }
Colin Crossc465efd2021-06-11 18:00:04 -07002345 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002346 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002347 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002348 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002349 if deps.DynamicLinker != "" {
2350 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002351 }
Dan Albert914449f2016-06-17 16:45:24 -07002352
2353 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002354
2355 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002356 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002357 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002358 {Mutator: "link", Variation: "shared"},
2359 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002360
2361 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002362 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002363 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002364 {Mutator: "link", Variation: "shared"},
2365 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002366
2367 if vndkdep := c.vndkdep; vndkdep != nil {
2368 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002369 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002370 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002371 {Mutator: "link", Variation: "shared"},
Justin Yun27b95722021-07-28 17:04:44 +09002372 }, vndkExtDepTag, RewriteSnapshotLib(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002373 }
2374 }
Colin Cross6362e272015-10-29 15:25:03 -07002375}
Colin Cross21b9a242015-03-24 14:15:58 -07002376
Colin Crosse40b4ea2018-10-02 22:25:58 -07002377func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002378 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2379 c.beginMutator(ctx)
2380 }
2381}
2382
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002383// Whether a module can link to another module, taking into
2384// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002385func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002386 tag blueprint.DependencyTag) {
2387
2388 switch t := tag.(type) {
2389 case dependencyTag:
2390 if t != vndkExtDepTag {
2391 return
2392 }
2393 case libraryDependencyTag:
2394 default:
2395 return
2396 }
2397
Ivan Lozanof9e21722020-12-02 09:00:51 -05002398 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002399 // Host code is not restricted
2400 return
2401 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002402
2403 // VNDK is cc.Module supported only for now.
2404 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002405 // Though allowed dependency is limited by the image mutator,
2406 // each vendor and product module needs to check link-type
2407 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002408 if ccTo, ok := to.(*Module); ok {
2409 if ccFrom.vndkdep != nil {
2410 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2411 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002412 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002413 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002414 }
2415 return
2416 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002417 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002418 // Platform code can link to anything
2419 return
2420 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002421 if from.InRamdisk() {
2422 // Ramdisk code is not NDK
2423 return
2424 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002425 if from.InVendorRamdisk() {
2426 // Vendor ramdisk code is not NDK
2427 return
2428 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002429 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002430 // Recovery code is not NDK
2431 return
2432 }
Colin Cross31076b32020-10-23 17:22:06 -07002433 if c, ok := to.(*Module); ok {
2434 if c.ToolchainLibrary() {
2435 // These are always allowed
2436 return
2437 }
2438 if c.NdkPrebuiltStl() {
2439 // These are allowed, but they don't set sdk_version
2440 return
2441 }
2442 if c.StubDecorator() {
2443 // These aren't real libraries, but are the stub shared libraries that are included in
2444 // the NDK.
2445 return
2446 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002447 }
Logan Chien834b9a62019-01-14 15:39:03 +08002448
Ivan Lozano52767be2019-10-18 14:49:46 -07002449 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002450 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2451 // to link to libc++ (non-NDK and without sdk_version).
2452 return
2453 }
2454
Ivan Lozano52767be2019-10-18 14:49:46 -07002455 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002456 // NDK code linking to platform code is never okay.
2457 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002458 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002459 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002460 }
2461
2462 // At this point we know we have two NDK libraries, but we need to
2463 // check that we're not linking against anything built against a higher
2464 // API level, as it is only valid to link against older or equivalent
2465 // APIs.
2466
Inseob Kim01a28722018-04-11 09:48:45 +09002467 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002468 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002469 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002470 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002471 // Current can't be linked against by anything else.
2472 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002473 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002474 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002475 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002476 if err != nil {
2477 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002478 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002479 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002480 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002481 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002482 if err != nil {
2483 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002484 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002485 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002486 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002487
Inseob Kim01a28722018-04-11 09:48:45 +09002488 if toApi > fromApi {
2489 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002490 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002491 }
2492 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002493 }
Dan Albert202fe492017-12-15 13:56:59 -08002494
2495 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002496 fromStl := from.SelectedStl()
2497 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002498 if fromStl == "" || toStl == "" {
2499 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002500 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002501 // We can be permissive with the system "STL" since it is only the C++
2502 // ABI layer, but in the future we should make sure that everyone is
2503 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002504 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002505 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002506 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2507 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002508 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002509}
2510
Jooyung Han479ca172020-10-19 18:51:07 +09002511func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2512 if c, ok := ctx.Module().(*Module); ok {
2513 ctx.VisitDirectDeps(func(dep android.Module) {
2514 depTag := ctx.OtherModuleDependencyTag(dep)
2515 ccDep, ok := dep.(LinkableInterface)
2516 if ok {
2517 checkLinkType(ctx, c, ccDep, depTag)
2518 }
2519 })
2520 }
2521}
2522
Jiyong Park5fb8c102018-04-09 12:03:06 +09002523// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002524// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2525// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002526// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002527func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2528 check := func(child, parent android.Module) bool {
2529 to, ok := child.(*Module)
2530 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002531 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002532 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002533
Jooyung Hana70f0672019-01-18 15:20:43 +09002534 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2535 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002536 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002537
Jiyong Park0474e1f2021-01-14 14:26:06 +09002538 // These dependencies are not excercised at runtime. Tracking these will give us
2539 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002540 depTag := ctx.OtherModuleDependencyTag(child)
2541 if IsHeaderDepTag(depTag) {
2542 return false
2543 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002544 if depTag == staticVariantTag {
2545 return false
2546 }
2547 if depTag == stubImplDepTag {
2548 return false
2549 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002550
Justin Yun63e9ec72020-10-29 16:49:43 +09002551 // Even if target lib has no vendor variant, keep checking dependency
2552 // graph in case it depends on vendor_available or product_available
2553 // but not double_loadable transtively.
2554 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002555 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002556 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002557
Jiyong Park0474e1f2021-01-14 14:26:06 +09002558 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2559 // one.
2560 if Bool(to.VendorProperties.Double_loadable) {
2561 return true
2562 }
2563
Ivan Lozanod7586b62021-04-01 09:49:36 -04002564 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002565 return false
2566 }
2567
Jooyung Hana70f0672019-01-18 15:20:43 +09002568 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2569 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002570 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002571 return false
2572 }
2573 if module, ok := ctx.Module().(*Module); ok {
2574 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002575 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002576 ctx.WalkDeps(check)
2577 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002578 }
2579 }
2580}
2581
Colin Crossc99deeb2016-04-11 15:06:20 -07002582// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002583func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002584 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002585
Colin Cross0de8a1e2020-09-18 14:15:30 -07002586 var directStaticDeps []StaticLibraryInfo
2587 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002588
Colin Cross0de8a1e2020-09-18 14:15:30 -07002589 reexportExporter := func(exporter FlagExporterInfo) {
2590 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2591 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2592 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2593 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2594 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002595 }
2596
Jooyung Hande34d232020-07-23 13:04:15 +09002597 // For the dependency from platform to apex, use the latest stubs
2598 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002599 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2600 if !apexInfo.IsForPlatform() {
Jiyong Park4eab21d2021-04-15 15:17:54 +09002601 c.apexSdkVersion = apexInfo.MinSdkVersion
Jooyung Hande34d232020-07-23 13:04:15 +09002602 }
2603
2604 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2605 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2606 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2607 // (b/144430859)
2608 c.apexSdkVersion = android.FutureApiLevel
2609 }
2610
Colin Crossd11fcda2017-10-23 17:59:01 -07002611 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002612 depName := ctx.OtherModuleName(dep)
2613 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002614
Dan Willemsen47450072021-10-19 20:24:49 -07002615 if depTag == android.DarwinUniversalVariantTag {
2616 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
2617 return
2618 }
2619
Ivan Lozano52767be2019-10-18 14:49:46 -07002620 ccDep, ok := dep.(LinkableInterface)
2621 if !ok {
2622
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002623 // handling for a few module types that aren't cc Module but that are also supported
2624 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002625 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002626 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002627 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2628 genRule.GeneratedSourceFiles()...)
2629 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002630 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002631 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002632 // Support exported headers from a generated_sources dependency
2633 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002634 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002635 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002636 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002637 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002638 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002639 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002640 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002641 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002642 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2643 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002644 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002645 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
Jiyong Park74955042019-10-22 20:19:51 +09002646 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002647
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002648 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002649 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002650 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002651 }
Colin Crosscef792e2021-06-11 18:01:26 -07002652 case CrtBeginDepTag:
2653 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2654 case CrtEndDepTag:
2655 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002656 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002657 return
2658 }
2659
Colin Crossfe17f6f2019-03-28 19:30:56 -07002660 if depTag == android.ProtoPluginDepTag {
2661 return
2662 }
2663
Colin Crossd11fcda2017-10-23 17:59:01 -07002664 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002665 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2666 return
2667 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002668 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002669 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2670 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002671 return
2672 }
2673
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002674 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002675 // Skip reused objects for stub libraries, they use their own stub object file instead.
2676 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2677 // version mutator, so the stubs variant is created from the shared variant that
2678 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002679 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002680 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2681 objs := staticAnalogue.ReuseObjects
2682 depPaths.Objs = depPaths.Objs.Append(objs)
2683 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2684 reexportExporter(depExporterInfo)
2685 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002686 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002687 }
2688
Colin Cross6e511a92020-07-27 21:26:48 -07002689 linkFile := ccDep.OutputFile()
2690
2691 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2692 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002693 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002694 return
2695 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002696
Jiyong Parke3867542020-12-03 17:28:25 +09002697 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2698 return
2699 }
2700
Colin Cross0de8a1e2020-09-18 14:15:30 -07002701 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002702
Colin Cross6e511a92020-07-27 21:26:48 -07002703 var ptr *android.Paths
2704 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002705
Colin Cross6e511a92020-07-27 21:26:48 -07002706 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002707
Colin Cross6e511a92020-07-27 21:26:48 -07002708 switch {
2709 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002710 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2711 if !ctx.Config().AllowMissingDependencies() {
2712 ctx.ModuleErrorf("module %q is not a header library", depName)
2713 } else {
2714 ctx.AddMissingDependencies([]string{depName})
2715 }
2716 return
2717 }
Colin Cross6e511a92020-07-27 21:26:48 -07002718 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002719 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2720 if !ctx.Config().AllowMissingDependencies() {
2721 ctx.ModuleErrorf("module %q is not a shared library", depName)
2722 } else {
2723 ctx.AddMissingDependencies([]string{depName})
2724 }
2725 return
2726 }
Jiyong Parke3867542020-12-03 17:28:25 +09002727
Jiyong Park7d55b612021-06-11 17:22:09 +09002728 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
2729 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07002730
Jiyong Park1ad8e162020-12-01 23:40:09 +09002731 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2732 // linkFile, depFile, and ptr.
2733 if c.IsStubs() {
2734 break
2735 }
2736
Colin Cross0de8a1e2020-09-18 14:15:30 -07002737 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2738 depFile = sharedLibraryInfo.TableOfContents
2739
Colin Cross6e511a92020-07-27 21:26:48 -07002740 ptr = &depPaths.SharedLibs
2741 switch libDepTag.Order {
2742 case earlyLibraryDependency:
2743 ptr = &depPaths.EarlySharedLibs
2744 depPtr = &depPaths.EarlySharedLibsDeps
2745 case normalLibraryDependency:
2746 ptr = &depPaths.SharedLibs
2747 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002748 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002749 case lateLibraryDependency:
2750 ptr = &depPaths.LateSharedLibs
2751 depPtr = &depPaths.LateSharedLibsDeps
2752 default:
2753 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002754 }
Colin Cross6e511a92020-07-27 21:26:48 -07002755 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002756 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2757 if !ctx.Config().AllowMissingDependencies() {
2758 ctx.ModuleErrorf("module %q is not a static library", depName)
2759 } else {
2760 ctx.AddMissingDependencies([]string{depName})
2761 }
2762 return
2763 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002764
2765 // Stubs lib doesn't link to the static lib dependencies. Don't set
2766 // linkFile, depFile, and ptr.
2767 if c.IsStubs() {
2768 break
2769 }
2770
Colin Cross0de8a1e2020-09-18 14:15:30 -07002771 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2772 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002773 if libDepTag.wholeStatic {
2774 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002775 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2776 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002777 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002778 // This case normally catches prebuilt static
2779 // libraries, but it can also occur when
2780 // AllowMissingDependencies is on and the
2781 // dependencies has no sources of its own
2782 // but has a whole_static_libs dependency
2783 // on a missing library. We want to depend
2784 // on the .a file so that there is something
2785 // in the dependency tree that contains the
2786 // error rule for the missing transitive
2787 // dependency.
2788 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002789 }
Colin Cross6e511a92020-07-27 21:26:48 -07002790 } else {
2791 switch libDepTag.Order {
2792 case earlyLibraryDependency:
2793 panic(fmt.Errorf("early static libs not suppported"))
2794 case normalLibraryDependency:
2795 // static dependencies will be handled separately so they can be ordered
2796 // using transitive dependencies.
2797 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002798 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002799 case lateLibraryDependency:
2800 ptr = &depPaths.LateStaticLibs
2801 default:
2802 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002803 }
2804 }
2805 }
2806
Colin Cross6e511a92020-07-27 21:26:48 -07002807 if libDepTag.static() && !libDepTag.wholeStatic {
2808 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2809 ctx.ModuleErrorf("module %q not a static library", depName)
2810 return
2811 }
Logan Chien43d34c32017-12-20 01:17:32 +08002812
Colin Cross6e511a92020-07-27 21:26:48 -07002813 // When combining coverage files for shared libraries and executables, coverage files
2814 // in static libraries act as if they were whole static libraries. The same goes for
2815 // source based Abi dump files.
2816 if c, ok := ccDep.(*Module); ok {
2817 staticLib := c.linker.(libraryInterface)
2818 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2819 staticLib.objs().coverageFiles...)
2820 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2821 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002822 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002823 // Handle non-CC modules here
2824 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002825 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002826 }
2827 }
2828
Colin Cross6e511a92020-07-27 21:26:48 -07002829 if ptr != nil {
2830 if !linkFile.Valid() {
2831 if !ctx.Config().AllowMissingDependencies() {
2832 ctx.ModuleErrorf("module %q missing output file", depName)
2833 } else {
2834 ctx.AddMissingDependencies([]string{depName})
2835 }
2836 return
2837 }
2838 *ptr = append(*ptr, linkFile.Path())
2839 }
2840
2841 if depPtr != nil {
2842 dep := depFile
2843 if !dep.Valid() {
2844 dep = linkFile
2845 }
2846 *depPtr = append(*depPtr, dep.Path())
2847 }
2848
Colin Cross0de8a1e2020-09-18 14:15:30 -07002849 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2850 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2851 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2852 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2853
2854 if libDepTag.reexportFlags {
2855 reexportExporter(depExporterInfo)
2856 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2857 // Re-exported shared library headers must be included as well since they can help us with type information
2858 // about template instantiations (instantiated from their headers).
2859 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2860 // scripts.
2861 c.sabi.Properties.ReexportedIncludes = append(
2862 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2863 }
2864
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002865 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002866 switch {
2867 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002868 c.Properties.AndroidMkHeaderLibs = append(
2869 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002870 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002871 if lib := moduleLibraryInterface(dep); lib != nil {
2872 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002873 // Add the dependency to the APEX(es) providing the library so that
2874 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002875 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09002876 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07002877 c.Properties.ApexesProvidingSharedLibs = append(
2878 c.Properties.ApexesProvidingSharedLibs, an)
2879 }
2880 }
2881 }
2882
2883 // Note: the order of libs in this list is not important because
2884 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002885 c.Properties.AndroidMkSharedLibs = append(
2886 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002887 // Record BaseLibName for snapshots.
2888 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002889 case libDepTag.static():
2890 if libDepTag.wholeStatic {
2891 c.Properties.AndroidMkWholeStaticLibs = append(
2892 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2893 } else {
2894 c.Properties.AndroidMkStaticLibs = append(
2895 c.Properties.AndroidMkStaticLibs, makeLibName)
2896 }
Justin Yun5e035862021-06-29 20:50:37 +09002897 // Record BaseLibName for snapshots.
2898 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002899 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002900 } else if !c.IsStubs() {
2901 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2902
Colin Cross6e511a92020-07-27 21:26:48 -07002903 switch depTag {
2904 case runtimeDepTag:
2905 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002906 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002907 // Record BaseLibName for snapshots.
2908 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002909 case objDepTag:
2910 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2911 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002912 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002913 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002914 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002915 case dynamicLinkerDepTag:
2916 depPaths.DynamicLinker = linkFile
2917 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002918 }
Colin Crossca860ac2016-01-04 14:34:37 -08002919 })
2920
Jeff Gaston294356f2017-09-27 17:05:30 -07002921 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002922 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2923 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2924 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002925
Colin Crossdd84e052017-05-17 13:44:16 -07002926 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002927 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002928 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2929 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002930 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002931 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2932 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002933 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002934 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002935 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002936
2937 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002938 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002939 }
Colin Crossdd84e052017-05-17 13:44:16 -07002940
Colin Crossca860ac2016-01-04 14:34:37 -08002941 return depPaths
2942}
2943
Jiyong Park7d55b612021-06-11 17:22:09 +09002944// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
2945// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
2946// dependency. The stub variant is selected when the dependency crosses a boundary where each side
2947// has different level of updatability. For example, if a library foo in an APEX depends on a
2948// library bar which provides stable interface and exists in the platform, foo uses the stub variant
2949// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
2950// same APEX as foo, the non-stub variant of bar is used.
2951func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
2952 depName := ctx.OtherModuleName(dep)
2953 depTag := ctx.OtherModuleDependencyTag(dep)
2954 libDepTag, ok := depTag.(libraryDependencyTag)
2955 if !ok || !libDepTag.shared() {
2956 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2957 }
2958
2959 thisModule, ok := ctx.Module().(android.ApexModule)
2960 if !ok {
2961 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
2962 }
2963
2964 useVndk := false
2965 bootstrap := false
2966 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
2967 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
2968 } else {
2969 useVndk = linkable.UseVndk()
2970 bootstrap = linkable.Bootstrap()
2971 }
2972
2973 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2974 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2975 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
2976 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2977
2978 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
2979 useStubs := false
2980
2981 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
2982 if !apexInfo.IsForPlatform() {
2983 // For platform libraries, use current version of LLNDK
2984 // If this is for use_vendor apex we will apply the same rules
2985 // of apex sdk enforcement below to choose right version.
2986 useStubs = true
2987 }
Jiyong Park9477c262021-06-22 20:23:05 +09002988 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
2989 // If not building for APEX or the containing APEX allows the use of
2990 // platform APIs, use stubs only when it is from an APEX (and not from
2991 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
2992 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09002993 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
2994 if useStubs {
2995 // Another exception: if this module is a test for an APEX, then
2996 // it is linked with the non-stub variant of a module in the APEX
2997 // as if this is part of the APEX.
2998 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2999 for _, apexContents := range testFor.ApexContents {
3000 if apexContents.DirectlyInApex(depName) {
3001 useStubs = false
3002 break
3003 }
3004 }
3005 }
3006 if useStubs {
3007 // Yet another exception: If this module and the dependency are
3008 // available to the same APEXes then skip stubs between their
3009 // platform variants. This complements the test_for case above,
3010 // which avoids the stubs on a direct APEX library dependency, by
3011 // avoiding stubs for indirect test dependencies as well.
3012 //
3013 // TODO(b/183882457): This doesn't work if the two libraries have
3014 // only partially overlapping apex_available. For that test_for
3015 // modules would need to be split into APEX variants and resolved
3016 // separately for each APEX they have access to.
3017 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3018 useStubs = false
3019 }
3020 }
3021 } else {
3022 // If building for APEX, use stubs when the parent is in any APEX that
3023 // the child is not in.
3024 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3025 }
3026
3027 // when to use (unspecified) stubs, use the latest one.
3028 if useStubs {
3029 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3030 toUse := stubs[len(stubs)-1]
3031 sharedLibraryInfo = toUse.SharedLibraryInfo
3032 depExporterInfo = toUse.FlagExporterInfo
3033 }
3034 }
3035 return sharedLibraryInfo, depExporterInfo
3036}
3037
Colin Cross0de8a1e2020-09-18 14:15:30 -07003038// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3039// to match the topological order of the dependency tree, including any static analogues of
3040// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3041// of the transitive dependencies.
3042func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
3043 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
3044 var staticPaths android.Paths
3045 for _, staticDep := range staticDeps {
3046 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3047 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3048 }
3049 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003050 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3051 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003052 }
3053 }
3054 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3055
3056 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3057
3058 // reorder the dependencies based on transitive dependencies
3059 staticPaths = android.FirstUniquePaths(staticPaths)
3060 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3061
3062 if len(orderedStaticPaths) != len(staticPaths) {
3063 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3064 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3065 }
3066
3067 return orderedStaticPaths, transitiveStaticLibs
3068}
3069
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003070// BaseLibName trims known prefixes and suffixes
3071func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003072 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3073 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003074 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003075 return libName
3076}
3077
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003078func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003079 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003080 ccDepModule, _ := ccDep.(*Module)
3081 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003082 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003083
Justin Yuncbca3732021-02-03 19:24:13 +09003084 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003085 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07003086 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003087 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003088 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003089
Ivan Lozanod1dec542021-05-26 15:33:11 -04003090 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003091 }
3092 }
3093
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003094 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3095 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003096 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3097 // core module instead.
3098 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003099 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003100 // The vendor and product modules in Make will have been renamed to not conflict with the
3101 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003102 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003103 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003104 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003105 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003106 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003107 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003108 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003109 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003110 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003111 } else {
3112 return libName
3113 }
3114}
3115
Colin Crossca860ac2016-01-04 14:34:37 -08003116func (c *Module) InstallInData() bool {
3117 if c.installer == nil {
3118 return false
3119 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003120 return c.installer.inData()
3121}
3122
3123func (c *Module) InstallInSanitizerDir() bool {
3124 if c.installer == nil {
3125 return false
3126 }
3127 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003128 return true
3129 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003130 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003131}
3132
Yifan Hong1b3348d2020-01-21 15:53:22 -08003133func (c *Module) InstallInRamdisk() bool {
3134 return c.InRamdisk()
3135}
3136
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003137func (c *Module) InstallInVendorRamdisk() bool {
3138 return c.InVendorRamdisk()
3139}
3140
Jiyong Parkf9332f12018-02-01 00:54:12 +09003141func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003142 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003143}
3144
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003145func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003146 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003147 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003148 return
3149 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003150 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003151}
3152
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003153func (c *Module) HostToolPath() android.OptionalPath {
3154 if c.installer == nil {
3155 return android.OptionalPath{}
3156 }
3157 return c.installer.hostToolPath()
3158}
3159
Nan Zhangd4e641b2017-07-12 12:55:28 -07003160func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3161 return c.outputFile
3162}
3163
Colin Cross41955e82019-05-29 14:40:35 -07003164func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3165 switch tag {
3166 case "":
3167 if c.outputFile.Valid() {
3168 return android.Paths{c.outputFile.Path()}, nil
3169 }
3170 return android.Paths{}, nil
3171 default:
3172 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003173 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003174}
3175
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003176func (c *Module) static() bool {
3177 if static, ok := c.linker.(interface {
3178 static() bool
3179 }); ok {
3180 return static.static()
3181 }
3182 return false
3183}
3184
Jiyong Park379de2f2018-12-19 02:47:14 +09003185func (c *Module) staticBinary() bool {
3186 if static, ok := c.linker.(interface {
3187 staticBinary() bool
3188 }); ok {
3189 return static.staticBinary()
3190 }
3191 return false
3192}
3193
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003194func (c *Module) testBinary() bool {
3195 if test, ok := c.linker.(interface {
3196 testBinary() bool
3197 }); ok {
3198 return test.testBinary()
3199 }
3200 return false
3201}
3202
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003203func (c *Module) benchmarkBinary() bool {
3204 if b, ok := c.linker.(interface {
3205 benchmarkBinary() bool
3206 }); ok {
3207 return b.benchmarkBinary()
3208 }
3209 return false
3210}
3211
3212func (c *Module) fuzzBinary() bool {
3213 if f, ok := c.linker.(interface {
3214 fuzzBinary() bool
3215 }); ok {
3216 return f.fuzzBinary()
3217 }
3218 return false
3219}
3220
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003221// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3222func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003223 if h, ok := c.linker.(interface {
3224 header() bool
3225 }); ok {
3226 return h.header()
3227 }
3228 return false
3229}
3230
Ivan Lozanod7586b62021-04-01 09:49:36 -04003231func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003232 if b, ok := c.linker.(interface {
3233 binary() bool
3234 }); ok {
3235 return b.binary()
3236 }
3237 return false
3238}
3239
Justin Yun5e035862021-06-29 20:50:37 +09003240func (c *Module) StaticExecutable() bool {
3241 if b, ok := c.linker.(*binaryDecorator); ok {
3242 return b.static()
3243 }
3244 return false
3245}
3246
Ivan Lozanod7586b62021-04-01 09:49:36 -04003247func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003248 if o, ok := c.linker.(interface {
3249 object() bool
3250 }); ok {
3251 return o.object()
3252 }
3253 return false
3254}
3255
Ivan Lozanof9e21722020-12-02 09:00:51 -05003256func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003257 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003258 if c.IsLlndk() {
3259 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003260 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003261 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003262 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003263 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003264 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003265 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003266 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003267 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003268 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003269 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003270 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003271 return "native:product"
3272 }
Jooyung Han38002912019-05-16 04:01:54 +09003273 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003274 } else if c.InRamdisk() {
3275 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003276 } else if c.InVendorRamdisk() {
3277 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003278 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003279 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003280 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003281 return "native:ndk:none:none"
3282 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3283 //family, link := getNdkStlFamilyAndLinkType(c)
3284 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003285 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003286 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003287 } else {
3288 return "native:platform"
3289 }
3290}
3291
Jiyong Park9d452992018-10-03 00:38:19 +09003292// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003293// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003294func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003295 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003296 // Stub libs and prebuilt libs in a versioned SDK are not
3297 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07003298 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01003299 } else if _, ok := c.linker.(testPerSrc); ok {
3300 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003301 }
3302 return false
3303}
3304
Jiyong Parka90ca002019-10-07 15:47:24 +09003305func (c *Module) AvailableFor(what string) bool {
3306 if linker, ok := c.linker.(interface {
3307 availableFor(string) bool
3308 }); ok {
3309 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3310 } else {
3311 return c.ApexModuleBase.AvailableFor(what)
3312 }
3313}
3314
Jiyong Park62304bb2020-04-13 16:19:48 +09003315func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003316 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003317}
3318
Paul Duffin0cb37b92020-03-04 14:52:46 +00003319func (c *Module) EverInstallable() bool {
3320 return c.installer != nil &&
3321 // Check to see whether the module is actually ever installable.
3322 c.installer.everInstallable()
3323}
3324
Ivan Lozanod7586b62021-04-01 09:49:36 -04003325func (c *Module) PreventInstall() bool {
3326 return c.Properties.PreventInstall
3327}
3328
3329func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003330 if c.library != nil {
3331 if i := c.library.installable(); i != nil {
3332 return i
3333 }
3334 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003335 return c.Properties.Installable
3336}
3337
3338func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003339 ret := c.EverInstallable() &&
3340 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003341 proptools.BoolDefault(c.Installable(), true) &&
3342 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003343
3344 // The platform variant doesn't need further condition. Apex variants however might not
3345 // be installable because it will likely to be included in the APEX and won't appear
3346 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003347 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003348 return ret
3349 }
3350
3351 // Special case for modules that are configured to be installed to /data, which includes
3352 // test modules. For these modules, both APEX and non-APEX variants are considered as
3353 // installable. This is because even the APEX variants won't be included in the APEX, but
3354 // will anyway be installed to /data/*.
3355 // See b/146995717
3356 if c.InstallInData() {
3357 return ret
3358 }
3359
3360 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003361}
3362
Logan Chien41eabe62019-04-10 13:33:58 +08003363func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3364 if c.linker != nil {
3365 if library, ok := c.linker.(*libraryDecorator); ok {
3366 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3367 }
3368 }
3369}
3370
Jiyong Park45bf82e2020-12-15 22:29:02 +09003371var _ android.ApexModule = (*Module)(nil)
3372
3373// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003374func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003375 depTag := ctx.OtherModuleDependencyTag(dep)
3376 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3377
3378 if cc, ok := dep.(*Module); ok {
3379 if cc.HasStubsVariants() {
3380 if isLibDepTag && libDepTag.shared() {
3381 // dynamic dep to a stubs lib crosses APEX boundary
3382 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003383 }
Colin Cross6e511a92020-07-27 21:26:48 -07003384 if IsRuntimeDepTag(depTag) {
3385 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003386 return false
3387 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003388 }
Zhijun Heec285872021-04-24 10:47:08 -07003389 if cc.IsLlndk() {
3390 return false
3391 }
Colin Crossaac32222020-07-29 12:51:56 -07003392 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003393 // shared_lib dependency from a static lib is considered as crossing
3394 // the APEX boundary because the dependency doesn't actually is
3395 // linked; the dependency is used only during the compilation phase.
3396 return false
3397 }
Jiyong Parke3867542020-12-03 17:28:25 +09003398
3399 if isLibDepTag && libDepTag.excludeInApex {
3400 return false
3401 }
Colin Cross6e511a92020-07-27 21:26:48 -07003402 }
Colin Crossc1b36442021-05-06 13:42:48 -07003403 if depTag == stubImplDepTag {
3404 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003405 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003406 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003407 if depTag == staticVariantTag {
3408 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3409 // actually mean that the static lib (and its dependencies) are copied into the
3410 // APEX.
3411 return false
3412 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003413 return true
3414}
3415
Jiyong Park45bf82e2020-12-15 22:29:02 +09003416// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003417func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3418 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003419 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3420 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3421 return nil
3422 }
3423 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3424 if c.ToolchainLibrary() {
3425 return nil
3426 }
3427 // We don't check for prebuilt modules
3428 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3429 return nil
3430 }
3431 minSdkVersion := c.MinSdkVersion()
3432 if minSdkVersion == "apex_inherit" {
3433 return nil
3434 }
3435 if minSdkVersion == "" {
3436 // JNI libs within APK-in-APEX fall into here
3437 // Those are okay to set sdk_version instead
3438 // We don't have to check if this is a SDK variant because
3439 // non-SDK variant resets sdk_version, which works too.
3440 minSdkVersion = c.SdkVersion()
3441 }
Dan Albertc8060532020-07-22 22:32:17 -07003442 if minSdkVersion == "" {
3443 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3444 }
3445 // Not using nativeApiLevelFromUser because the context here is not
3446 // necessarily a native context.
3447 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003448 if err != nil {
3449 return err
3450 }
Dan Albertc8060532020-07-22 22:32:17 -07003451
3452 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003453 return fmt.Errorf("newer SDK(%v)", ver)
3454 }
3455 return nil
3456}
3457
Paul Duffinb5769c12021-05-12 16:16:51 +01003458// Implements android.ApexModule
3459func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3460 // stub libraries and native bridge libraries are always available to platform
3461 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3462}
3463
Rob Seymour925aa092021-08-10 20:42:03 +00003464var _ snapshot.RelativeInstallPath = (*Module)(nil)
3465
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003466// ConvertWithBp2build converts Module to Bazel for bp2build.
3467func (c *Module) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
Liz Kammerbdc922f2021-12-14 14:21:21 -05003468 prebuilt := c.IsPrebuilt()
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003469 if c.Binary() {
Liz Kammerbdc922f2021-12-14 14:21:21 -05003470 if !prebuilt {
3471 binaryBp2build(ctx, c, ctx.ModuleType())
3472 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003473 } else if c.Object() {
Liz Kammerbdc922f2021-12-14 14:21:21 -05003474 if !prebuilt {
3475 objectBp2Build(ctx, c)
3476 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003477 } else if c.CcLibrary() {
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003478 static := c.BuildStaticVariant()
3479 shared := c.BuildSharedVariant()
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003480
3481 if static && shared {
Liz Kammerbdc922f2021-12-14 14:21:21 -05003482 if !prebuilt {
3483 libraryBp2Build(ctx, c)
3484 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003485 } else if !static && !shared {
Liz Kammerbdc922f2021-12-14 14:21:21 -05003486 if !prebuilt {
3487 libraryHeadersBp2Build(ctx, c)
3488 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003489 } else if static {
3490 if prebuilt {
3491 prebuiltLibraryStaticBp2Build(ctx, c)
3492 } else {
3493 sharedOrStaticLibraryBp2Build(ctx, c, true)
3494 }
3495 } else if shared {
3496 if prebuilt {
3497 prebuiltLibrarySharedBp2Build(ctx, c)
3498 } else {
3499 sharedOrStaticLibraryBp2Build(ctx, c, false)
3500 }
3501 }
3502 }
3503}
3504
Colin Cross2ba19d92015-05-07 15:44:20 -07003505//
Colin Crosscfad1192015-11-02 16:43:11 -08003506// Defaults
3507//
Colin Crossca860ac2016-01-04 14:34:37 -08003508type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003509 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003510 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003511 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003512}
3513
Patrice Arrudac249c712019-03-19 17:00:29 -07003514// cc_defaults provides a set of properties that can be inherited by other cc
3515// modules. A module can use the properties from a cc_defaults using
3516// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3517// merged (when possible) by prepending the default module's values to the
3518// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003519func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003520 return DefaultsFactory()
3521}
3522
Colin Cross36242852017-06-23 15:06:31 -07003523func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003524 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003525
Colin Cross36242852017-06-23 15:06:31 -07003526 module.AddProperties(props...)
3527 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003528 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003529 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003530 &BaseCompilerProperties{},
3531 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003532 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003533 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003534 &StaticProperties{},
3535 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003536 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003537 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003538 &TestProperties{},
3539 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003540 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07003541 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003542 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003543 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003544 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003545 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003546 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003547 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003548 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003549 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003550 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08003551 &AfdoProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003552 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003553 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003554 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3555 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07003556 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003557 )
Colin Crosscfad1192015-11-02 16:43:11 -08003558
Jooyung Hancc372c52019-09-25 15:18:44 +09003559 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003560
3561 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003562}
3563
Jiyong Park2286afd2020-06-16 21:58:53 +09003564func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003565 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003566}
3567
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003568func kytheExtractAllFactory() android.Singleton {
3569 return &kytheExtractAllSingleton{}
3570}
3571
3572type kytheExtractAllSingleton struct {
3573}
3574
3575func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3576 var xrefTargets android.Paths
3577 ctx.VisitAllModules(func(module android.Module) {
3578 if ccModule, ok := module.(xref); ok {
3579 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3580 }
3581 })
3582 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3583 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003584 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003585 }
3586}
3587
Colin Cross06a931b2015-10-28 17:23:31 -07003588var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003589var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003590var BoolPtr = proptools.BoolPtr
3591var String = proptools.String
3592var StringPtr = proptools.StringPtr