blob: d2f8a1270e718cc8fc0a8957cb1aab8933ae7ec6 [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
67 ctx.TopDown("lto_deps", ltoDepsMutator)
68 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090069
Jooyung Han479ca172020-10-19 18:51:07 +090070 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090071 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070072 })
Colin Crossb98c8b02016-07-29 13:44:28 -070073
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080074 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
75 // sabi mutator needs to be run after apex mutator finishes.
76 ctx.TopDown("sabi_deps", sabiDepsMutator)
77 })
78
Colin Cross57898582020-10-29 18:25:19 -070079 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070080}
81
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050082// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
83// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
84// edges to these modules.
85// This object is constructed in DepsMutator, by calling to various module delegates to set
86// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
87// dependencies.
88// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
89// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080090type Deps struct {
91 SharedLibs, LateSharedLibs []string
92 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080093 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +080094 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -070095
Chris Parsons79d66a52020-06-05 17:26:16 -040096 // Used for data dependencies adjacent to tests
97 DataLibs []string
98
Yo Chiang219968c2020-09-22 18:45:04 +080099 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
100 SystemSharedLibs []string
101
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500102 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800103 StaticUnwinderIfLegacy bool
104
Colin Cross5950f382016-12-13 12:50:57 -0800105 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700106
Colin Cross81413472016-04-11 14:37:39 -0700107 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700108
Dan Willemsenb40aab62016-04-20 14:21:14 -0700109 GeneratedSources []string
110 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900111 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700112
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700113 ReexportGeneratedHeaders []string
114
Colin Crossc465efd2021-06-11 18:00:04 -0700115 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700116
117 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700118 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900119
120 // List of libs that need to be excluded for APEX variant
121 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700122}
123
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500124// PathDeps is a struct containing file paths to dependencies of a module.
125// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
126// It's used to construct flags for various build statements (such as for compiling and linking).
127// It is then passed to module decorator functions responsible for registering build statements
128// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800129type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700130 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900131 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700132 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900133 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700134 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700135 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700136
Colin Cross0de8a1e2020-09-18 14:15:30 -0700137 // Transitive static library dependencies of static libraries for use in ordering.
138 TranstiveStaticLibrariesForOrdering *android.DepSet
139
Colin Cross26c34ed2016-09-30 17:10:16 -0700140 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100141 Objs Objects
142 // Paths to .o files in dependencies that provide them. Note that these lists
143 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800144 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700145 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700146
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100147 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
148 // the libs from all whole_static_lib dependencies.
149 WholeStaticLibsFromPrebuilts android.Paths
150
Colin Cross26c34ed2016-09-30 17:10:16 -0700151 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700152 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900153 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700154
Inseob Kimd110f872019-12-06 13:15:38 +0900155 Flags []string
156 IncludeDirs android.Paths
157 SystemIncludeDirs android.Paths
158 ReexportedDirs android.Paths
159 ReexportedSystemDirs android.Paths
160 ReexportedFlags []string
161 ReexportedGeneratedHeaders android.Paths
162 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700163
Colin Cross26c34ed2016-09-30 17:10:16 -0700164 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700165 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700166
Dan Willemsena0790e32018-10-12 00:24:23 -0700167 // Path to the dynamic linker binary
168 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700169}
170
Colin Cross4af21ed2019-11-04 09:37:55 -0800171// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
172// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
173// command line so they can be overridden by the local module flags).
174type LocalOrGlobalFlags struct {
175 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700176 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800177 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700178 CFlags []string // Flags that apply to C and C++ source files
179 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
180 ConlyFlags []string // Flags that apply to C source files
181 CppFlags []string // Flags that apply to C++ source files
182 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700183 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800184}
185
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500186// Flags contains various types of command line flags (and settings) for use in building build
187// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800188type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500189 // Local flags (which individual modules are responsible for). These may override global flags.
190 Local LocalOrGlobalFlags
191 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800192 Global LocalOrGlobalFlags
193
194 aidlFlags []string // Flags that apply to aidl source files
195 rsFlags []string // Flags that apply to renderscript source files
196 libFlags []string // Flags to add libraries early to the link order
197 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
198 TidyFlags []string // Flags that apply to clang-tidy
199 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700200
Colin Crossc3199482017-03-30 15:03:04 -0700201 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800202 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700203 SystemIncludeFlags []string
204
Oliver Nguyen04526782020-04-21 12:40:27 -0700205 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500206 Tidy bool // True if clang-tidy is enabled.
207 GcovCoverage bool // True if coverage files should be generated.
208 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700209 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800210
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500211 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800212 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500213 // The target-device system path to the dynamic linker.
214 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800215
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700216 CFlagsDeps android.Paths // Files depended on by compiler flags
217 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800218
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500219 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700220 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800221
Colin Cross19878da2019-03-28 14:45:07 -0700222 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700223 protoC bool // Whether to use C instead of C++
224 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700225
226 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200227 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700228}
229
Colin Crossca860ac2016-01-04 14:34:37 -0800230// Properties used to compile all C or C++ modules
231type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700232 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800233 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700234
Jiyong Parkb35a8192020-08-10 15:59:36 +0900235 // The API level that this module is built against. The APIs of this API level will be
236 // visible at build time, but use of any APIs newer than min_sdk_version will render the
237 // module unloadable on older devices. In the future it will be possible to weakly-link new
238 // APIs, making the behavior match Java: such modules will load on older devices, but
239 // calling new APIs on devices that do not support them will result in a crash.
240 //
241 // This property has the same behavior as sdk_version does for Java modules. For those
242 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
243 // does for Java code.
244 //
245 // In addition, setting this property causes two variants to be built, one for the platform
246 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800247 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700248
Jiyong Parkb35a8192020-08-10 15:59:36 +0900249 // Minimum OS API level supported by this C or C++ module. This property becomes the value
250 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
251 // this property is also used to ensure that the min_sdk_version of the containing module is
252 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
253 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
254 // min_sdk_version of the containing APEX. When the module
255 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900256 Min_sdk_version *string
257
Colin Crossc511bc52020-04-07 16:50:32 +0000258 // If true, always create an sdk variant and don't create a platform variant.
259 Sdk_variant_only *bool
260
Jiyong Parkde866cb2018-12-07 23:08:36 +0900261 AndroidMkSharedLibs []string `blueprint:"mutated"`
262 AndroidMkStaticLibs []string `blueprint:"mutated"`
263 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
264 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700265 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900266 HideFromMake bool `blueprint:"mutated"`
267 PreventInstall bool `blueprint:"mutated"`
268 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700269
Yo Chiang219968c2020-09-22 18:45:04 +0800270 // Set by DepsMutator.
271 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
272
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200273 // The name of the image this module is built for, suffixed with a '.'
Justin Yun5f7f7e82019-11-18 19:52:14 +0900274 ImageVariationPrefix string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200275
276 // The VNDK version this module is built against. If empty, the module is not
277 // build against the VNDK.
278 VndkVersion string `blueprint:"mutated"`
279
280 // Suffix for the name of Android.mk entries generated by this module
281 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800282
283 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
284 // file
285 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900286
Yifan Hong39143a92020-10-26 12:43:12 -0700287 // Make this module available when building for ramdisk.
288 // On device without a dedicated recovery partition, the module is only
289 // available after switching root into
290 // /first_stage_ramdisk. To expose the module before switching root, install
291 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800292 Ramdisk_available *bool
293
Yifan Hong39143a92020-10-26 12:43:12 -0700294 // Make this module available when building for vendor ramdisk.
295 // On device without a dedicated recovery partition, the module is only
296 // available after switching root into
297 // /first_stage_ramdisk. To expose the module before switching root, install
298 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700299 Vendor_ramdisk_available *bool
300
Jiyong Parkf9332f12018-02-01 00:54:12 +0900301 // Make this module available when building for recovery
302 Recovery_available *bool
303
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200304 // Used by imageMutator, set by ImageMutatorBegin()
305 CoreVariantNeeded bool `blueprint:"mutated"`
306 RamdiskVariantNeeded bool `blueprint:"mutated"`
307 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
308 RecoveryVariantNeeded bool `blueprint:"mutated"`
309
310 // A list of variations for the "image" mutator of the form
311 //<image name> '.' <version char>, for example, 'vendor.S'
312 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900313
314 // Allows this module to use non-APEX version of libraries. Useful
315 // for building binaries that are started before APEXes are activated.
316 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900317
318 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
319 // see soong/cc/config/vndk.go
320 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900321
322 // Used by vendor snapshot to record dependencies from snapshot modules.
323 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900324 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900325 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000326
327 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000328
329 // Set by factories of module types that can only be referenced from variants compiled against
330 // the SDK.
331 AlwaysSdk bool `blueprint:"mutated"`
332
333 // Variant is an SDK variant created by sdkMutator
334 IsSdkVariant bool `blueprint:"mutated"`
335 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
336 // variant to have a ".sdk" suffix.
337 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700338
339 // Normally Soong uses the directory structure to decide which modules
340 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800341 // different snapshots (vendor, recovery, etc.), but this property
342 // allows a partner to exclude a module normally thought of as a
343 // framework module from the vendor snapshot.
344 Exclude_from_vendor_snapshot *bool
345
346 // Normally Soong uses the directory structure to decide which modules
347 // should be included (framework) or excluded (non-framework) from the
348 // different snapshots (vendor, recovery, etc.), but this property
349 // allows a partner to exclude a module normally thought of as a
350 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800351 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900352
353 // List of APEXes that this module has private access to for testing purpose. The module
354 // can depend on libraries that are not exported by the APEXes and use private symbols
355 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000356 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800357
358 Target struct {
359 Platform struct {
360 // List of modules required by the core variant.
361 Required []string `android:"arch_variant"`
362
363 // List of modules not required by the core variant.
364 Exclude_required []string `android:"arch_variant"`
365 } `android:"arch_variant"`
366
367 Recovery struct {
368 // List of modules required by the recovery variant.
369 Required []string `android:"arch_variant"`
370
371 // List of modules not required by the recovery variant.
372 Exclude_required []string `android:"arch_variant"`
373 } `android:"arch_variant"`
374 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700375}
376
377type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900378 // whether this module should be allowed to be directly depended by other
379 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900380 // If set to true, two variants will be built separately, one like
381 // normal, and the other limited to the set of libraries and headers
382 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700383 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900384 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700385 // so it shouldn't have any unversioned runtime dependencies, or
386 // make assumptions about the system that may not be true in the
387 // future.
388 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900389 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900390 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900391 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900392 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900393 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700394 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
395 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900396
Justin Yunebcf0c52021-01-08 18:00:19 +0900397 // This is the same as the "vendor_available" except that the install path
398 // of the vendor variant is /odm or /vendor/odm.
399 // By replacing "vendor_available: true" with "odm_available: true", the
400 // module will install its vendor variant to the /odm partition or /vendor/odm.
401 // As the modules with "odm_available: true" still create the vendor variants,
402 // they can link to the other vendor modules as the vendor_available modules do.
403 // Also, the vendor modules can link to odm_available modules.
404 //
405 // It may not be used for VNDK modules.
406 Odm_available *bool
407
Justin Yun63e9ec72020-10-29 16:49:43 +0900408 // whether this module should be allowed to be directly depended by other
409 // modules with `product_specific: true` or `product_available: true`.
410 // If set to true, an additional product variant will be built separately
411 // that is limited to the set of libraries and headers that are exposed to
412 // /product modules.
413 //
414 // The product variant may be used with a different (newer) /system,
415 // so it shouldn't have any unversioned runtime dependencies, or
416 // make assumptions about the system that may not be true in the
417 // future.
418 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900419 // If set to false, this module becomes inaccessible from /product modules.
420 //
421 // Different from the 'vendor_available' property, the modules with
422 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
423 // library without 'product_available' may not be depended on by any other
424 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900425 //
426 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
427 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
428 Product_available *bool
429
Jiyong Park5fb8c102018-04-09 12:03:06 +0900430 // whether this module is capable of being loaded with other instance
431 // (possibly an older version) of the same module in the same process.
432 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
433 // can be double loaded in a vendor process if the library is also a
434 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
435 // explicitly marked as `double_loadable: true` by the owner, or the dependency
436 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
437 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800438
439 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
440 IsLLNDK bool `blueprint:"mutated"`
441
Colin Cross78212242021-01-06 14:51:30 -0800442 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
443 // set and the module is not listed in VndkMustUseVendorVariantList.
444 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
445
446 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
447 IsVNDKCore bool `blueprint:"mutated"`
448
449 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
450 IsVNDKSP bool `blueprint:"mutated"`
451
452 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
453 // module sets the llndk.private property.
454 IsVNDKPrivate bool `blueprint:"mutated"`
455
456 // IsVNDKProduct is set if a VNDK module sets the product_available property.
457 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700458
459 // IsVendorPublicLibrary is set for the core and product variants of a library that has
460 // vendor_public_library stubs.
461 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800462}
463
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500464// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
465// to understanding details about the type of the current module.
466// For example, one might call these functions to determine whether the current module is a static
467// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800468type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800469 static() bool
470 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700471 testBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900472 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900473 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900474 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700475 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900476 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700477 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800478 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900479 minSdkVersion() string
480 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700481 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700482 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800483 IsLlndk() bool
484 IsLlndkPublic() bool
485 isImplementationForLLNDKPublic() bool
486 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900487 isVndk() bool
488 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500489 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700490 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900491 inProduct() bool
492 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800493 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700494 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900495 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700496 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700497 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800498 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800499 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800500 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800501 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800502 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700503 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700504 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900505 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800506 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700507 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700508 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800509 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800510 isCfiAssemblySupportEnabled() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800511}
512
513type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700514 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800515 ModuleContextIntf
516}
517
518type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700519 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800520 ModuleContextIntf
521}
522
Colin Cross37047f12016-12-13 17:06:13 -0800523type DepsContext interface {
524 android.BottomUpMutatorContext
525 ModuleContextIntf
526}
527
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500528// feature represents additional (optional) steps to building cc-related modules, such as invocation
529// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800530type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800531 flags(ctx ModuleContext, flags Flags) Flags
532 props() []interface{}
533}
534
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500535// compiler is the interface for a compiler helper object. Different module decorators may implement
536// this helper differently. For example, compiling a `cc_library` may use a different build
537// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800538type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700539 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800540 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800541 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700542 compilerProps() []interface{}
543
Colin Cross76fada02016-07-27 10:31:13 -0700544 appendCflags([]string)
545 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700546 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800547}
548
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500549// linker is the interface for a linker decorator object. Individual module types can provide
550// their own implementation for this decorator, and thus specify custom logic regarding build
551// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800552type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700553 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800554 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700555 linkerFlags(ctx ModuleContext, flags Flags) Flags
556 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800557 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700558
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700559 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700560 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900561 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700562
563 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900564 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000565
566 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000567 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
568}
569
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500570// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000571type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500572 sharedLibs []string
573 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
574 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700575 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800576}
577
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500578// installer is the interface for an installer helper object. This helper is responsible for
579// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800580type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700581 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700582 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000583 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800584 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700585 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700586 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900587 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100588 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900589 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800590}
591
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800592type xref interface {
593 XrefCcFiles() android.Paths
594}
595
Colin Cross6e511a92020-07-27 21:26:48 -0700596type libraryDependencyKind int
597
598const (
599 headerLibraryDependency = iota
600 sharedLibraryDependency
601 staticLibraryDependency
602)
603
604func (k libraryDependencyKind) String() string {
605 switch k {
606 case headerLibraryDependency:
607 return "headerLibraryDependency"
608 case sharedLibraryDependency:
609 return "sharedLibraryDependency"
610 case staticLibraryDependency:
611 return "staticLibraryDependency"
612 default:
613 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
614 }
615}
616
617type libraryDependencyOrder int
618
619const (
620 earlyLibraryDependency = -1
621 normalLibraryDependency = 0
622 lateLibraryDependency = 1
623)
624
625func (o libraryDependencyOrder) String() string {
626 switch o {
627 case earlyLibraryDependency:
628 return "earlyLibraryDependency"
629 case normalLibraryDependency:
630 return "normalLibraryDependency"
631 case lateLibraryDependency:
632 return "lateLibraryDependency"
633 default:
634 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
635 }
636}
637
638// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
639// tags that have a set of predefined tag objects that are reused for each dependency, a
640// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
641// That means that comparing a libraryDependencyTag for equality will only be equal if all
642// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
643// then check individual metadata fields instead.
644type libraryDependencyTag struct {
645 blueprint.BaseDependencyTag
646
647 // These are exported so that fmt.Printf("%#v") can call their String methods.
648 Kind libraryDependencyKind
649 Order libraryDependencyOrder
650
651 wholeStatic bool
652
653 reexportFlags bool
654 explicitlyVersioned bool
655 dataLib bool
656 ndk bool
657
658 staticUnwinder bool
659
660 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900661
Cindy Zhou18417cb2020-12-10 07:12:38 -0800662 // Whether or not this dependency should skip the apex dependency check
663 skipApexAllowedDependenciesCheck bool
664
Jiyong Parke3867542020-12-03 17:28:25 +0900665 // Whether or not this dependency has to be followed for the apex variants
666 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700667}
668
669// header returns true if the libraryDependencyTag is tagging a header lib dependency.
670func (d libraryDependencyTag) header() bool {
671 return d.Kind == headerLibraryDependency
672}
673
674// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
675func (d libraryDependencyTag) shared() bool {
676 return d.Kind == sharedLibraryDependency
677}
678
679// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
680func (d libraryDependencyTag) static() bool {
681 return d.Kind == staticLibraryDependency
682}
683
Colin Crosse9fe2942020-11-10 18:12:15 -0800684// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
685// binaries or other shared libraries are installed as dependencies.
686func (d libraryDependencyTag) InstallDepNeeded() bool {
687 return d.shared()
688}
689
690var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
691
692// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700693// libraryDependencyTag. Each tag object is created globally and reused for multiple
694// dependencies (although since the object contains no references, assigning a tag to a
695// variable and modifying it will not modify the original). Users can compare the tag
696// returned by ctx.OtherModuleDependencyTag against the global original
697type dependencyTag struct {
698 blueprint.BaseDependencyTag
699 name string
700}
701
Colin Crosse9fe2942020-11-10 18:12:15 -0800702// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
703// libraryDependencyTag, but where the dependency needs to be installed when the parent is
704// installed.
705type installDependencyTag struct {
706 blueprint.BaseDependencyTag
707 android.InstallAlwaysNeededDependencyTag
708 name string
709}
710
Colin Crossc99deeb2016-04-11 15:06:20 -0700711var (
Colin Cross6e511a92020-07-27 21:26:48 -0700712 genSourceDepTag = dependencyTag{name: "gen source"}
713 genHeaderDepTag = dependencyTag{name: "gen header"}
714 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
715 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900716 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700717 reuseObjTag = dependencyTag{name: "reuse objects"}
718 staticVariantTag = dependencyTag{name: "static variant"}
719 vndkExtDepTag = dependencyTag{name: "vndk extends"}
720 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800721 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700722 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700723 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700724)
725
Roland Levillainf89cd092019-07-29 16:22:59 +0100726func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700727 ccLibDepTag, ok := depTag.(libraryDependencyTag)
728 return ok && ccLibDepTag.shared()
729}
730
731func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
732 ccLibDepTag, ok := depTag.(libraryDependencyTag)
733 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100734}
735
Zach Johnson3df4e632020-11-06 11:56:27 -0800736func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
737 ccLibDepTag, ok := depTag.(libraryDependencyTag)
738 return ok && ccLibDepTag.header()
739}
740
Roland Levillainf89cd092019-07-29 16:22:59 +0100741func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800742 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100743}
744
745func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700746 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100747 return ok && ccDepTag == testPerSrcDepTag
748}
749
Colin Crossca860ac2016-01-04 14:34:37 -0800750// Module contains the properties and members used by all C/C++ module types, and implements
751// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500752// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
753// interface.
754//
755// To define a C/C++ related module, construct a new Module object and point its delegates to
756// type-specific structs. These delegates will be invoked to register module-specific build
757// statements which may be unique to the module type. For example, module.compiler.compile() should
758// be defined so as to register build statements which are responsible for compiling the module.
759//
760// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
761// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
762// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
763// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800764type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700765 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700766
Jiyong Parkd1063c12019-07-17 20:08:41 +0900767 android.SdkBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500768 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700769
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700770 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700771 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700772
Colin Crossca860ac2016-01-04 14:34:37 -0800773 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700774 hod android.HostOrDeviceSupported
775 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700776
Paul Duffina0843f62019-12-13 19:50:38 +0000777 // Allowable SdkMemberTypes of this module type.
778 sdkMemberTypes []android.SdkMemberType
779
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500780 // decorator delegates, initialize before calling Init
781 // these may contain module-specific implementations, and effectively allow for custom
782 // type-specific logic. These members may reference different objects or the same object.
783 // Functions of these decorators will be invoked to initialize and register type-specific
784 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500785 compiler compiler
786 linker linker
787 installer installer
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000788 bazelHandler android.BazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500789
790 features []feature
791 stl *stl
792 sanitize *sanitize
793 coverage *coverage
794 sabi *sabi
795 vndkdep *vndkdep
796 lto *lto
797 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800798
Colin Cross31076b32020-10-23 17:22:06 -0700799 library libraryInterface
800
Colin Cross635c3b02016-05-18 15:37:25 -0700801 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800802
Colin Crossb98c8b02016-07-29 13:44:28 -0700803 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700804
805 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800806
807 // Flags used to compile this module
808 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700809
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800810 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700811 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900812
813 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800814 // Kythe (source file indexer) paths for this compilation module
815 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900816
817 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700818 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700819
820 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700821}
822
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200823func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400824 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
825 if b, ok := c.compiler.(*baseCompiler); ok {
826 hasAidl = b.hasSrcExt(".aidl")
827 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
828 hasProto = b.hasSrcExt(".proto")
829 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
830 hasSysprop = b.hasSrcExt(".sysprop")
831 hasWinMsg = b.hasSrcExt(".mc")
832 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
833 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200834 c.AndroidModuleBase().AddJSONData(d)
835 (*d)["Cc"] = map[string]interface{}{
836 "SdkVersion": c.SdkVersion(),
837 "MinSdkVersion": c.MinSdkVersion(),
838 "VndkVersion": c.VndkVersion(),
839 "ProductSpecific": c.ProductSpecific(),
840 "SocSpecific": c.SocSpecific(),
841 "DeviceSpecific": c.DeviceSpecific(),
842 "InProduct": c.InProduct(),
843 "InVendor": c.InVendor(),
844 "InRamdisk": c.InRamdisk(),
845 "InVendorRamdisk": c.InVendorRamdisk(),
846 "InRecovery": c.InRecovery(),
847 "VendorAvailable": c.VendorAvailable(),
848 "ProductAvailable": c.ProductAvailable(),
849 "RamdiskAvailable": c.RamdiskAvailable(),
850 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
851 "RecoveryAvailable": c.RecoveryAvailable(),
852 "OdmAvailable": c.OdmAvailable(),
853 "InstallInData": c.InstallInData(),
854 "InstallInRamdisk": c.InstallInRamdisk(),
855 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
856 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
857 "InstallInRecovery": c.InstallInRecovery(),
858 "InstallInRoot": c.InstallInRoot(),
859 "IsVndk": c.IsVndk(),
860 "IsVndkExt": c.IsVndkExt(),
861 "IsVndkPrivate": c.IsVndkPrivate(),
862 "IsVndkSp": c.IsVndkSp(),
863 "IsLlndk": c.IsLlndk(),
864 "IsLlndkPublic": c.IsLlndkPublic(),
865 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
866 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
867 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
868 "ApexSdkVersion": c.apexSdkVersion,
869 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400870 "AidlSrcs": hasAidl,
871 "LexSrcs": hasLex,
872 "ProtoSrcs": hasProto,
873 "RenderscriptSrcs": hasRenderscript,
874 "SyspropSrcs": hasSysprop,
875 "WinMsgSrcs": hasWinMsg,
876 "YaccSrsc": hasYacc,
877 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200878 }
879}
880
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500881func (c *Module) SetPreventInstall() {
882 c.Properties.PreventInstall = true
883}
884
885func (c *Module) SetHideFromMake() {
886 c.Properties.HideFromMake = true
887}
888
Ivan Lozanod7586b62021-04-01 09:49:36 -0400889func (c *Module) HiddenFromMake() bool {
890 return c.Properties.HideFromMake
891}
892
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800893func (c *Module) RequiredModuleNames() []string {
894 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
895 if c.ImageVariation().Variation == android.CoreVariation {
896 required = append(required, c.Properties.Target.Platform.Required...)
897 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
898 } else if c.InRecovery() {
899 required = append(required, c.Properties.Target.Recovery.Required...)
900 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
901 }
902 return android.FirstUniqueStrings(required)
903}
904
Ivan Lozano52767be2019-10-18 14:49:46 -0700905func (c *Module) Toc() android.OptionalPath {
906 if c.linker != nil {
907 if library, ok := c.linker.(libraryInterface); ok {
908 return library.toc()
909 }
910 }
911 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
912}
913
914func (c *Module) ApiLevel() string {
915 if c.linker != nil {
916 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700917 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700918 }
919 }
920 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
921}
922
923func (c *Module) Static() bool {
924 if c.linker != nil {
925 if library, ok := c.linker.(libraryInterface); ok {
926 return library.static()
927 }
928 }
929 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
930}
931
932func (c *Module) Shared() bool {
933 if c.linker != nil {
934 if library, ok := c.linker.(libraryInterface); ok {
935 return library.shared()
936 }
937 }
938 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
939}
940
941func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000942 if c.stl != nil {
943 return c.stl.Properties.SelectedStl
944 }
945 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700946}
947
948func (c *Module) ToolchainLibrary() bool {
949 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
950 return true
951 }
952 return false
953}
954
955func (c *Module) NdkPrebuiltStl() bool {
956 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
957 return true
958 }
959 return false
960}
961
962func (c *Module) StubDecorator() bool {
963 if _, ok := c.linker.(*stubDecorator); ok {
964 return true
965 }
966 return false
967}
968
969func (c *Module) SdkVersion() string {
970 return String(c.Properties.Sdk_version)
971}
972
Artur Satayev480e25b2020-04-27 18:53:18 +0100973func (c *Module) MinSdkVersion() string {
974 return String(c.Properties.Min_sdk_version)
975}
976
Jiyong Park5df7bd32021-08-25 16:18:46 +0900977func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -0700978 if linker, ok := c.linker.(*objectLinker); ok {
979 return linker.isCrt()
980 }
981 return false
982}
983
Jiyong Park5df7bd32021-08-25 16:18:46 +0900984func (c *Module) SplitPerApiLevel() bool {
985 return c.canUseSdk() && c.isCrt()
986}
987
Colin Crossc511bc52020-04-07 16:50:32 +0000988func (c *Module) AlwaysSdk() bool {
989 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
990}
991
Ivan Lozano183a3212019-10-18 14:18:45 -0700992func (c *Module) CcLibrary() bool {
993 if c.linker != nil {
994 if _, ok := c.linker.(*libraryDecorator); ok {
995 return true
996 }
Colin Crossd48fe732020-09-23 20:37:24 -0700997 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
998 return true
999 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001000 }
1001 return false
1002}
1003
1004func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001005 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001006 return true
1007 }
1008 return false
1009}
1010
Ivan Lozano2b262972019-11-21 12:30:50 -08001011func (c *Module) NonCcVariants() bool {
1012 return false
1013}
1014
Ivan Lozano183a3212019-10-18 14:18:45 -07001015func (c *Module) SetStatic() {
1016 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001017 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001018 library.setStatic()
1019 return
1020 }
1021 }
1022 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1023}
1024
1025func (c *Module) SetShared() {
1026 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001027 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001028 library.setShared()
1029 return
1030 }
1031 }
1032 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1033}
1034
1035func (c *Module) BuildStaticVariant() bool {
1036 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001037 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001038 return library.buildStatic()
1039 }
1040 }
1041 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1042}
1043
1044func (c *Module) BuildSharedVariant() bool {
1045 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001046 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001047 return library.buildShared()
1048 }
1049 }
1050 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1051}
1052
1053func (c *Module) Module() android.Module {
1054 return c
1055}
1056
Jiyong Parkc20eee32018-09-05 22:36:17 +09001057func (c *Module) OutputFile() android.OptionalPath {
1058 return c.outputFile
1059}
1060
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001061func (c *Module) CoverageFiles() android.Paths {
1062 if c.linker != nil {
1063 if library, ok := c.linker.(libraryInterface); ok {
1064 return library.objs().coverageFiles
1065 }
1066 }
1067 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1068}
1069
Ivan Lozano183a3212019-10-18 14:18:45 -07001070var _ LinkableInterface = (*Module)(nil)
1071
Jiyong Park719b4462019-01-13 00:39:51 +09001072func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001073 if c.linker != nil {
1074 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001075 }
1076 return nil
1077}
1078
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001079func (c *Module) CoverageOutputFile() android.OptionalPath {
1080 if c.linker != nil {
1081 return c.linker.coverageOutputFilePath()
1082 }
1083 return android.OptionalPath{}
1084}
1085
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001086func (c *Module) RelativeInstallPath() string {
1087 if c.installer != nil {
1088 return c.installer.relativeInstallPath()
1089 }
1090 return ""
1091}
1092
Jooyung Han344d5432019-08-23 11:17:39 +09001093func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001094 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001095}
1096
Colin Cross36242852017-06-23 15:06:31 -07001097func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001098 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001099 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001100 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001101 }
1102 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001103 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001104 }
1105 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001106 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001107 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001108 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001109 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001110 }
Colin Cross16b23492016-01-06 14:41:07 -08001111 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001112 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001113 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001114 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001115 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001116 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001117 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001118 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001119 }
Justin Yun8effde42017-06-23 19:24:43 +09001120 if c.vndkdep != nil {
1121 c.AddProperties(c.vndkdep.props()...)
1122 }
Stephen Craneba090d12017-05-09 15:44:35 -07001123 if c.lto != nil {
1124 c.AddProperties(c.lto.props()...)
1125 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001126 if c.pgo != nil {
1127 c.AddProperties(c.pgo.props()...)
1128 }
Colin Crossca860ac2016-01-04 14:34:37 -08001129 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001130 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001131 }
Colin Crossc472d572015-03-17 15:06:21 -07001132
Colin Cross36242852017-06-23 15:06:31 -07001133 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerea6666f2021-02-17 10:17:28 -05001134 android.InitBazelModule(c)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001135 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001136 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001137 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001138
Colin Cross36242852017-06-23 15:06:31 -07001139 return c
Colin Crossc472d572015-03-17 15:06:21 -07001140}
1141
Ivan Lozano52767be2019-10-18 14:49:46 -07001142func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001143 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001144}
1145
Colin Crossc511bc52020-04-07 16:50:32 +00001146func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001147 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1148 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001149}
1150
1151func (c *Module) UseSdk() bool {
1152 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001153 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001154 }
1155 return false
1156}
1157
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001158func (c *Module) isCoverageVariant() bool {
1159 return c.coverage.Properties.IsCoverageVariant
1160}
1161
Colin Cross95f1ca02020-10-29 20:47:22 -07001162func (c *Module) IsNdk(config android.Config) bool {
1163 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001164}
1165
Colin Cross127bb8b2020-12-16 16:46:01 -08001166func (c *Module) IsLlndk() bool {
1167 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001168}
1169
Colin Cross127bb8b2020-12-16 16:46:01 -08001170func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001171 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001172}
1173
Colin Cross1f3f1302021-04-26 18:37:44 -07001174func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001175 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001176 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001177}
1178
Colin Cross5271fea2021-04-27 13:06:04 -07001179func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1180 lib := moduleLibraryInterface(m)
1181 return lib != nil && (lib.hasVendorPublicLibrary())
1182}
1183
1184// IsVendorPublicLibrary returns true for vendor public libraries.
1185func (c *Module) IsVendorPublicLibrary() bool {
1186 return c.VendorProperties.IsVendorPublicLibrary
1187}
1188
Ivan Lozanod7586b62021-04-01 09:49:36 -04001189func (c *Module) HasLlndkStubs() bool {
1190 lib := moduleLibraryInterface(c)
1191 return lib != nil && lib.hasLLNDKStubs()
1192}
1193
1194func (c *Module) StubsVersion() string {
1195 if lib, ok := c.linker.(versionedInterface); ok {
1196 return lib.stubsVersion()
1197 }
1198 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1199}
1200
Colin Cross127bb8b2020-12-16 16:46:01 -08001201// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1202// and does not set llndk.vendor_available: false.
1203func (c *Module) isImplementationForLLNDKPublic() bool {
1204 library, _ := c.library.(*libraryDecorator)
1205 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001206 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001207}
1208
Justin Yunfd9e8042020-12-23 18:23:14 +09001209// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001210func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001211 // Check if VNDK-core-private or VNDK-SP-private
1212 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001213 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001214 }
1215
1216 // Check if LLNDK-private
1217 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001218 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001219 }
1220
1221 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001222}
1223
Ivan Lozano52767be2019-10-18 14:49:46 -07001224func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001225 if vndkdep := c.vndkdep; vndkdep != nil {
1226 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001227 }
1228 return false
1229}
1230
Yi Kong7e53c572018-02-14 18:16:12 +08001231func (c *Module) isPgoCompile() bool {
1232 if pgo := c.pgo; pgo != nil {
1233 return pgo.Properties.PgoCompile
1234 }
1235 return false
1236}
1237
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001238func (c *Module) isNDKStubLibrary() bool {
1239 if _, ok := c.compiler.(*stubDecorator); ok {
1240 return true
1241 }
1242 return false
1243}
1244
Ivan Lozanod7586b62021-04-01 09:49:36 -04001245func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001246 if vndkdep := c.vndkdep; vndkdep != nil {
1247 return vndkdep.isVndkSp()
1248 }
1249 return false
1250}
1251
Ivan Lozanof9e21722020-12-02 09:00:51 -05001252func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001253 if vndkdep := c.vndkdep; vndkdep != nil {
1254 return vndkdep.isVndkExt()
1255 }
1256 return false
1257}
1258
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001259func (c *Module) SubName() string {
1260 return c.Properties.SubName
1261}
1262
Ivan Lozano52767be2019-10-18 14:49:46 -07001263func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001264 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001265}
1266
Logan Chienf3511742017-10-31 18:04:35 +08001267func (c *Module) getVndkExtendsModuleName() string {
1268 if vndkdep := c.vndkdep; vndkdep != nil {
1269 return vndkdep.getVndkExtendsModuleName()
1270 }
1271 return ""
1272}
1273
Jiyong Park25fc6a92018-11-18 18:02:45 +09001274func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001275 if lib := c.library; lib != nil {
1276 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001277 }
1278 return false
1279}
1280
1281func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001282 if lib := c.library; lib != nil {
1283 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001284 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001285 return false
1286}
1287
Colin Cross0477b422020-10-13 18:43:54 -07001288// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1289// the implementation. If it is an implementation library it returns its own name.
1290func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1291 name := ctx.OtherModuleName(c)
1292 if versioned, ok := c.linker.(versionedInterface); ok {
1293 name = versioned.implementationModuleName(name)
1294 }
1295 return name
1296}
1297
Martin Stjernholm2856c662020-12-02 15:03:42 +00001298// Similar to ImplementationModuleName, but uses the Make variant of the module
1299// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1300// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1301// under the premise that the prebuilt module overrides its source counterpart
1302// if it is exposed to Make).
1303func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1304 name := c.BaseModuleName()
1305 if versioned, ok := c.linker.(versionedInterface); ok {
1306 name = versioned.implementationModuleName(name)
1307 }
1308 return name
1309}
1310
Jiyong Park7d55b612021-06-11 17:22:09 +09001311func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001312 return Bool(c.Properties.Bootstrap)
1313}
1314
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001315func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001316 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1317 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1318 return false
1319 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001320 return c.linker != nil && c.linker.nativeCoverage()
1321}
1322
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001323func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001324 if p, ok := c.linker.(SnapshotInterface); ok {
1325 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001326 }
1327 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001328}
1329
Bill Peckham945441c2020-08-31 16:07:58 -07001330func (c *Module) ExcludeFromVendorSnapshot() bool {
1331 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1332}
1333
Jose Galmesf7294582020-11-13 12:07:36 -08001334func (c *Module) ExcludeFromRecoverySnapshot() bool {
1335 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1336}
1337
Jiyong Parkf1194352019-02-25 11:05:47 +09001338func isBionic(name string) bool {
1339 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001340 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001341 return true
1342 }
1343 return false
1344}
1345
Martin Stjernholm279de572019-09-10 23:18:20 +01001346func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001347 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001348 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001349 }
1350 return isBionic(name)
1351}
1352
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001353func (c *Module) XrefCcFiles() android.Paths {
1354 return c.kytheFiles
1355}
1356
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001357func (c *Module) isCfiAssemblySupportEnabled() bool {
1358 return c.sanitize != nil &&
1359 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1360}
1361
Inseob Kim800d1142021-06-14 12:03:51 +09001362func (c *Module) InstallInRoot() bool {
1363 return c.installer != nil && c.installer.installInRoot()
1364}
1365
Colin Crossca860ac2016-01-04 14:34:37 -08001366type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001367 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001368 moduleContextImpl
1369}
1370
Colin Cross37047f12016-12-13 17:06:13 -08001371type depsContext struct {
1372 android.BottomUpMutatorContext
1373 moduleContextImpl
1374}
1375
Colin Crossca860ac2016-01-04 14:34:37 -08001376type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001377 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001378 moduleContextImpl
1379}
1380
1381type moduleContextImpl struct {
1382 mod *Module
1383 ctx BaseModuleContext
1384}
1385
Colin Crossb98c8b02016-07-29 13:44:28 -07001386func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001387 return ctx.mod.toolchain(ctx.ctx)
1388}
1389
1390func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001391 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001392}
1393
1394func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001395 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001396}
1397
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001398func (ctx *moduleContextImpl) testBinary() bool {
1399 return ctx.mod.testBinary()
1400}
1401
Jiyong Park1d1119f2019-07-29 21:27:18 +09001402func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001403 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001404}
1405
Inseob Kim7f283f42020-06-01 21:53:49 +09001406func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001407 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001408}
1409
Inseob Kim1042d292020-06-01 23:23:05 +09001410func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001411 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001412}
1413
Jooyung Hanccce2f22020-03-07 03:45:53 +09001414func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001415 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001416}
1417
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001418func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001419 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001420}
1421
1422func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001423 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001424 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001425 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001426 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001427 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001428 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001429 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001430 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001431 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001432 }
1433 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001434}
1435
Jiyong Parkb35a8192020-08-10 15:59:36 +09001436func (ctx *moduleContextImpl) minSdkVersion() string {
1437 ver := ctx.mod.MinSdkVersion()
1438 if ver == "apex_inherit" && !ctx.isForPlatform() {
1439 ver = ctx.apexSdkVersion().String()
1440 }
1441 if ver == "apex_inherit" || ver == "" {
1442 ver = ctx.sdkVersion()
1443 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001444 // For crt objects, the meaning of min_sdk_version is very different from other types of
1445 // module. For them, min_sdk_version defines the oldest version that the build system will
1446 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1447 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1448 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001449 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1450 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1451 // support such an old version. The version is set to the later version in case when the
1452 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1453 // it's for an APEX.
1454 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1455 if ctx.isForPlatform() {
1456 ver = strconv.Itoa(android.FutureApiLevelInt)
1457 } else { // for apex
1458 ver = ctx.apexSdkVersion().String()
1459 if ver == "" { // in case when min_sdk_version was not set by the APEX
1460 ver = ctx.sdkVersion()
1461 }
1462 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001463 }
1464
Jiyong Parkb35a8192020-08-10 15:59:36 +09001465 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1466 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1467 minSdkVersionInt, err2 := strconv.Atoi(ver)
1468 if err == nil && err2 == nil {
1469 if sdkVersionInt < minSdkVersionInt {
1470 return strconv.Itoa(sdkVersionInt)
1471 }
1472 }
1473 return ver
1474}
1475
1476func (ctx *moduleContextImpl) isSdkVariant() bool {
1477 return ctx.mod.IsSdkVariant()
1478}
1479
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001480func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001481 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001482}
Justin Yun8effde42017-06-23 19:24:43 +09001483
Colin Cross95f1ca02020-10-29 20:47:22 -07001484func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1485 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001486}
1487
Colin Cross127bb8b2020-12-16 16:46:01 -08001488func (ctx *moduleContextImpl) IsLlndk() bool {
1489 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001490}
1491
Colin Cross127bb8b2020-12-16 16:46:01 -08001492func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1493 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001494}
1495
Colin Cross127bb8b2020-12-16 16:46:01 -08001496func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1497 return ctx.mod.isImplementationForLLNDKPublic()
1498}
1499
1500func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1501 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001502}
1503
Logan Chienf3511742017-10-31 18:04:35 +08001504func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001505 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001506}
1507
Yi Kong7e53c572018-02-14 18:16:12 +08001508func (ctx *moduleContextImpl) isPgoCompile() bool {
1509 return ctx.mod.isPgoCompile()
1510}
1511
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001512func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1513 return ctx.mod.isNDKStubLibrary()
1514}
1515
Justin Yun8effde42017-06-23 19:24:43 +09001516func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001517 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001518}
1519
Ivan Lozanof9e21722020-12-02 09:00:51 -05001520func (ctx *moduleContextImpl) IsVndkExt() bool {
1521 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001522}
1523
Colin Cross5271fea2021-04-27 13:06:04 -07001524func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1525 return ctx.mod.IsVendorPublicLibrary()
1526}
1527
Vic Yangefd249e2018-11-12 20:19:56 -08001528func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001529 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001530}
1531
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001532func (ctx *moduleContextImpl) selectedStl() string {
1533 if stl := ctx.mod.stl; stl != nil {
1534 return stl.Properties.SelectedStl
1535 }
1536 return ""
1537}
1538
Ivan Lozanobd721262018-11-27 14:33:03 -08001539func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1540 return ctx.mod.linker.useClangLld(actx)
1541}
1542
Colin Crossce75d2c2016-10-06 16:12:58 -07001543func (ctx *moduleContextImpl) baseModuleName() string {
1544 return ctx.mod.ModuleBase.BaseModuleName()
1545}
1546
Logan Chienf3511742017-10-31 18:04:35 +08001547func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1548 return ctx.mod.getVndkExtendsModuleName()
1549}
1550
Logan Chiene274fc92019-12-03 11:18:32 -08001551func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001552 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001553}
1554
Colin Crosse07f2312020-08-13 11:24:56 -07001555func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001556 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001557}
1558
Dan Albertc8060532020-07-22 22:32:17 -07001559func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001560 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001561}
1562
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001563func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001564 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001565}
1566
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001567func (ctx *moduleContextImpl) nativeCoverage() bool {
1568 return ctx.mod.nativeCoverage()
1569}
1570
Colin Cross56a83212020-09-15 18:30:11 -07001571func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1572 return ctx.mod.DirectlyInAnyApex()
1573}
1574
Colin Cross95b07f22020-12-16 11:06:50 -08001575func (ctx *moduleContextImpl) isPreventInstall() bool {
1576 return ctx.mod.Properties.PreventInstall
1577}
1578
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001579func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1580 return ctx.mod.isCfiAssemblySupportEnabled()
1581}
1582
Colin Cross635c3b02016-05-18 15:37:25 -07001583func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001584 return &Module{
1585 hod: hod,
1586 multilib: multilib,
1587 }
1588}
1589
Colin Cross635c3b02016-05-18 15:37:25 -07001590func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001591 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001592 module.features = []feature{
1593 &tidyFeature{},
1594 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001595 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001596 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001597 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001598 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001599 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001600 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001601 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001602 return module
1603}
1604
Colin Crossce75d2c2016-10-06 16:12:58 -07001605func (c *Module) Prebuilt() *android.Prebuilt {
1606 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1607 return p.prebuilt()
1608 }
1609 return nil
1610}
1611
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001612func (c *Module) IsPrebuilt() bool {
1613 return c.Prebuilt() != nil
1614}
1615
Colin Crossce75d2c2016-10-06 16:12:58 -07001616func (c *Module) Name() string {
1617 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001618 if p, ok := c.linker.(interface {
1619 Name(string) string
1620 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001621 name = p.Name(name)
1622 }
1623 return name
1624}
1625
Alex Light3d673592019-01-18 14:37:31 -08001626func (c *Module) Symlinks() []string {
1627 if p, ok := c.installer.(interface {
1628 symlinkList() []string
1629 }); ok {
1630 return p.symlinkList()
1631 }
1632 return nil
1633}
1634
Roland Levillainf89cd092019-07-29 16:22:59 +01001635func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1636 test, ok := c.linker.(testPerSrc)
1637 return ok && test.isAllTestsVariation()
1638}
1639
Chris Parsons216e10a2020-07-09 17:12:52 -04001640func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001641 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001642 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001643 }); ok {
1644 return p.dataPaths()
1645 }
1646 return nil
1647}
1648
Justin Yun5f7f7e82019-11-18 19:52:14 +09001649func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1650 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1651 // "current", it will append the VNDK version to the name suffix.
1652 var vndkVersion string
1653 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001654 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001655 if c.ProductSpecific() {
1656 // If the module is product specific with 'product_specific: true',
1657 // do not add a name suffix because it is a base module.
1658 return ""
1659 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001660 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
Matthew Maurer52af5b02021-05-27 10:01:36 -07001661 nameSuffix = ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001662 } else {
1663 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001664 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001665 }
1666 if vndkVersion == "current" {
1667 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1668 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001669 if c.Properties.VndkVersion != vndkVersion && c.Properties.VndkVersion != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001670 // add version suffix only if the module is using different vndk version than the
1671 // version in product or vendor partition.
1672 nameSuffix += "." + c.Properties.VndkVersion
1673 }
1674 return nameSuffix
1675}
1676
Chris Parsons8d6e4332021-02-22 16:13:50 -05001677func (c *Module) setSubnameProperty(actx android.ModuleContext) {
Inseob Kim64c43952019-08-26 16:52:35 +09001678 c.Properties.SubName = ""
1679
1680 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07001681 c.Properties.SubName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001682 }
1683
Colin Cross127bb8b2020-12-16 16:46:01 -08001684 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001685 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001686 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1687 // added for product variant only when we have vendor and product variants with core
1688 // variant. The suffix is not added for vendor-only or product-only module.
1689 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
Colin Cross5271fea2021-04-27 13:06:04 -07001690 } else if c.IsVendorPublicLibrary() {
1691 c.Properties.SubName += vendorPublicLibrarySuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001692 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001693 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1694 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001695 c.Properties.SubName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001696 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07001697 c.Properties.SubName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001698 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001699 c.Properties.SubName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001700 } else if c.InRecovery() && !c.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08001701 c.Properties.SubName += RecoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001702 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001703 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001704 if c.SplitPerApiLevel() {
1705 c.Properties.SubName += "." + c.SdkVersion()
1706 }
Inseob Kim64c43952019-08-26 16:52:35 +09001707 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001708}
1709
1710// Returns true if Bazel was successfully used for the analysis of this module.
1711func (c *Module) maybeGenerateBazelActions(actx android.ModuleContext) bool {
Liz Kammerbdc60992021-02-24 16:55:11 -05001712 bazelModuleLabel := c.GetBazelLabel(actx, c)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001713 bazelActionsUsed := false
Chris Parsonsbab4d7e2021-04-15 17:27:08 -04001714 if c.MixedBuildsEnabled(actx) && c.bazelHandler != nil {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +00001715 bazelActionsUsed = c.bazelHandler.GenerateBazelBuildActions(actx, bazelModuleLabel)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001716 }
1717 return bazelActionsUsed
1718}
1719
1720func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1721 // TODO(cparsons): Any logic in this method occurring prior to querying Bazel should be
1722 // requested from Bazel instead.
1723
1724 // Handle the case of a test module split by `test_per_src` mutator.
1725 //
1726 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1727 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1728 // module and return early, as this module does not produce an output file per se.
1729 if c.IsTestPerSrcAllTestsVariation() {
1730 c.outputFile = android.OptionalPath{}
1731 return
1732 }
1733
1734 c.setSubnameProperty(actx)
1735 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1736 if !apexInfo.IsForPlatform() {
1737 c.hideApexVariantFromMake = true
1738 }
1739
Chris Parsonseefc9e62021-04-02 17:36:47 -04001740 c.makeLinkType = GetMakeLinkType(actx, c)
1741
Colin Crossca860ac2016-01-04 14:34:37 -08001742 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001743 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001744 moduleContextImpl: moduleContextImpl{
1745 mod: c,
1746 },
1747 }
1748 ctx.ctx = ctx
1749
Chris Parsons94a0bba2021-06-04 15:03:47 -04001750 if c.maybeGenerateBazelActions(actx) {
1751 c.maybeInstall(ctx, apexInfo)
1752 return
1753 }
1754
Colin Crossf18e1102017-11-16 14:33:08 -08001755 deps := c.depsToPaths(ctx)
1756 if ctx.Failed() {
1757 return
1758 }
1759
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001760 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1761 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1762 }
1763
Colin Crossca860ac2016-01-04 14:34:37 -08001764 flags := Flags{
1765 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001766 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001767 }
Colin Crossca860ac2016-01-04 14:34:37 -08001768 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001769 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001770 }
1771 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001772 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001773 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001774 if c.stl != nil {
1775 flags = c.stl.flags(ctx, flags)
1776 }
Colin Cross16b23492016-01-06 14:41:07 -08001777 if c.sanitize != nil {
1778 flags = c.sanitize.flags(ctx, flags)
1779 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001780 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001781 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001782 }
Stephen Craneba090d12017-05-09 15:44:35 -07001783 if c.lto != nil {
1784 flags = c.lto.flags(ctx, flags)
1785 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001786 if c.pgo != nil {
1787 flags = c.pgo.flags(ctx, flags)
1788 }
Colin Crossca860ac2016-01-04 14:34:37 -08001789 for _, feature := range c.features {
1790 flags = feature.flags(ctx, flags)
1791 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001792 if ctx.Failed() {
1793 return
1794 }
1795
Colin Cross4af21ed2019-11-04 09:37:55 -08001796 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1797 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1798 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001799
Colin Cross4af21ed2019-11-04 09:37:55 -08001800 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001801
1802 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001803 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001804 }
1805 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001806 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001807 }
1808
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001809 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001810 // We need access to all the flags seen by a source file.
1811 if c.sabi != nil {
1812 flags = c.sabi.flags(ctx, flags)
1813 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001814
Colin Cross4af21ed2019-11-04 09:37:55 -08001815 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001816
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001817 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001818 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001819 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001820 if ctx.Failed() {
1821 return
1822 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001823 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001824 }
1825
Colin Crossca860ac2016-01-04 14:34:37 -08001826 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001827 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001828 if ctx.Failed() {
1829 return
1830 }
Colin Cross635c3b02016-05-18 15:37:25 -07001831 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001832
Chris Parsons94a0bba2021-06-04 15:03:47 -04001833 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001834
Jose Galmes6f843bc2020-12-11 13:36:29 -08001835 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
1836 // RECOVERY_SNAPSHOT_VERSION is current.
1837 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001838 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001839 i.collectHeadersForSnapshot(ctx)
1840 }
1841 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001842 }
Colin Cross5049f022015-03-18 13:28:46 -07001843
Chris Parsons94a0bba2021-06-04 15:03:47 -04001844 c.maybeInstall(ctx, apexInfo)
1845}
1846
1847func (c *Module) maybeUnhideFromMake() {
1848 // If a lib is directly included in any of the APEXes or is not available to the
1849 // platform (which is often the case when the stub is provided as a prebuilt),
1850 // unhide the stubs variant having the latest version gets visible to make. In
1851 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1852 // force anything in the make world to link against the stubs library. (unless it
1853 // is explicitly referenced via .bootstrap suffix or the module is marked with
1854 // 'bootstrap: true').
1855 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
1856 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
1857 c.IsStubs() && !c.InVendorRamdisk() {
1858 c.Properties.HideFromMake = false // unhide
1859 // Note: this is still non-installable
1860 }
1861}
1862
1863func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001864 if !proptools.BoolDefault(c.Properties.Installable, true) {
1865 // If the module has been specifically configure to not be installed then
1866 // hide from make as otherwise it will break when running inside make
1867 // as the output path to install will not be specified. Not all uninstallable
1868 // modules can be hidden from make as some are needed for resolving make side
1869 // dependencies.
1870 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001871 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001872 c.SkipInstall()
1873 }
1874
1875 // Still call c.installer.install though, the installs will be stored as PackageSpecs
1876 // to allow using the outputs in a genrule.
1877 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001878 c.installer.install(ctx, c.outputFile.Path())
1879 if ctx.Failed() {
1880 return
Colin Crossca860ac2016-01-04 14:34:37 -08001881 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001882 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001883}
1884
Colin Cross0ea8ba82019-06-06 14:33:29 -07001885func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001886 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05001887 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08001888 }
Colin Crossca860ac2016-01-04 14:34:37 -08001889 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001890}
1891
Colin Crossca860ac2016-01-04 14:34:37 -08001892func (c *Module) begin(ctx BaseModuleContext) {
1893 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001894 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001895 }
Colin Crossca860ac2016-01-04 14:34:37 -08001896 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001897 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001898 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001899 if c.stl != nil {
1900 c.stl.begin(ctx)
1901 }
Colin Cross16b23492016-01-06 14:41:07 -08001902 if c.sanitize != nil {
1903 c.sanitize.begin(ctx)
1904 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001905 if c.coverage != nil {
1906 c.coverage.begin(ctx)
1907 }
Stephen Craneba090d12017-05-09 15:44:35 -07001908 if c.lto != nil {
1909 c.lto.begin(ctx)
1910 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001911 if c.pgo != nil {
1912 c.pgo.begin(ctx)
1913 }
Dan Albert92fe7402020-07-15 13:33:30 -07001914 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001915 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001916 if err != nil {
1917 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001918 c.Properties.Sdk_version = nil
1919 } else {
1920 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001921 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001922 }
Colin Crossca860ac2016-01-04 14:34:37 -08001923}
1924
Colin Cross37047f12016-12-13 17:06:13 -08001925func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001926 deps := Deps{}
1927
1928 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001929 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001930 }
1931 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001932 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001933 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001934 if c.stl != nil {
1935 deps = c.stl.deps(ctx, deps)
1936 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001937 if c.coverage != nil {
1938 deps = c.coverage.deps(ctx, deps)
1939 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001940
Colin Crossb6715442017-10-24 11:13:31 -07001941 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1942 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1943 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1944 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1945 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1946 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001947 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001948
Liz Kammer356f7d42021-01-26 09:18:53 -05001949 // In Bazel conversion mode, we dependency and build validations will occur in Bazel, so there is
1950 // no need to do so in Soong.
1951 if ctx.BazelConversionMode() {
1952 return deps
1953 }
1954
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001955 for _, lib := range deps.ReexportSharedLibHeaders {
1956 if !inList(lib, deps.SharedLibs) {
1957 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1958 }
1959 }
1960
1961 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00001962 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
1963 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 -07001964 }
1965 }
1966
Colin Cross5950f382016-12-13 12:50:57 -08001967 for _, lib := range deps.ReexportHeaderLibHeaders {
1968 if !inList(lib, deps.HeaderLibs) {
1969 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1970 }
1971 }
1972
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001973 for _, gen := range deps.ReexportGeneratedHeaders {
1974 if !inList(gen, deps.GeneratedHeaders) {
1975 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1976 }
1977 }
1978
Colin Crossc99deeb2016-04-11 15:06:20 -07001979 return deps
1980}
1981
Dan Albert7e9d2952016-08-04 13:02:36 -07001982func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001983 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001984 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001985 moduleContextImpl: moduleContextImpl{
1986 mod: c,
1987 },
1988 }
1989 ctx.ctx = ctx
1990
Colin Crossca860ac2016-01-04 14:34:37 -08001991 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001992}
1993
Jiyong Park7ed9de32018-10-15 22:25:07 +09001994// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001995func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001996 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1997 version := name[sharp+1:]
1998 libname := name[:sharp]
1999 return libname, version
2000 }
2001 return name, ""
2002}
2003
Dan Albert92fe7402020-07-15 13:33:30 -07002004func GetCrtVariations(ctx android.BottomUpMutatorContext,
2005 m LinkableInterface) []blueprint.Variation {
2006 if ctx.Os() != android.Android {
2007 return nil
2008 }
2009 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002010 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2011 minSdkVersion := m.MinSdkVersion()
2012 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2013 minSdkVersion = m.SdkVersion()
2014 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002015 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2016 if err != nil {
2017 ctx.PropertyErrorf("min_sdk_version", err.Error())
2018 }
Dan Albert92fe7402020-07-15 13:33:30 -07002019 return []blueprint.Variation{
2020 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002021 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002022 }
2023 }
2024 return []blueprint.Variation{
2025 {Mutator: "sdk", Variation: ""},
2026 }
2027}
2028
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002029func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2030 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002031
2032 variations = append([]blueprint.Variation(nil), variations...)
2033
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002034 if version != "" && CanBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002035 // Version is explicitly specified. i.e. libFoo#30
2036 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002037 if tag, ok := depTag.(libraryDependencyTag); ok {
2038 tag.explicitlyVersioned = true
2039 } else {
2040 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2041 }
Colin Crosse7257d22020-09-24 09:56:18 -07002042 }
Colin Crosse7257d22020-09-24 09:56:18 -07002043
Colin Cross0de8a1e2020-09-18 14:15:30 -07002044 if far {
2045 ctx.AddFarVariationDependencies(variations, depTag, name)
2046 } else {
2047 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002048 }
2049}
2050
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002051func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002052 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002053 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002054 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002055 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2056 // between the modules in the snapshot and the snapshot itself.
2057 var snapshotModule []blueprint.Module
2058 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2059 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2060 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2061 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2062 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002063 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002064 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2065 *snapshotInfo = &snapshot
2066 // republish the snapshot for use in later mutators on this module
2067 actx.SetProvider(SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002068 }
2069 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002070 if *snapshotInfo == nil {
2071 *snapshotInfo = &SnapshotInfo{}
2072 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002073 return **snapshotInfo
2074}
2075
2076func RewriteSnapshotLib(lib string, snapshotMap map[string]string) string {
2077 if snapshot, ok := snapshotMap[lib]; ok {
2078 return snapshot
2079 }
2080
2081 return lib
2082}
2083
2084// RewriteLibs takes a list of names of shared libraries and scans it for three types
2085// of names:
2086//
2087// 1. Name of an NDK library that refers to a prebuilt module.
2088// For each of these, it adds the name of the prebuilt module (which will be in
2089// prebuilts/ndk) to the list of nonvariant libs.
2090// 2. Name of an NDK library that refers to an ndk_library module.
2091// For each of these, it adds the name of the ndk_library module to the list of
2092// variant libs.
2093// 3. Anything else (so anything that isn't an NDK library).
2094// It adds these to the nonvariantLibs list.
2095//
2096// The caller can then know to add the variantLibs dependencies differently from the
2097// nonvariantLibs
2098func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2099 variantLibs = []string{}
2100
2101 nonvariantLibs = []string{}
2102 for _, entry := range list {
2103 // strip #version suffix out
2104 name, _ := StubsLibNameAndVersion(entry)
2105 if c.InRecovery() {
2106 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2107 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2108 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2109 } else if c.UseVndk() {
2110 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2111 } else {
2112 // put name#version back
2113 nonvariantLibs = append(nonvariantLibs, entry)
2114 }
2115 }
2116 return nonvariantLibs, variantLibs
2117}
2118
Colin Cross1e676be2016-10-12 14:38:15 -07002119func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002120 if !c.Enabled() {
2121 return
2122 }
2123
Colin Cross37047f12016-12-13 17:06:13 -08002124 ctx := &depsContext{
2125 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002126 moduleContextImpl: moduleContextImpl{
2127 mod: c,
2128 },
2129 }
2130 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002131
Colin Crossc99deeb2016-04-11 15:06:20 -07002132 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002133
Yo Chiang219968c2020-09-22 18:45:04 +08002134 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2135
Colin Crosse0edaf92021-01-11 17:31:17 -08002136 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002137
Dan Albert914449f2016-06-17 16:45:24 -07002138 variantNdkLibs := []string{}
2139 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002140 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002141 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2142 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2143 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002144
2145 for idx, lib := range deps.RuntimeLibs {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002146 deps.RuntimeLibs[idx] = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002147 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002148 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002149
Colin Cross32ec36c2016-12-15 07:39:51 -08002150 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002151 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002152 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002153 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002154 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002155
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002156 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002157
Jiyong Park1ad8e162020-12-01 23:40:09 +09002158 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002159 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002160 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002161 } else {
2162 actx.AddVariationDependencies(nil, depTag, lib)
2163 }
2164 }
2165
Dan Albertf1d14c72020-07-30 14:32:55 -07002166 if c.isNDKStubLibrary() {
2167 // NDK stubs depend on their implementation because the ABI dumps are
2168 // generated from the implementation library.
2169 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2170 c.ImageVariation(),
2171 blueprint.Variation{Mutator: "link", Variation: "shared"},
2172 ), stubImplementation, c.BaseModuleName())
2173 }
2174
Inseob Kim07def122020-11-23 14:43:02 +09002175 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
2176 // C++ implementation library and one Java implementation library. When a module links against
2177 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
2178 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
2179 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09002180 syspropImplLibraries := syspropImplLibraries(actx.Config())
2181
Jiyong Park5d1598f2019-02-25 22:14:17 +09002182 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002183 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09002184 if impl, ok := syspropImplLibraries[lib]; ok {
2185 lib = impl
2186 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002187
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002188 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002189
Jiyong Park5d1598f2019-02-25 22:14:17 +09002190 actx.AddVariationDependencies([]blueprint.Variation{
2191 {Mutator: "link", Variation: "static"},
2192 }, depTag, lib)
2193 }
2194
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002195 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002196 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002197 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002198 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002199 }
Jiyong Parke3867542020-12-03 17:28:25 +09002200 if inList(lib, deps.ExcludeLibsForApex) {
2201 depTag.excludeInApex = true
2202 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002203
2204 if impl, ok := syspropImplLibraries[lib]; ok {
2205 lib = impl
2206 }
2207
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002208 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002209
Dan Willemsen59339a22018-07-22 21:18:45 -07002210 actx.AddVariationDependencies([]blueprint.Variation{
2211 {Mutator: "link", Variation: "static"},
2212 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002213 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002214
Jooyung Han75568392020-03-20 04:29:24 +09002215 // staticUnwinderDep is treated as staticDep for Q apexes
2216 // so that native libraries/binaries are linked with static unwinder
2217 // because Q libc doesn't have unwinder APIs
2218 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002219 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002220 actx.AddVariationDependencies([]blueprint.Variation{
2221 {Mutator: "link", Variation: "static"},
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002222 }, depTag, RewriteSnapshotLib(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002223 }
2224
Jiyong Park7ed9de32018-10-15 22:25:07 +09002225 // shared lib names without the #version suffix
2226 var sharedLibNames []string
2227
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002228 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002229 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002230 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002231 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002232 }
Jiyong Parke3867542020-12-03 17:28:25 +09002233 if inList(lib, deps.ExcludeLibsForApex) {
2234 depTag.excludeInApex = true
2235 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002236
2237 if impl, ok := syspropImplLibraries[lib]; ok {
2238 lib = impl
2239 }
2240
Jiyong Park73c54ee2019-10-22 20:31:18 +09002241 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002242 sharedLibNames = append(sharedLibNames, name)
2243
Colin Crosse7257d22020-09-24 09:56:18 -07002244 variations := []blueprint.Variation{
2245 {Mutator: "link", Variation: "shared"},
2246 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002247 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002248 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002249
Colin Crossfe9acfe2021-06-14 16:13:03 -07002250 for _, lib := range deps.LateStaticLibs {
2251 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2252 actx.AddVariationDependencies([]blueprint.Variation{
2253 {Mutator: "link", Variation: "static"},
2254 }, depTag, RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
2255 }
2256
Jiyong Park7ed9de32018-10-15 22:25:07 +09002257 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002258 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002259 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2260 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2261 // linking against both the stubs lib and the non-stubs lib at the same time.
2262 continue
2263 }
Colin Cross6e511a92020-07-27 21:26:48 -07002264 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002265 variations := []blueprint.Variation{
2266 {Mutator: "link", Variation: "shared"},
2267 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002268 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002269 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002270
Dan Willemsen59339a22018-07-22 21:18:45 -07002271 actx.AddVariationDependencies([]blueprint.Variation{
2272 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002273 }, dataLibDepTag, deps.DataLibs...)
2274
2275 actx.AddVariationDependencies([]blueprint.Variation{
2276 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002277 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002278
Colin Cross68861832016-07-08 10:41:41 -07002279 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002280
2281 for _, gen := range deps.GeneratedHeaders {
2282 depTag := genHeaderDepTag
2283 if inList(gen, deps.ReexportGeneratedHeaders) {
2284 depTag = genHeaderExportDepTag
2285 }
2286 actx.AddDependency(c, depTag, gen)
2287 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002288
Dan Albert92fe7402020-07-15 13:33:30 -07002289 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002290 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002291 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002292 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002293 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002294 }
Colin Crossc465efd2021-06-11 18:00:04 -07002295 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002296 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002297 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002298 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002299 if deps.DynamicLinker != "" {
2300 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002301 }
Dan Albert914449f2016-06-17 16:45:24 -07002302
2303 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002304
2305 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002306 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002307 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002308 {Mutator: "link", Variation: "shared"},
2309 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002310
2311 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002312 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002313 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002314 {Mutator: "link", Variation: "shared"},
2315 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002316
2317 if vndkdep := c.vndkdep; vndkdep != nil {
2318 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002319 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002320 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002321 {Mutator: "link", Variation: "shared"},
Justin Yun27b95722021-07-28 17:04:44 +09002322 }, vndkExtDepTag, RewriteSnapshotLib(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002323 }
2324 }
Colin Cross6362e272015-10-29 15:25:03 -07002325}
Colin Cross21b9a242015-03-24 14:15:58 -07002326
Colin Crosse40b4ea2018-10-02 22:25:58 -07002327func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002328 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2329 c.beginMutator(ctx)
2330 }
2331}
2332
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002333// Whether a module can link to another module, taking into
2334// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002335func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002336 tag blueprint.DependencyTag) {
2337
2338 switch t := tag.(type) {
2339 case dependencyTag:
2340 if t != vndkExtDepTag {
2341 return
2342 }
2343 case libraryDependencyTag:
2344 default:
2345 return
2346 }
2347
Ivan Lozanof9e21722020-12-02 09:00:51 -05002348 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002349 // Host code is not restricted
2350 return
2351 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002352
2353 // VNDK is cc.Module supported only for now.
2354 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002355 // Though allowed dependency is limited by the image mutator,
2356 // each vendor and product module needs to check link-type
2357 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002358 if ccTo, ok := to.(*Module); ok {
2359 if ccFrom.vndkdep != nil {
2360 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2361 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002362 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002363 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002364 }
2365 return
2366 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002367 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002368 // Platform code can link to anything
2369 return
2370 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002371 if from.InRamdisk() {
2372 // Ramdisk code is not NDK
2373 return
2374 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002375 if from.InVendorRamdisk() {
2376 // Vendor ramdisk code is not NDK
2377 return
2378 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002379 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002380 // Recovery code is not NDK
2381 return
2382 }
Colin Cross31076b32020-10-23 17:22:06 -07002383 if c, ok := to.(*Module); ok {
2384 if c.ToolchainLibrary() {
2385 // These are always allowed
2386 return
2387 }
2388 if c.NdkPrebuiltStl() {
2389 // These are allowed, but they don't set sdk_version
2390 return
2391 }
2392 if c.StubDecorator() {
2393 // These aren't real libraries, but are the stub shared libraries that are included in
2394 // the NDK.
2395 return
2396 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002397 }
Logan Chien834b9a62019-01-14 15:39:03 +08002398
Ivan Lozano52767be2019-10-18 14:49:46 -07002399 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002400 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2401 // to link to libc++ (non-NDK and without sdk_version).
2402 return
2403 }
2404
Ivan Lozano52767be2019-10-18 14:49:46 -07002405 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002406 // NDK code linking to platform code is never okay.
2407 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002408 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002409 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002410 }
2411
2412 // At this point we know we have two NDK libraries, but we need to
2413 // check that we're not linking against anything built against a higher
2414 // API level, as it is only valid to link against older or equivalent
2415 // APIs.
2416
Inseob Kim01a28722018-04-11 09:48:45 +09002417 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002418 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002419 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002420 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002421 // Current can't be linked against by anything else.
2422 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002423 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002424 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002425 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002426 if err != nil {
2427 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002428 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002429 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002430 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002431 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002432 if err != nil {
2433 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002434 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002435 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002436 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002437
Inseob Kim01a28722018-04-11 09:48:45 +09002438 if toApi > fromApi {
2439 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002440 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002441 }
2442 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002443 }
Dan Albert202fe492017-12-15 13:56:59 -08002444
2445 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002446 fromStl := from.SelectedStl()
2447 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002448 if fromStl == "" || toStl == "" {
2449 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002450 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002451 // We can be permissive with the system "STL" since it is only the C++
2452 // ABI layer, but in the future we should make sure that everyone is
2453 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002454 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002455 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002456 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2457 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002458 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002459}
2460
Jooyung Han479ca172020-10-19 18:51:07 +09002461func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2462 if c, ok := ctx.Module().(*Module); ok {
2463 ctx.VisitDirectDeps(func(dep android.Module) {
2464 depTag := ctx.OtherModuleDependencyTag(dep)
2465 ccDep, ok := dep.(LinkableInterface)
2466 if ok {
2467 checkLinkType(ctx, c, ccDep, depTag)
2468 }
2469 })
2470 }
2471}
2472
Jiyong Park5fb8c102018-04-09 12:03:06 +09002473// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002474// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2475// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002476// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002477func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2478 check := func(child, parent android.Module) bool {
2479 to, ok := child.(*Module)
2480 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002481 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002482 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002483
Jooyung Hana70f0672019-01-18 15:20:43 +09002484 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2485 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002486 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002487
Jiyong Park0474e1f2021-01-14 14:26:06 +09002488 // These dependencies are not excercised at runtime. Tracking these will give us
2489 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002490 depTag := ctx.OtherModuleDependencyTag(child)
2491 if IsHeaderDepTag(depTag) {
2492 return false
2493 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002494 if depTag == staticVariantTag {
2495 return false
2496 }
2497 if depTag == stubImplDepTag {
2498 return false
2499 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002500
Justin Yun63e9ec72020-10-29 16:49:43 +09002501 // Even if target lib has no vendor variant, keep checking dependency
2502 // graph in case it depends on vendor_available or product_available
2503 // but not double_loadable transtively.
2504 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002505 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002506 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002507
Jiyong Park0474e1f2021-01-14 14:26:06 +09002508 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2509 // one.
2510 if Bool(to.VendorProperties.Double_loadable) {
2511 return true
2512 }
2513
Ivan Lozanod7586b62021-04-01 09:49:36 -04002514 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002515 return false
2516 }
2517
Jooyung Hana70f0672019-01-18 15:20:43 +09002518 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2519 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002520 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002521 return false
2522 }
2523 if module, ok := ctx.Module().(*Module); ok {
2524 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002525 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002526 ctx.WalkDeps(check)
2527 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002528 }
2529 }
2530}
2531
Colin Crossc99deeb2016-04-11 15:06:20 -07002532// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002533func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002534 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002535
Colin Cross0de8a1e2020-09-18 14:15:30 -07002536 var directStaticDeps []StaticLibraryInfo
2537 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002538
Colin Cross0de8a1e2020-09-18 14:15:30 -07002539 reexportExporter := func(exporter FlagExporterInfo) {
2540 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2541 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2542 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2543 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2544 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002545 }
2546
Jooyung Hande34d232020-07-23 13:04:15 +09002547 // For the dependency from platform to apex, use the latest stubs
2548 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002549 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2550 if !apexInfo.IsForPlatform() {
Jiyong Park4eab21d2021-04-15 15:17:54 +09002551 c.apexSdkVersion = apexInfo.MinSdkVersion
Jooyung Hande34d232020-07-23 13:04:15 +09002552 }
2553
2554 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2555 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2556 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2557 // (b/144430859)
2558 c.apexSdkVersion = android.FutureApiLevel
2559 }
2560
Colin Crossd11fcda2017-10-23 17:59:01 -07002561 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002562 depName := ctx.OtherModuleName(dep)
2563 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002564
Ivan Lozano52767be2019-10-18 14:49:46 -07002565 ccDep, ok := dep.(LinkableInterface)
2566 if !ok {
2567
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002568 // handling for a few module types that aren't cc Module but that are also supported
2569 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002570 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002571 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002572 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2573 genRule.GeneratedSourceFiles()...)
2574 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002575 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002576 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002577 // Support exported headers from a generated_sources dependency
2578 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002579 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002580 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002581 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002582 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002583 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002584 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002585 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002586 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002587 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2588 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002589 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002590 // 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 +09002591 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002592
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002593 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002594 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002595 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002596 }
Colin Crosscef792e2021-06-11 18:01:26 -07002597 case CrtBeginDepTag:
2598 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2599 case CrtEndDepTag:
2600 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002601 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002602 return
2603 }
2604
Colin Crossfe17f6f2019-03-28 19:30:56 -07002605 if depTag == android.ProtoPluginDepTag {
2606 return
2607 }
2608
Colin Crossd11fcda2017-10-23 17:59:01 -07002609 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002610 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2611 return
2612 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002613 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002614 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2615 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002616 return
2617 }
2618
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002619 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002620 // Skip reused objects for stub libraries, they use their own stub object file instead.
2621 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2622 // version mutator, so the stubs variant is created from the shared variant that
2623 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002624 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002625 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2626 objs := staticAnalogue.ReuseObjects
2627 depPaths.Objs = depPaths.Objs.Append(objs)
2628 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2629 reexportExporter(depExporterInfo)
2630 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002631 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002632 }
2633
Colin Cross6e511a92020-07-27 21:26:48 -07002634 linkFile := ccDep.OutputFile()
2635
2636 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2637 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002638 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002639 return
2640 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002641
Jiyong Parke3867542020-12-03 17:28:25 +09002642 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2643 return
2644 }
2645
Colin Cross0de8a1e2020-09-18 14:15:30 -07002646 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002647
Colin Cross6e511a92020-07-27 21:26:48 -07002648 var ptr *android.Paths
2649 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002650
Colin Cross6e511a92020-07-27 21:26:48 -07002651 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002652
Colin Cross6e511a92020-07-27 21:26:48 -07002653 switch {
2654 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002655 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2656 if !ctx.Config().AllowMissingDependencies() {
2657 ctx.ModuleErrorf("module %q is not a header library", depName)
2658 } else {
2659 ctx.AddMissingDependencies([]string{depName})
2660 }
2661 return
2662 }
Colin Cross6e511a92020-07-27 21:26:48 -07002663 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002664 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2665 if !ctx.Config().AllowMissingDependencies() {
2666 ctx.ModuleErrorf("module %q is not a shared library", depName)
2667 } else {
2668 ctx.AddMissingDependencies([]string{depName})
2669 }
2670 return
2671 }
Jiyong Parke3867542020-12-03 17:28:25 +09002672
Jiyong Park7d55b612021-06-11 17:22:09 +09002673 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
2674 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07002675
Jiyong Park1ad8e162020-12-01 23:40:09 +09002676 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2677 // linkFile, depFile, and ptr.
2678 if c.IsStubs() {
2679 break
2680 }
2681
Colin Cross0de8a1e2020-09-18 14:15:30 -07002682 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2683 depFile = sharedLibraryInfo.TableOfContents
2684
Colin Cross6e511a92020-07-27 21:26:48 -07002685 ptr = &depPaths.SharedLibs
2686 switch libDepTag.Order {
2687 case earlyLibraryDependency:
2688 ptr = &depPaths.EarlySharedLibs
2689 depPtr = &depPaths.EarlySharedLibsDeps
2690 case normalLibraryDependency:
2691 ptr = &depPaths.SharedLibs
2692 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002693 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002694 case lateLibraryDependency:
2695 ptr = &depPaths.LateSharedLibs
2696 depPtr = &depPaths.LateSharedLibsDeps
2697 default:
2698 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002699 }
Colin Cross6e511a92020-07-27 21:26:48 -07002700 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002701 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2702 if !ctx.Config().AllowMissingDependencies() {
2703 ctx.ModuleErrorf("module %q is not a static library", depName)
2704 } else {
2705 ctx.AddMissingDependencies([]string{depName})
2706 }
2707 return
2708 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002709
2710 // Stubs lib doesn't link to the static lib dependencies. Don't set
2711 // linkFile, depFile, and ptr.
2712 if c.IsStubs() {
2713 break
2714 }
2715
Colin Cross0de8a1e2020-09-18 14:15:30 -07002716 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2717 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002718 if libDepTag.wholeStatic {
2719 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002720 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2721 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002722 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002723 // This case normally catches prebuilt static
2724 // libraries, but it can also occur when
2725 // AllowMissingDependencies is on and the
2726 // dependencies has no sources of its own
2727 // but has a whole_static_libs dependency
2728 // on a missing library. We want to depend
2729 // on the .a file so that there is something
2730 // in the dependency tree that contains the
2731 // error rule for the missing transitive
2732 // dependency.
2733 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002734 }
Colin Cross6e511a92020-07-27 21:26:48 -07002735 } else {
2736 switch libDepTag.Order {
2737 case earlyLibraryDependency:
2738 panic(fmt.Errorf("early static libs not suppported"))
2739 case normalLibraryDependency:
2740 // static dependencies will be handled separately so they can be ordered
2741 // using transitive dependencies.
2742 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002743 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002744 case lateLibraryDependency:
2745 ptr = &depPaths.LateStaticLibs
2746 default:
2747 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002748 }
2749 }
2750 }
2751
Colin Cross6e511a92020-07-27 21:26:48 -07002752 if libDepTag.static() && !libDepTag.wholeStatic {
2753 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2754 ctx.ModuleErrorf("module %q not a static library", depName)
2755 return
2756 }
Logan Chien43d34c32017-12-20 01:17:32 +08002757
Colin Cross6e511a92020-07-27 21:26:48 -07002758 // When combining coverage files for shared libraries and executables, coverage files
2759 // in static libraries act as if they were whole static libraries. The same goes for
2760 // source based Abi dump files.
2761 if c, ok := ccDep.(*Module); ok {
2762 staticLib := c.linker.(libraryInterface)
2763 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2764 staticLib.objs().coverageFiles...)
2765 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2766 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002767 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002768 // Handle non-CC modules here
2769 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002770 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002771 }
2772 }
2773
Colin Cross6e511a92020-07-27 21:26:48 -07002774 if ptr != nil {
2775 if !linkFile.Valid() {
2776 if !ctx.Config().AllowMissingDependencies() {
2777 ctx.ModuleErrorf("module %q missing output file", depName)
2778 } else {
2779 ctx.AddMissingDependencies([]string{depName})
2780 }
2781 return
2782 }
2783 *ptr = append(*ptr, linkFile.Path())
2784 }
2785
2786 if depPtr != nil {
2787 dep := depFile
2788 if !dep.Valid() {
2789 dep = linkFile
2790 }
2791 *depPtr = append(*depPtr, dep.Path())
2792 }
2793
Colin Cross0de8a1e2020-09-18 14:15:30 -07002794 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2795 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2796 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2797 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2798
2799 if libDepTag.reexportFlags {
2800 reexportExporter(depExporterInfo)
2801 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2802 // Re-exported shared library headers must be included as well since they can help us with type information
2803 // about template instantiations (instantiated from their headers).
2804 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2805 // scripts.
2806 c.sabi.Properties.ReexportedIncludes = append(
2807 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2808 }
2809
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002810 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002811 switch {
2812 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002813 c.Properties.AndroidMkHeaderLibs = append(
2814 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002815 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002816 if lib := moduleLibraryInterface(dep); lib != nil {
2817 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002818 // Add the dependency to the APEX(es) providing the library so that
2819 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002820 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09002821 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07002822 c.Properties.ApexesProvidingSharedLibs = append(
2823 c.Properties.ApexesProvidingSharedLibs, an)
2824 }
2825 }
2826 }
2827
2828 // Note: the order of libs in this list is not important because
2829 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002830 c.Properties.AndroidMkSharedLibs = append(
2831 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002832 // Record BaseLibName for snapshots.
2833 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002834 case libDepTag.static():
2835 if libDepTag.wholeStatic {
2836 c.Properties.AndroidMkWholeStaticLibs = append(
2837 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2838 } else {
2839 c.Properties.AndroidMkStaticLibs = append(
2840 c.Properties.AndroidMkStaticLibs, makeLibName)
2841 }
Justin Yun5e035862021-06-29 20:50:37 +09002842 // Record BaseLibName for snapshots.
2843 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002844 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002845 } else if !c.IsStubs() {
2846 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2847
Colin Cross6e511a92020-07-27 21:26:48 -07002848 switch depTag {
2849 case runtimeDepTag:
2850 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002851 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002852 // Record BaseLibName for snapshots.
2853 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002854 case objDepTag:
2855 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2856 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002857 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002858 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002859 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002860 case dynamicLinkerDepTag:
2861 depPaths.DynamicLinker = linkFile
2862 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002863 }
Colin Crossca860ac2016-01-04 14:34:37 -08002864 })
2865
Jeff Gaston294356f2017-09-27 17:05:30 -07002866 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002867 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2868 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2869 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002870
Colin Crossdd84e052017-05-17 13:44:16 -07002871 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002872 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002873 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2874 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002875 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002876 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2877 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002878 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002879 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002880 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002881
2882 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002883 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002884 }
Colin Crossdd84e052017-05-17 13:44:16 -07002885
Colin Crossca860ac2016-01-04 14:34:37 -08002886 return depPaths
2887}
2888
Jiyong Park7d55b612021-06-11 17:22:09 +09002889// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
2890// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
2891// dependency. The stub variant is selected when the dependency crosses a boundary where each side
2892// has different level of updatability. For example, if a library foo in an APEX depends on a
2893// library bar which provides stable interface and exists in the platform, foo uses the stub variant
2894// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
2895// same APEX as foo, the non-stub variant of bar is used.
2896func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
2897 depName := ctx.OtherModuleName(dep)
2898 depTag := ctx.OtherModuleDependencyTag(dep)
2899 libDepTag, ok := depTag.(libraryDependencyTag)
2900 if !ok || !libDepTag.shared() {
2901 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2902 }
2903
2904 thisModule, ok := ctx.Module().(android.ApexModule)
2905 if !ok {
2906 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
2907 }
2908
2909 useVndk := false
2910 bootstrap := false
2911 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
2912 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
2913 } else {
2914 useVndk = linkable.UseVndk()
2915 bootstrap = linkable.Bootstrap()
2916 }
2917
2918 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2919 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2920 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
2921 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2922
2923 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
2924 useStubs := false
2925
2926 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
2927 if !apexInfo.IsForPlatform() {
2928 // For platform libraries, use current version of LLNDK
2929 // If this is for use_vendor apex we will apply the same rules
2930 // of apex sdk enforcement below to choose right version.
2931 useStubs = true
2932 }
Jiyong Park9477c262021-06-22 20:23:05 +09002933 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
2934 // If not building for APEX or the containing APEX allows the use of
2935 // platform APIs, use stubs only when it is from an APEX (and not from
2936 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
2937 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09002938 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
2939 if useStubs {
2940 // Another exception: if this module is a test for an APEX, then
2941 // it is linked with the non-stub variant of a module in the APEX
2942 // as if this is part of the APEX.
2943 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2944 for _, apexContents := range testFor.ApexContents {
2945 if apexContents.DirectlyInApex(depName) {
2946 useStubs = false
2947 break
2948 }
2949 }
2950 }
2951 if useStubs {
2952 // Yet another exception: If this module and the dependency are
2953 // available to the same APEXes then skip stubs between their
2954 // platform variants. This complements the test_for case above,
2955 // which avoids the stubs on a direct APEX library dependency, by
2956 // avoiding stubs for indirect test dependencies as well.
2957 //
2958 // TODO(b/183882457): This doesn't work if the two libraries have
2959 // only partially overlapping apex_available. For that test_for
2960 // modules would need to be split into APEX variants and resolved
2961 // separately for each APEX they have access to.
2962 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
2963 useStubs = false
2964 }
2965 }
2966 } else {
2967 // If building for APEX, use stubs when the parent is in any APEX that
2968 // the child is not in.
2969 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2970 }
2971
2972 // when to use (unspecified) stubs, use the latest one.
2973 if useStubs {
2974 stubs := sharedLibraryStubsInfo.SharedStubLibraries
2975 toUse := stubs[len(stubs)-1]
2976 sharedLibraryInfo = toUse.SharedLibraryInfo
2977 depExporterInfo = toUse.FlagExporterInfo
2978 }
2979 }
2980 return sharedLibraryInfo, depExporterInfo
2981}
2982
Colin Cross0de8a1e2020-09-18 14:15:30 -07002983// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2984// to match the topological order of the dependency tree, including any static analogues of
2985// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2986// of the transitive dependencies.
2987func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2988 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2989 var staticPaths android.Paths
2990 for _, staticDep := range staticDeps {
2991 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2992 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2993 }
2994 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04002995 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
2996 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002997 }
2998 }
2999 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3000
3001 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3002
3003 // reorder the dependencies based on transitive dependencies
3004 staticPaths = android.FirstUniquePaths(staticPaths)
3005 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3006
3007 if len(orderedStaticPaths) != len(staticPaths) {
3008 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3009 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3010 }
3011
3012 return orderedStaticPaths, transitiveStaticLibs
3013}
3014
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003015// BaseLibName trims known prefixes and suffixes
3016func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003017 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3018 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003019 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003020 return libName
3021}
3022
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003023func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003024 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003025 ccDepModule, _ := ccDep.(*Module)
3026 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003027 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003028
Justin Yuncbca3732021-02-03 19:24:13 +09003029 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003030 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07003031 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003032 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003033 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003034
Ivan Lozanod1dec542021-05-26 15:33:11 -04003035 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003036 }
3037 }
3038
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003039 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3040 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003041 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3042 // core module instead.
3043 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003044 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003045 // The vendor and product modules in Make will have been renamed to not conflict with the
3046 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003047 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003048 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003049 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003050 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003051 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003052 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003053 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003054 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003055 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003056 } else {
3057 return libName
3058 }
3059}
3060
Colin Crossca860ac2016-01-04 14:34:37 -08003061func (c *Module) InstallInData() bool {
3062 if c.installer == nil {
3063 return false
3064 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003065 return c.installer.inData()
3066}
3067
3068func (c *Module) InstallInSanitizerDir() bool {
3069 if c.installer == nil {
3070 return false
3071 }
3072 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003073 return true
3074 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003075 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003076}
3077
Yifan Hong1b3348d2020-01-21 15:53:22 -08003078func (c *Module) InstallInRamdisk() bool {
3079 return c.InRamdisk()
3080}
3081
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003082func (c *Module) InstallInVendorRamdisk() bool {
3083 return c.InVendorRamdisk()
3084}
3085
Jiyong Parkf9332f12018-02-01 00:54:12 +09003086func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003087 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003088}
3089
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003090func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003091 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003092 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003093 return
3094 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003095 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003096}
3097
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003098func (c *Module) HostToolPath() android.OptionalPath {
3099 if c.installer == nil {
3100 return android.OptionalPath{}
3101 }
3102 return c.installer.hostToolPath()
3103}
3104
Nan Zhangd4e641b2017-07-12 12:55:28 -07003105func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3106 return c.outputFile
3107}
3108
Colin Cross41955e82019-05-29 14:40:35 -07003109func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3110 switch tag {
3111 case "":
3112 if c.outputFile.Valid() {
3113 return android.Paths{c.outputFile.Path()}, nil
3114 }
3115 return android.Paths{}, nil
3116 default:
3117 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003118 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003119}
3120
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003121func (c *Module) static() bool {
3122 if static, ok := c.linker.(interface {
3123 static() bool
3124 }); ok {
3125 return static.static()
3126 }
3127 return false
3128}
3129
Jiyong Park379de2f2018-12-19 02:47:14 +09003130func (c *Module) staticBinary() bool {
3131 if static, ok := c.linker.(interface {
3132 staticBinary() bool
3133 }); ok {
3134 return static.staticBinary()
3135 }
3136 return false
3137}
3138
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003139func (c *Module) testBinary() bool {
3140 if test, ok := c.linker.(interface {
3141 testBinary() bool
3142 }); ok {
3143 return test.testBinary()
3144 }
3145 return false
3146}
3147
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003148// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3149func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003150 if h, ok := c.linker.(interface {
3151 header() bool
3152 }); ok {
3153 return h.header()
3154 }
3155 return false
3156}
3157
Ivan Lozanod7586b62021-04-01 09:49:36 -04003158func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003159 if b, ok := c.linker.(interface {
3160 binary() bool
3161 }); ok {
3162 return b.binary()
3163 }
3164 return false
3165}
3166
Justin Yun5e035862021-06-29 20:50:37 +09003167func (c *Module) StaticExecutable() bool {
3168 if b, ok := c.linker.(*binaryDecorator); ok {
3169 return b.static()
3170 }
3171 return false
3172}
3173
Ivan Lozanod7586b62021-04-01 09:49:36 -04003174func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003175 if o, ok := c.linker.(interface {
3176 object() bool
3177 }); ok {
3178 return o.object()
3179 }
3180 return false
3181}
3182
Ivan Lozanof9e21722020-12-02 09:00:51 -05003183func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003184 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003185 if c.IsLlndk() {
3186 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003187 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003188 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003189 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003190 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003191 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003192 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003193 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003194 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003195 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003196 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003197 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003198 return "native:product"
3199 }
Jooyung Han38002912019-05-16 04:01:54 +09003200 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003201 } else if c.InRamdisk() {
3202 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003203 } else if c.InVendorRamdisk() {
3204 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003205 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003206 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003207 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003208 return "native:ndk:none:none"
3209 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3210 //family, link := getNdkStlFamilyAndLinkType(c)
3211 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003212 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003213 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003214 } else {
3215 return "native:platform"
3216 }
3217}
3218
Jiyong Park9d452992018-10-03 00:38:19 +09003219// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003220// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003221func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003222 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003223 // Stub libs and prebuilt libs in a versioned SDK are not
3224 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07003225 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01003226 } else if _, ok := c.linker.(testPerSrc); ok {
3227 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003228 }
3229 return false
3230}
3231
Jiyong Parka90ca002019-10-07 15:47:24 +09003232func (c *Module) AvailableFor(what string) bool {
3233 if linker, ok := c.linker.(interface {
3234 availableFor(string) bool
3235 }); ok {
3236 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3237 } else {
3238 return c.ApexModuleBase.AvailableFor(what)
3239 }
3240}
3241
Jiyong Park62304bb2020-04-13 16:19:48 +09003242func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003243 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003244}
3245
Colin Crossaede88c2020-08-11 12:17:01 -07003246func (c *Module) UniqueApexVariations() bool {
3247 if u, ok := c.compiler.(interface {
3248 uniqueApexVariations() bool
3249 }); ok {
3250 return u.uniqueApexVariations()
3251 } else {
3252 return false
3253 }
3254}
3255
Paul Duffin0cb37b92020-03-04 14:52:46 +00003256func (c *Module) EverInstallable() bool {
3257 return c.installer != nil &&
3258 // Check to see whether the module is actually ever installable.
3259 c.installer.everInstallable()
3260}
3261
Ivan Lozanod7586b62021-04-01 09:49:36 -04003262func (c *Module) PreventInstall() bool {
3263 return c.Properties.PreventInstall
3264}
3265
3266func (c *Module) Installable() *bool {
3267 return c.Properties.Installable
3268}
3269
3270func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003271 ret := c.EverInstallable() &&
3272 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003273 proptools.BoolDefault(c.Installable(), true) &&
3274 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003275
3276 // The platform variant doesn't need further condition. Apex variants however might not
3277 // be installable because it will likely to be included in the APEX and won't appear
3278 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003279 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003280 return ret
3281 }
3282
3283 // Special case for modules that are configured to be installed to /data, which includes
3284 // test modules. For these modules, both APEX and non-APEX variants are considered as
3285 // installable. This is because even the APEX variants won't be included in the APEX, but
3286 // will anyway be installed to /data/*.
3287 // See b/146995717
3288 if c.InstallInData() {
3289 return ret
3290 }
3291
3292 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003293}
3294
Logan Chien41eabe62019-04-10 13:33:58 +08003295func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3296 if c.linker != nil {
3297 if library, ok := c.linker.(*libraryDecorator); ok {
3298 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3299 }
3300 }
3301}
3302
Jiyong Park45bf82e2020-12-15 22:29:02 +09003303var _ android.ApexModule = (*Module)(nil)
3304
3305// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003306func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003307 depTag := ctx.OtherModuleDependencyTag(dep)
3308 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3309
3310 if cc, ok := dep.(*Module); ok {
3311 if cc.HasStubsVariants() {
3312 if isLibDepTag && libDepTag.shared() {
3313 // dynamic dep to a stubs lib crosses APEX boundary
3314 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003315 }
Colin Cross6e511a92020-07-27 21:26:48 -07003316 if IsRuntimeDepTag(depTag) {
3317 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003318 return false
3319 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003320 }
Zhijun Heec285872021-04-24 10:47:08 -07003321 if cc.IsLlndk() {
3322 return false
3323 }
Colin Crossaac32222020-07-29 12:51:56 -07003324 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003325 // shared_lib dependency from a static lib is considered as crossing
3326 // the APEX boundary because the dependency doesn't actually is
3327 // linked; the dependency is used only during the compilation phase.
3328 return false
3329 }
Jiyong Parke3867542020-12-03 17:28:25 +09003330
3331 if isLibDepTag && libDepTag.excludeInApex {
3332 return false
3333 }
Colin Cross6e511a92020-07-27 21:26:48 -07003334 }
Colin Crossc1b36442021-05-06 13:42:48 -07003335 if depTag == stubImplDepTag {
3336 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003337 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003338 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003339 if depTag == staticVariantTag {
3340 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3341 // actually mean that the static lib (and its dependencies) are copied into the
3342 // APEX.
3343 return false
3344 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003345 return true
3346}
3347
Jiyong Park45bf82e2020-12-15 22:29:02 +09003348// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003349func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3350 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003351 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3352 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3353 return nil
3354 }
3355 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3356 if c.ToolchainLibrary() {
3357 return nil
3358 }
3359 // We don't check for prebuilt modules
3360 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3361 return nil
3362 }
3363 minSdkVersion := c.MinSdkVersion()
3364 if minSdkVersion == "apex_inherit" {
3365 return nil
3366 }
3367 if minSdkVersion == "" {
3368 // JNI libs within APK-in-APEX fall into here
3369 // Those are okay to set sdk_version instead
3370 // We don't have to check if this is a SDK variant because
3371 // non-SDK variant resets sdk_version, which works too.
3372 minSdkVersion = c.SdkVersion()
3373 }
Dan Albertc8060532020-07-22 22:32:17 -07003374 if minSdkVersion == "" {
3375 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3376 }
3377 // Not using nativeApiLevelFromUser because the context here is not
3378 // necessarily a native context.
3379 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003380 if err != nil {
3381 return err
3382 }
Dan Albertc8060532020-07-22 22:32:17 -07003383
3384 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003385 return fmt.Errorf("newer SDK(%v)", ver)
3386 }
3387 return nil
3388}
3389
Paul Duffinb5769c12021-05-12 16:16:51 +01003390// Implements android.ApexModule
3391func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3392 // stub libraries and native bridge libraries are always available to platform
3393 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3394}
3395
Rob Seymour925aa092021-08-10 20:42:03 +00003396var _ snapshot.RelativeInstallPath = (*Module)(nil)
3397
Colin Cross2ba19d92015-05-07 15:44:20 -07003398//
Colin Crosscfad1192015-11-02 16:43:11 -08003399// Defaults
3400//
Colin Crossca860ac2016-01-04 14:34:37 -08003401type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003402 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003403 android.DefaultsModuleBase
Liz Kammer3cf52112021-03-31 15:42:03 -04003404 // Included to support setting bazel_module.label for multiple Soong modules to the same Bazel
3405 // target. This is primarily useful for modules that were architecture specific and instead are
3406 // handled in Bazel as a select().
3407 android.BazelModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003408 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003409}
3410
Patrice Arrudac249c712019-03-19 17:00:29 -07003411// cc_defaults provides a set of properties that can be inherited by other cc
3412// modules. A module can use the properties from a cc_defaults using
3413// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3414// merged (when possible) by prepending the default module's values to the
3415// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003416func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003417 return DefaultsFactory()
3418}
3419
Colin Cross36242852017-06-23 15:06:31 -07003420func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003421 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003422
Colin Cross36242852017-06-23 15:06:31 -07003423 module.AddProperties(props...)
3424 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003425 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003426 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003427 &BaseCompilerProperties{},
3428 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003429 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003430 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003431 &StaticProperties{},
3432 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003433 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003434 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003435 &TestProperties{},
3436 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003437 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07003438 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003439 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003440 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003441 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003442 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003443 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003444 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003445 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003446 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003447 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003448 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003449 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003450 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3451 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003452 )
Colin Crosscfad1192015-11-02 16:43:11 -08003453
Liz Kammer3cf52112021-03-31 15:42:03 -04003454 // Bazel module must be initialized _before_ Defaults to be included in cc_defaults module.
3455 android.InitBazelModule(module)
Jooyung Hancc372c52019-09-25 15:18:44 +09003456 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003457
3458 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003459}
3460
Jiyong Park2286afd2020-06-16 21:58:53 +09003461func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003462 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003463}
3464
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003465func kytheExtractAllFactory() android.Singleton {
3466 return &kytheExtractAllSingleton{}
3467}
3468
3469type kytheExtractAllSingleton struct {
3470}
3471
3472func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3473 var xrefTargets android.Paths
3474 ctx.VisitAllModules(func(module android.Module) {
3475 if ccModule, ok := module.(xref); ok {
3476 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3477 }
3478 })
3479 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3480 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003481 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003482 }
3483}
3484
Colin Cross06a931b2015-10-28 17:23:31 -07003485var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003486var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003487var BoolPtr = proptools.BoolPtr
3488var String = proptools.String
3489var StringPtr = proptools.StringPtr