blob: 82b7c8795f0b3b64a0be5eb97078963691a03185 [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
Colin Crossc8caa062021-09-24 16:50:14 -070098 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -040099
Yo Chiang219968c2020-09-22 18:45:04 +0800100 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
101 SystemSharedLibs []string
102
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500103 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800104 StaticUnwinderIfLegacy bool
105
Colin Cross5950f382016-12-13 12:50:57 -0800106 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700107
Colin Cross81413472016-04-11 14:37:39 -0700108 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700109
Dan Willemsenb40aab62016-04-20 14:21:14 -0700110 GeneratedSources []string
111 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900112 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700113
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700114 ReexportGeneratedHeaders []string
115
Colin Crossc465efd2021-06-11 18:00:04 -0700116 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700117
118 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700119 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900120
121 // List of libs that need to be excluded for APEX variant
122 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700123}
124
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500125// PathDeps is a struct containing file paths to dependencies of a module.
126// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
127// It's used to construct flags for various build statements (such as for compiling and linking).
128// It is then passed to module decorator functions responsible for registering build statements
129// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800130type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700131 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900132 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700133 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900134 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700135 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700136 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700137
Colin Cross0de8a1e2020-09-18 14:15:30 -0700138 // Transitive static library dependencies of static libraries for use in ordering.
139 TranstiveStaticLibrariesForOrdering *android.DepSet
140
Colin Cross26c34ed2016-09-30 17:10:16 -0700141 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100142 Objs Objects
143 // Paths to .o files in dependencies that provide them. Note that these lists
144 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800145 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700146 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700147
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100148 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
149 // the libs from all whole_static_lib dependencies.
150 WholeStaticLibsFromPrebuilts android.Paths
151
Colin Cross26c34ed2016-09-30 17:10:16 -0700152 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700153 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900154 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700155
Inseob Kimd110f872019-12-06 13:15:38 +0900156 Flags []string
157 IncludeDirs android.Paths
158 SystemIncludeDirs android.Paths
159 ReexportedDirs android.Paths
160 ReexportedSystemDirs android.Paths
161 ReexportedFlags []string
162 ReexportedGeneratedHeaders android.Paths
163 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700164
Colin Cross26c34ed2016-09-30 17:10:16 -0700165 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700166 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700167
Dan Willemsena0790e32018-10-12 00:24:23 -0700168 // Path to the dynamic linker binary
169 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700170
171 // For Darwin builds, the path to the second architecture's output that should
172 // be combined with this architectures's output into a FAT MachO file.
173 DarwinSecondArchOutput android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700174}
175
Colin Cross4af21ed2019-11-04 09:37:55 -0800176// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
177// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
178// command line so they can be overridden by the local module flags).
179type LocalOrGlobalFlags struct {
180 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700181 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800182 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700183 CFlags []string // Flags that apply to C and C++ source files
184 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
185 ConlyFlags []string // Flags that apply to C source files
186 CppFlags []string // Flags that apply to C++ source files
187 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700188 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800189}
190
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500191// Flags contains various types of command line flags (and settings) for use in building build
192// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800193type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500194 // Local flags (which individual modules are responsible for). These may override global flags.
195 Local LocalOrGlobalFlags
196 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800197 Global LocalOrGlobalFlags
198
199 aidlFlags []string // Flags that apply to aidl source files
200 rsFlags []string // Flags that apply to renderscript source files
201 libFlags []string // Flags to add libraries early to the link order
202 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
203 TidyFlags []string // Flags that apply to clang-tidy
204 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700205
Colin Crossc3199482017-03-30 15:03:04 -0700206 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800207 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700208 SystemIncludeFlags []string
209
Oliver Nguyen04526782020-04-21 12:40:27 -0700210 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500211 Tidy bool // True if clang-tidy is enabled.
212 GcovCoverage bool // True if coverage files should be generated.
213 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700214 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800215
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500216 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800217 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500218 // The target-device system path to the dynamic linker.
219 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800220
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700221 CFlagsDeps android.Paths // Files depended on by compiler flags
222 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800223
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500224 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700225 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800226
Colin Cross19878da2019-03-28 14:45:07 -0700227 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700228 protoC bool // Whether to use C instead of C++
229 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700230
231 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200232 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700233}
234
Colin Crossca860ac2016-01-04 14:34:37 -0800235// Properties used to compile all C or C++ modules
236type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700237 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800238 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700239
Jiyong Parkb35a8192020-08-10 15:59:36 +0900240 // The API level that this module is built against. The APIs of this API level will be
241 // visible at build time, but use of any APIs newer than min_sdk_version will render the
242 // module unloadable on older devices. In the future it will be possible to weakly-link new
243 // APIs, making the behavior match Java: such modules will load on older devices, but
244 // calling new APIs on devices that do not support them will result in a crash.
245 //
246 // This property has the same behavior as sdk_version does for Java modules. For those
247 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
248 // does for Java code.
249 //
250 // In addition, setting this property causes two variants to be built, one for the platform
251 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800252 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700253
Jiyong Parkb35a8192020-08-10 15:59:36 +0900254 // Minimum OS API level supported by this C or C++ module. This property becomes the value
255 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
256 // this property is also used to ensure that the min_sdk_version of the containing module is
257 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
258 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
259 // min_sdk_version of the containing APEX. When the module
260 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900261 Min_sdk_version *string
262
Colin Crossc511bc52020-04-07 16:50:32 +0000263 // If true, always create an sdk variant and don't create a platform variant.
264 Sdk_variant_only *bool
265
Jiyong Parkde866cb2018-12-07 23:08:36 +0900266 AndroidMkSharedLibs []string `blueprint:"mutated"`
267 AndroidMkStaticLibs []string `blueprint:"mutated"`
268 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
269 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700270 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900271 HideFromMake bool `blueprint:"mutated"`
272 PreventInstall bool `blueprint:"mutated"`
273 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700274
Yo Chiang219968c2020-09-22 18:45:04 +0800275 // Set by DepsMutator.
276 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
277
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200278 // The name of the image this module is built for, suffixed with a '.'
Justin Yun5f7f7e82019-11-18 19:52:14 +0900279 ImageVariationPrefix string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200280
281 // The VNDK version this module is built against. If empty, the module is not
282 // build against the VNDK.
283 VndkVersion string `blueprint:"mutated"`
284
285 // Suffix for the name of Android.mk entries generated by this module
286 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800287
288 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
289 // file
290 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900291
Yifan Hong39143a92020-10-26 12:43:12 -0700292 // Make this module available when building for ramdisk.
293 // On device without a dedicated recovery partition, the module is only
294 // available after switching root into
295 // /first_stage_ramdisk. To expose the module before switching root, install
296 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800297 Ramdisk_available *bool
298
Yifan Hong39143a92020-10-26 12:43:12 -0700299 // Make this module available when building for vendor ramdisk.
300 // On device without a dedicated recovery partition, the module is only
301 // available after switching root into
302 // /first_stage_ramdisk. To expose the module before switching root, install
303 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700304 Vendor_ramdisk_available *bool
305
Jiyong Parkf9332f12018-02-01 00:54:12 +0900306 // Make this module available when building for recovery
307 Recovery_available *bool
308
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200309 // Used by imageMutator, set by ImageMutatorBegin()
310 CoreVariantNeeded bool `blueprint:"mutated"`
311 RamdiskVariantNeeded bool `blueprint:"mutated"`
312 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
313 RecoveryVariantNeeded bool `blueprint:"mutated"`
314
315 // A list of variations for the "image" mutator of the form
316 //<image name> '.' <version char>, for example, 'vendor.S'
317 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900318
319 // Allows this module to use non-APEX version of libraries. Useful
320 // for building binaries that are started before APEXes are activated.
321 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900322
323 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
324 // see soong/cc/config/vndk.go
325 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900326
327 // Used by vendor snapshot to record dependencies from snapshot modules.
328 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900329 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900330 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000331
Colin Cross1bc94122021-10-28 13:25:54 -0700332 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000333
334 // Set by factories of module types that can only be referenced from variants compiled against
335 // the SDK.
336 AlwaysSdk bool `blueprint:"mutated"`
337
338 // Variant is an SDK variant created by sdkMutator
339 IsSdkVariant bool `blueprint:"mutated"`
340 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
341 // variant to have a ".sdk" suffix.
342 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700343
344 // Normally Soong uses the directory structure to decide which modules
345 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800346 // different snapshots (vendor, recovery, etc.), but this property
347 // allows a partner to exclude a module normally thought of as a
348 // framework module from the vendor snapshot.
349 Exclude_from_vendor_snapshot *bool
350
351 // Normally Soong uses the directory structure to decide which modules
352 // should be included (framework) or excluded (non-framework) from the
353 // different snapshots (vendor, recovery, etc.), but this property
354 // allows a partner to exclude a module normally thought of as a
355 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800356 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900357
358 // List of APEXes that this module has private access to for testing purpose. The module
359 // can depend on libraries that are not exported by the APEXes and use private symbols
360 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000361 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800362
363 Target struct {
364 Platform struct {
365 // List of modules required by the core variant.
366 Required []string `android:"arch_variant"`
367
368 // List of modules not required by the core variant.
369 Exclude_required []string `android:"arch_variant"`
370 } `android:"arch_variant"`
371
372 Recovery struct {
373 // List of modules required by the recovery variant.
374 Required []string `android:"arch_variant"`
375
376 // List of modules not required by the recovery variant.
377 Exclude_required []string `android:"arch_variant"`
378 } `android:"arch_variant"`
379 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700380}
381
382type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900383 // whether this module should be allowed to be directly depended by other
384 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900385 // If set to true, two variants will be built separately, one like
386 // normal, and the other limited to the set of libraries and headers
387 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700388 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900389 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700390 // so it shouldn't have any unversioned runtime dependencies, or
391 // make assumptions about the system that may not be true in the
392 // future.
393 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900394 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900395 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900396 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900397 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900398 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700399 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
400 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900401
Justin Yunebcf0c52021-01-08 18:00:19 +0900402 // This is the same as the "vendor_available" except that the install path
403 // of the vendor variant is /odm or /vendor/odm.
404 // By replacing "vendor_available: true" with "odm_available: true", the
405 // module will install its vendor variant to the /odm partition or /vendor/odm.
406 // As the modules with "odm_available: true" still create the vendor variants,
407 // they can link to the other vendor modules as the vendor_available modules do.
408 // Also, the vendor modules can link to odm_available modules.
409 //
410 // It may not be used for VNDK modules.
411 Odm_available *bool
412
Justin Yun63e9ec72020-10-29 16:49:43 +0900413 // whether this module should be allowed to be directly depended by other
414 // modules with `product_specific: true` or `product_available: true`.
415 // If set to true, an additional product variant will be built separately
416 // that is limited to the set of libraries and headers that are exposed to
417 // /product modules.
418 //
419 // The product variant may be used with a different (newer) /system,
420 // so it shouldn't have any unversioned runtime dependencies, or
421 // make assumptions about the system that may not be true in the
422 // future.
423 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900424 // If set to false, this module becomes inaccessible from /product modules.
425 //
426 // Different from the 'vendor_available' property, the modules with
427 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
428 // library without 'product_available' may not be depended on by any other
429 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900430 //
431 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
432 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
433 Product_available *bool
434
Jiyong Park5fb8c102018-04-09 12:03:06 +0900435 // whether this module is capable of being loaded with other instance
436 // (possibly an older version) of the same module in the same process.
437 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
438 // can be double loaded in a vendor process if the library is also a
439 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
440 // explicitly marked as `double_loadable: true` by the owner, or the dependency
441 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
442 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800443
444 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
445 IsLLNDK bool `blueprint:"mutated"`
446
Colin Cross78212242021-01-06 14:51:30 -0800447 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
448 // set and the module is not listed in VndkMustUseVendorVariantList.
449 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
450
451 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
452 IsVNDKCore bool `blueprint:"mutated"`
453
454 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
455 IsVNDKSP bool `blueprint:"mutated"`
456
457 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
458 // module sets the llndk.private property.
459 IsVNDKPrivate bool `blueprint:"mutated"`
460
461 // IsVNDKProduct is set if a VNDK module sets the product_available property.
462 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700463
464 // IsVendorPublicLibrary is set for the core and product variants of a library that has
465 // vendor_public_library stubs.
466 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800467}
468
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500469// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
470// to understanding details about the type of the current module.
471// For example, one might call these functions to determine whether the current module is a static
472// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800473type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800474 static() bool
475 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700476 testBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900477 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900478 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900479 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700480 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900481 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700482 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800483 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900484 minSdkVersion() string
485 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700486 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700487 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800488 IsLlndk() bool
489 IsLlndkPublic() bool
490 isImplementationForLLNDKPublic() bool
491 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900492 isVndk() bool
493 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500494 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700495 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900496 inProduct() bool
497 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800498 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700499 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900500 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700501 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700502 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800503 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800504 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800505 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800506 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800507 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700508 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700509 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900510 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800511 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700512 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700513 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800514 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800515 isCfiAssemblySupportEnabled() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800516}
517
518type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700519 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800520 ModuleContextIntf
521}
522
523type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700524 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800525 ModuleContextIntf
526}
527
Colin Cross37047f12016-12-13 17:06:13 -0800528type DepsContext interface {
529 android.BottomUpMutatorContext
530 ModuleContextIntf
531}
532
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500533// feature represents additional (optional) steps to building cc-related modules, such as invocation
534// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800535type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800536 flags(ctx ModuleContext, flags Flags) Flags
537 props() []interface{}
538}
539
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500540// compiler is the interface for a compiler helper object. Different module decorators may implement
541// this helper differently. For example, compiling a `cc_library` may use a different build
542// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800543type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700544 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800545 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800546 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700547 compilerProps() []interface{}
548
Colin Cross76fada02016-07-27 10:31:13 -0700549 appendCflags([]string)
550 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700551 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800552}
553
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500554// linker is the interface for a linker decorator object. Individual module types can provide
555// their own implementation for this decorator, and thus specify custom logic regarding build
556// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800557type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700558 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800559 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700560 linkerFlags(ctx ModuleContext, flags Flags) Flags
561 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800562 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700563
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700564 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700565 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900566 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700567
568 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900569 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000570
571 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000572 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
573}
574
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500575// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000576type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500577 sharedLibs []string
578 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
579 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700580 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800581}
582
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500583// installer is the interface for an installer helper object. This helper is responsible for
584// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800585type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700586 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700587 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000588 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800589 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700590 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700591 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900592 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100593 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900594 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800595}
596
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800597type xref interface {
598 XrefCcFiles() android.Paths
599}
600
Colin Cross6e511a92020-07-27 21:26:48 -0700601type libraryDependencyKind int
602
603const (
604 headerLibraryDependency = iota
605 sharedLibraryDependency
606 staticLibraryDependency
607)
608
609func (k libraryDependencyKind) String() string {
610 switch k {
611 case headerLibraryDependency:
612 return "headerLibraryDependency"
613 case sharedLibraryDependency:
614 return "sharedLibraryDependency"
615 case staticLibraryDependency:
616 return "staticLibraryDependency"
617 default:
618 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
619 }
620}
621
622type libraryDependencyOrder int
623
624const (
625 earlyLibraryDependency = -1
626 normalLibraryDependency = 0
627 lateLibraryDependency = 1
628)
629
630func (o libraryDependencyOrder) String() string {
631 switch o {
632 case earlyLibraryDependency:
633 return "earlyLibraryDependency"
634 case normalLibraryDependency:
635 return "normalLibraryDependency"
636 case lateLibraryDependency:
637 return "lateLibraryDependency"
638 default:
639 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
640 }
641}
642
643// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
644// tags that have a set of predefined tag objects that are reused for each dependency, a
645// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
646// That means that comparing a libraryDependencyTag for equality will only be equal if all
647// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
648// then check individual metadata fields instead.
649type libraryDependencyTag struct {
650 blueprint.BaseDependencyTag
651
652 // These are exported so that fmt.Printf("%#v") can call their String methods.
653 Kind libraryDependencyKind
654 Order libraryDependencyOrder
655
656 wholeStatic bool
657
658 reexportFlags bool
659 explicitlyVersioned bool
660 dataLib bool
661 ndk bool
662
663 staticUnwinder bool
664
665 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900666
Cindy Zhou18417cb2020-12-10 07:12:38 -0800667 // Whether or not this dependency should skip the apex dependency check
668 skipApexAllowedDependenciesCheck bool
669
Jiyong Parke3867542020-12-03 17:28:25 +0900670 // Whether or not this dependency has to be followed for the apex variants
671 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700672}
673
674// header returns true if the libraryDependencyTag is tagging a header lib dependency.
675func (d libraryDependencyTag) header() bool {
676 return d.Kind == headerLibraryDependency
677}
678
679// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
680func (d libraryDependencyTag) shared() bool {
681 return d.Kind == sharedLibraryDependency
682}
683
684// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
685func (d libraryDependencyTag) static() bool {
686 return d.Kind == staticLibraryDependency
687}
688
Colin Cross65cb3142021-12-10 23:05:02 +0000689func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
690 if d.shared() {
691 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
692 }
693 return nil
694}
695
696var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
697
Colin Crosse9fe2942020-11-10 18:12:15 -0800698// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
699// binaries or other shared libraries are installed as dependencies.
700func (d libraryDependencyTag) InstallDepNeeded() bool {
701 return d.shared()
702}
703
704var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
705
706// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700707// libraryDependencyTag. Each tag object is created globally and reused for multiple
708// dependencies (although since the object contains no references, assigning a tag to a
709// variable and modifying it will not modify the original). Users can compare the tag
710// returned by ctx.OtherModuleDependencyTag against the global original
711type dependencyTag struct {
712 blueprint.BaseDependencyTag
713 name string
714}
715
Colin Crosse9fe2942020-11-10 18:12:15 -0800716// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
717// libraryDependencyTag, but where the dependency needs to be installed when the parent is
718// installed.
719type installDependencyTag struct {
720 blueprint.BaseDependencyTag
721 android.InstallAlwaysNeededDependencyTag
722 name string
723}
724
Colin Crossc99deeb2016-04-11 15:06:20 -0700725var (
Colin Cross6e511a92020-07-27 21:26:48 -0700726 genSourceDepTag = dependencyTag{name: "gen source"}
727 genHeaderDepTag = dependencyTag{name: "gen header"}
728 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
729 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900730 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700731 reuseObjTag = dependencyTag{name: "reuse objects"}
732 staticVariantTag = dependencyTag{name: "static variant"}
733 vndkExtDepTag = dependencyTag{name: "vndk extends"}
734 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700735 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800736 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700737 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700738 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700739)
740
Roland Levillainf89cd092019-07-29 16:22:59 +0100741func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700742 ccLibDepTag, ok := depTag.(libraryDependencyTag)
743 return ok && ccLibDepTag.shared()
744}
745
746func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
747 ccLibDepTag, ok := depTag.(libraryDependencyTag)
748 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100749}
750
Zach Johnson3df4e632020-11-06 11:56:27 -0800751func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
752 ccLibDepTag, ok := depTag.(libraryDependencyTag)
753 return ok && ccLibDepTag.header()
754}
755
Roland Levillainf89cd092019-07-29 16:22:59 +0100756func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800757 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100758}
759
760func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700761 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100762 return ok && ccDepTag == testPerSrcDepTag
763}
764
Colin Crossca860ac2016-01-04 14:34:37 -0800765// Module contains the properties and members used by all C/C++ module types, and implements
766// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500767// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
768// interface.
769//
770// To define a C/C++ related module, construct a new Module object and point its delegates to
771// type-specific structs. These delegates will be invoked to register module-specific build
772// statements which may be unique to the module type. For example, module.compiler.compile() should
773// be defined so as to register build statements which are responsible for compiling the module.
774//
775// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
776// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
777// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
778// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800779type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700780 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700781
Jiyong Parkd1063c12019-07-17 20:08:41 +0900782 android.SdkBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500783 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700784
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700785 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700786 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700787
Colin Crossca860ac2016-01-04 14:34:37 -0800788 // initialize before calling Init
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400789 hod android.HostOrDeviceSupported
790 multilib android.Multilib
791 bazelable bool
Colin Crossc472d572015-03-17 15:06:21 -0700792
Paul Duffina0843f62019-12-13 19:50:38 +0000793 // Allowable SdkMemberTypes of this module type.
794 sdkMemberTypes []android.SdkMemberType
795
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500796 // decorator delegates, initialize before calling Init
797 // these may contain module-specific implementations, and effectively allow for custom
798 // type-specific logic. These members may reference different objects or the same object.
799 // Functions of these decorators will be invoked to initialize and register type-specific
800 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500801 compiler compiler
802 linker linker
803 installer installer
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000804 bazelHandler android.BazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500805
806 features []feature
807 stl *stl
808 sanitize *sanitize
809 coverage *coverage
810 sabi *sabi
811 vndkdep *vndkdep
812 lto *lto
813 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800814
Colin Cross31076b32020-10-23 17:22:06 -0700815 library libraryInterface
816
Colin Cross635c3b02016-05-18 15:37:25 -0700817 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800818
Colin Crossb98c8b02016-07-29 13:44:28 -0700819 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700820
821 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800822
823 // Flags used to compile this module
824 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700825
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800826 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700827 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900828
829 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800830 // Kythe (source file indexer) paths for this compilation module
831 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700832 // Object .o file output paths for this compilation module
833 objFiles android.Paths
834 // Tidy .tidy file output paths for this compilation module
835 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900836
837 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700838 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700839
840 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700841}
842
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200843func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400844 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
845 if b, ok := c.compiler.(*baseCompiler); ok {
846 hasAidl = b.hasSrcExt(".aidl")
847 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
848 hasProto = b.hasSrcExt(".proto")
849 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
850 hasSysprop = b.hasSrcExt(".sysprop")
851 hasWinMsg = b.hasSrcExt(".mc")
852 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
853 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200854 c.AndroidModuleBase().AddJSONData(d)
855 (*d)["Cc"] = map[string]interface{}{
856 "SdkVersion": c.SdkVersion(),
857 "MinSdkVersion": c.MinSdkVersion(),
858 "VndkVersion": c.VndkVersion(),
859 "ProductSpecific": c.ProductSpecific(),
860 "SocSpecific": c.SocSpecific(),
861 "DeviceSpecific": c.DeviceSpecific(),
862 "InProduct": c.InProduct(),
863 "InVendor": c.InVendor(),
864 "InRamdisk": c.InRamdisk(),
865 "InVendorRamdisk": c.InVendorRamdisk(),
866 "InRecovery": c.InRecovery(),
867 "VendorAvailable": c.VendorAvailable(),
868 "ProductAvailable": c.ProductAvailable(),
869 "RamdiskAvailable": c.RamdiskAvailable(),
870 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
871 "RecoveryAvailable": c.RecoveryAvailable(),
872 "OdmAvailable": c.OdmAvailable(),
873 "InstallInData": c.InstallInData(),
874 "InstallInRamdisk": c.InstallInRamdisk(),
875 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
876 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
877 "InstallInRecovery": c.InstallInRecovery(),
878 "InstallInRoot": c.InstallInRoot(),
879 "IsVndk": c.IsVndk(),
880 "IsVndkExt": c.IsVndkExt(),
881 "IsVndkPrivate": c.IsVndkPrivate(),
882 "IsVndkSp": c.IsVndkSp(),
883 "IsLlndk": c.IsLlndk(),
884 "IsLlndkPublic": c.IsLlndkPublic(),
885 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
886 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
887 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
888 "ApexSdkVersion": c.apexSdkVersion,
889 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400890 "AidlSrcs": hasAidl,
891 "LexSrcs": hasLex,
892 "ProtoSrcs": hasProto,
893 "RenderscriptSrcs": hasRenderscript,
894 "SyspropSrcs": hasSysprop,
895 "WinMsgSrcs": hasWinMsg,
896 "YaccSrsc": hasYacc,
897 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200898 }
899}
900
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500901func (c *Module) SetPreventInstall() {
902 c.Properties.PreventInstall = true
903}
904
905func (c *Module) SetHideFromMake() {
906 c.Properties.HideFromMake = true
907}
908
Ivan Lozanod7586b62021-04-01 09:49:36 -0400909func (c *Module) HiddenFromMake() bool {
910 return c.Properties.HideFromMake
911}
912
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800913func (c *Module) RequiredModuleNames() []string {
914 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
915 if c.ImageVariation().Variation == android.CoreVariation {
916 required = append(required, c.Properties.Target.Platform.Required...)
917 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
918 } else if c.InRecovery() {
919 required = append(required, c.Properties.Target.Recovery.Required...)
920 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
921 }
922 return android.FirstUniqueStrings(required)
923}
924
Ivan Lozano52767be2019-10-18 14:49:46 -0700925func (c *Module) Toc() android.OptionalPath {
926 if c.linker != nil {
927 if library, ok := c.linker.(libraryInterface); ok {
928 return library.toc()
929 }
930 }
931 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
932}
933
934func (c *Module) ApiLevel() string {
935 if c.linker != nil {
936 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700937 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700938 }
939 }
940 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
941}
942
943func (c *Module) Static() bool {
944 if c.linker != nil {
945 if library, ok := c.linker.(libraryInterface); ok {
946 return library.static()
947 }
948 }
949 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
950}
951
952func (c *Module) Shared() bool {
953 if c.linker != nil {
954 if library, ok := c.linker.(libraryInterface); ok {
955 return library.shared()
956 }
957 }
958 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
959}
960
961func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000962 if c.stl != nil {
963 return c.stl.Properties.SelectedStl
964 }
965 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700966}
967
968func (c *Module) ToolchainLibrary() bool {
969 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
970 return true
971 }
972 return false
973}
974
975func (c *Module) NdkPrebuiltStl() bool {
976 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
977 return true
978 }
979 return false
980}
981
982func (c *Module) StubDecorator() bool {
983 if _, ok := c.linker.(*stubDecorator); ok {
984 return true
985 }
986 return false
987}
988
989func (c *Module) SdkVersion() string {
990 return String(c.Properties.Sdk_version)
991}
992
Artur Satayev480e25b2020-04-27 18:53:18 +0100993func (c *Module) MinSdkVersion() string {
994 return String(c.Properties.Min_sdk_version)
995}
996
Jiyong Park5df7bd32021-08-25 16:18:46 +0900997func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -0700998 if linker, ok := c.linker.(*objectLinker); ok {
999 return linker.isCrt()
1000 }
1001 return false
1002}
1003
Jiyong Park5df7bd32021-08-25 16:18:46 +09001004func (c *Module) SplitPerApiLevel() bool {
1005 return c.canUseSdk() && c.isCrt()
1006}
1007
Colin Crossc511bc52020-04-07 16:50:32 +00001008func (c *Module) AlwaysSdk() bool {
1009 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1010}
1011
Ivan Lozano183a3212019-10-18 14:18:45 -07001012func (c *Module) CcLibrary() bool {
1013 if c.linker != nil {
1014 if _, ok := c.linker.(*libraryDecorator); ok {
1015 return true
1016 }
Colin Crossd48fe732020-09-23 20:37:24 -07001017 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1018 return true
1019 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001020 }
1021 return false
1022}
1023
1024func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001025 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001026 return true
1027 }
1028 return false
1029}
1030
Ivan Lozano2b262972019-11-21 12:30:50 -08001031func (c *Module) NonCcVariants() bool {
1032 return false
1033}
1034
Ivan Lozano183a3212019-10-18 14:18:45 -07001035func (c *Module) SetStatic() {
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 library.setStatic()
1039 return
1040 }
1041 }
1042 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1043}
1044
1045func (c *Module) SetShared() {
1046 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001047 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001048 library.setShared()
1049 return
1050 }
1051 }
1052 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1053}
1054
1055func (c *Module) BuildStaticVariant() bool {
1056 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001057 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001058 return library.buildStatic()
1059 }
1060 }
1061 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1062}
1063
1064func (c *Module) BuildSharedVariant() bool {
1065 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001066 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001067 return library.buildShared()
1068 }
1069 }
1070 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1071}
1072
1073func (c *Module) Module() android.Module {
1074 return c
1075}
1076
Jiyong Parkc20eee32018-09-05 22:36:17 +09001077func (c *Module) OutputFile() android.OptionalPath {
1078 return c.outputFile
1079}
1080
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001081func (c *Module) CoverageFiles() android.Paths {
1082 if c.linker != nil {
1083 if library, ok := c.linker.(libraryInterface); ok {
1084 return library.objs().coverageFiles
1085 }
1086 }
1087 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1088}
1089
Ivan Lozano183a3212019-10-18 14:18:45 -07001090var _ LinkableInterface = (*Module)(nil)
1091
Jiyong Park719b4462019-01-13 00:39:51 +09001092func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001093 if c.linker != nil {
1094 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001095 }
1096 return nil
1097}
1098
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001099func (c *Module) CoverageOutputFile() android.OptionalPath {
1100 if c.linker != nil {
1101 return c.linker.coverageOutputFilePath()
1102 }
1103 return android.OptionalPath{}
1104}
1105
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001106func (c *Module) RelativeInstallPath() string {
1107 if c.installer != nil {
1108 return c.installer.relativeInstallPath()
1109 }
1110 return ""
1111}
1112
Jooyung Han344d5432019-08-23 11:17:39 +09001113func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001114 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001115}
1116
Colin Cross36242852017-06-23 15:06:31 -07001117func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001118 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001119 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001120 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001121 }
1122 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001123 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001124 }
1125 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001126 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001127 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001128 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001129 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001130 }
Colin Cross16b23492016-01-06 14:41:07 -08001131 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001132 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001133 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001134 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001135 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001136 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001137 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001138 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001139 }
Justin Yun8effde42017-06-23 19:24:43 +09001140 if c.vndkdep != nil {
1141 c.AddProperties(c.vndkdep.props()...)
1142 }
Stephen Craneba090d12017-05-09 15:44:35 -07001143 if c.lto != nil {
1144 c.AddProperties(c.lto.props()...)
1145 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001146 if c.pgo != nil {
1147 c.AddProperties(c.pgo.props()...)
1148 }
Colin Crossca860ac2016-01-04 14:34:37 -08001149 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001150 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001151 }
Colin Crossc472d572015-03-17 15:06:21 -07001152
Colin Cross36242852017-06-23 15:06:31 -07001153 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001154 if c.bazelable {
1155 android.InitBazelModule(c)
1156 }
Jiyong Park7916bfc2019-09-30 19:13:12 +09001157 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001158 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001159 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001160
Colin Cross36242852017-06-23 15:06:31 -07001161 return c
Colin Crossc472d572015-03-17 15:06:21 -07001162}
1163
Ivan Lozano52767be2019-10-18 14:49:46 -07001164func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001165 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001166}
1167
Colin Crossc511bc52020-04-07 16:50:32 +00001168func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001169 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1170 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001171}
1172
1173func (c *Module) UseSdk() bool {
1174 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001175 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001176 }
1177 return false
1178}
1179
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001180func (c *Module) isCoverageVariant() bool {
1181 return c.coverage.Properties.IsCoverageVariant
1182}
1183
Colin Cross95f1ca02020-10-29 20:47:22 -07001184func (c *Module) IsNdk(config android.Config) bool {
1185 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001186}
1187
Colin Cross127bb8b2020-12-16 16:46:01 -08001188func (c *Module) IsLlndk() bool {
1189 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001190}
1191
Colin Cross127bb8b2020-12-16 16:46:01 -08001192func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001193 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001194}
1195
Colin Cross1f3f1302021-04-26 18:37:44 -07001196func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001197 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001198 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001199}
1200
Colin Cross5271fea2021-04-27 13:06:04 -07001201func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1202 lib := moduleLibraryInterface(m)
1203 return lib != nil && (lib.hasVendorPublicLibrary())
1204}
1205
1206// IsVendorPublicLibrary returns true for vendor public libraries.
1207func (c *Module) IsVendorPublicLibrary() bool {
1208 return c.VendorProperties.IsVendorPublicLibrary
1209}
1210
Ivan Lozanod7586b62021-04-01 09:49:36 -04001211func (c *Module) HasLlndkStubs() bool {
1212 lib := moduleLibraryInterface(c)
1213 return lib != nil && lib.hasLLNDKStubs()
1214}
1215
1216func (c *Module) StubsVersion() string {
1217 if lib, ok := c.linker.(versionedInterface); ok {
1218 return lib.stubsVersion()
1219 }
1220 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1221}
1222
Colin Cross127bb8b2020-12-16 16:46:01 -08001223// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1224// and does not set llndk.vendor_available: false.
1225func (c *Module) isImplementationForLLNDKPublic() bool {
1226 library, _ := c.library.(*libraryDecorator)
1227 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001228 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001229}
1230
Justin Yunfd9e8042020-12-23 18:23:14 +09001231// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001232func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001233 // Check if VNDK-core-private or VNDK-SP-private
1234 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001235 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001236 }
1237
1238 // Check if LLNDK-private
1239 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001240 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001241 }
1242
1243 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001244}
1245
Ivan Lozano52767be2019-10-18 14:49:46 -07001246func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001247 if vndkdep := c.vndkdep; vndkdep != nil {
1248 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001249 }
1250 return false
1251}
1252
Yi Kong7e53c572018-02-14 18:16:12 +08001253func (c *Module) isPgoCompile() bool {
1254 if pgo := c.pgo; pgo != nil {
1255 return pgo.Properties.PgoCompile
1256 }
1257 return false
1258}
1259
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001260func (c *Module) isNDKStubLibrary() bool {
1261 if _, ok := c.compiler.(*stubDecorator); ok {
1262 return true
1263 }
1264 return false
1265}
1266
Ivan Lozanod7586b62021-04-01 09:49:36 -04001267func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001268 if vndkdep := c.vndkdep; vndkdep != nil {
1269 return vndkdep.isVndkSp()
1270 }
1271 return false
1272}
1273
Ivan Lozanof9e21722020-12-02 09:00:51 -05001274func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001275 if vndkdep := c.vndkdep; vndkdep != nil {
1276 return vndkdep.isVndkExt()
1277 }
1278 return false
1279}
1280
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001281func (c *Module) SubName() string {
1282 return c.Properties.SubName
1283}
1284
Ivan Lozano52767be2019-10-18 14:49:46 -07001285func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001286 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001287}
1288
Logan Chienf3511742017-10-31 18:04:35 +08001289func (c *Module) getVndkExtendsModuleName() string {
1290 if vndkdep := c.vndkdep; vndkdep != nil {
1291 return vndkdep.getVndkExtendsModuleName()
1292 }
1293 return ""
1294}
1295
Jiyong Park25fc6a92018-11-18 18:02:45 +09001296func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001297 if lib := c.library; lib != nil {
1298 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001299 }
1300 return false
1301}
1302
1303func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001304 if lib := c.library; lib != nil {
1305 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001306 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001307 return false
1308}
1309
Colin Cross0477b422020-10-13 18:43:54 -07001310// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1311// the implementation. If it is an implementation library it returns its own name.
1312func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1313 name := ctx.OtherModuleName(c)
1314 if versioned, ok := c.linker.(versionedInterface); ok {
1315 name = versioned.implementationModuleName(name)
1316 }
1317 return name
1318}
1319
Martin Stjernholm2856c662020-12-02 15:03:42 +00001320// Similar to ImplementationModuleName, but uses the Make variant of the module
1321// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1322// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1323// under the premise that the prebuilt module overrides its source counterpart
1324// if it is exposed to Make).
1325func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1326 name := c.BaseModuleName()
1327 if versioned, ok := c.linker.(versionedInterface); ok {
1328 name = versioned.implementationModuleName(name)
1329 }
1330 return name
1331}
1332
Jiyong Park7d55b612021-06-11 17:22:09 +09001333func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001334 return Bool(c.Properties.Bootstrap)
1335}
1336
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001337func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001338 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1339 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1340 return false
1341 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001342 return c.linker != nil && c.linker.nativeCoverage()
1343}
1344
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001345func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001346 if p, ok := c.linker.(SnapshotInterface); ok {
1347 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001348 }
1349 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001350}
1351
Bill Peckham945441c2020-08-31 16:07:58 -07001352func (c *Module) ExcludeFromVendorSnapshot() bool {
1353 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1354}
1355
Jose Galmesf7294582020-11-13 12:07:36 -08001356func (c *Module) ExcludeFromRecoverySnapshot() bool {
1357 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1358}
1359
Jiyong Parkf1194352019-02-25 11:05:47 +09001360func isBionic(name string) bool {
1361 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001362 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001363 return true
1364 }
1365 return false
1366}
1367
Martin Stjernholm279de572019-09-10 23:18:20 +01001368func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001369 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001370 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001371 }
1372 return isBionic(name)
1373}
1374
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001375func (c *Module) XrefCcFiles() android.Paths {
1376 return c.kytheFiles
1377}
1378
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001379func (c *Module) isCfiAssemblySupportEnabled() bool {
1380 return c.sanitize != nil &&
1381 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1382}
1383
Inseob Kim800d1142021-06-14 12:03:51 +09001384func (c *Module) InstallInRoot() bool {
1385 return c.installer != nil && c.installer.installInRoot()
1386}
1387
Colin Crossca860ac2016-01-04 14:34:37 -08001388type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001389 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001390 moduleContextImpl
1391}
1392
Colin Cross37047f12016-12-13 17:06:13 -08001393type depsContext struct {
1394 android.BottomUpMutatorContext
1395 moduleContextImpl
1396}
1397
Colin Crossca860ac2016-01-04 14:34:37 -08001398type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001399 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001400 moduleContextImpl
1401}
1402
1403type moduleContextImpl struct {
1404 mod *Module
1405 ctx BaseModuleContext
1406}
1407
Colin Crossb98c8b02016-07-29 13:44:28 -07001408func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001409 return ctx.mod.toolchain(ctx.ctx)
1410}
1411
1412func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001413 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001414}
1415
1416func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001417 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001418}
1419
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001420func (ctx *moduleContextImpl) testBinary() bool {
1421 return ctx.mod.testBinary()
1422}
1423
Jiyong Park1d1119f2019-07-29 21:27:18 +09001424func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001425 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001426}
1427
Inseob Kim7f283f42020-06-01 21:53:49 +09001428func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001429 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001430}
1431
Inseob Kim1042d292020-06-01 23:23:05 +09001432func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001433 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001434}
1435
Jooyung Hanccce2f22020-03-07 03:45:53 +09001436func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001437 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001438}
1439
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001440func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001441 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001442}
1443
1444func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001445 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001446 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001447 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001448 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001449 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001450 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001451 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001452 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001453 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001454 }
1455 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001456}
1457
Jiyong Parkb35a8192020-08-10 15:59:36 +09001458func (ctx *moduleContextImpl) minSdkVersion() string {
1459 ver := ctx.mod.MinSdkVersion()
1460 if ver == "apex_inherit" && !ctx.isForPlatform() {
1461 ver = ctx.apexSdkVersion().String()
1462 }
1463 if ver == "apex_inherit" || ver == "" {
1464 ver = ctx.sdkVersion()
1465 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001466 // For crt objects, the meaning of min_sdk_version is very different from other types of
1467 // module. For them, min_sdk_version defines the oldest version that the build system will
1468 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1469 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1470 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001471 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1472 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1473 // support such an old version. The version is set to the later version in case when the
1474 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1475 // it's for an APEX.
1476 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1477 if ctx.isForPlatform() {
1478 ver = strconv.Itoa(android.FutureApiLevelInt)
1479 } else { // for apex
1480 ver = ctx.apexSdkVersion().String()
1481 if ver == "" { // in case when min_sdk_version was not set by the APEX
1482 ver = ctx.sdkVersion()
1483 }
1484 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001485 }
1486
Jiyong Parkb35a8192020-08-10 15:59:36 +09001487 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1488 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1489 minSdkVersionInt, err2 := strconv.Atoi(ver)
1490 if err == nil && err2 == nil {
1491 if sdkVersionInt < minSdkVersionInt {
1492 return strconv.Itoa(sdkVersionInt)
1493 }
1494 }
1495 return ver
1496}
1497
1498func (ctx *moduleContextImpl) isSdkVariant() bool {
1499 return ctx.mod.IsSdkVariant()
1500}
1501
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001502func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001503 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001504}
Justin Yun8effde42017-06-23 19:24:43 +09001505
Colin Cross95f1ca02020-10-29 20:47:22 -07001506func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1507 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001508}
1509
Colin Cross127bb8b2020-12-16 16:46:01 -08001510func (ctx *moduleContextImpl) IsLlndk() bool {
1511 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001512}
1513
Colin Cross127bb8b2020-12-16 16:46:01 -08001514func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1515 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001516}
1517
Colin Cross127bb8b2020-12-16 16:46:01 -08001518func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1519 return ctx.mod.isImplementationForLLNDKPublic()
1520}
1521
1522func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1523 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001524}
1525
Logan Chienf3511742017-10-31 18:04:35 +08001526func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001527 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001528}
1529
Yi Kong7e53c572018-02-14 18:16:12 +08001530func (ctx *moduleContextImpl) isPgoCompile() bool {
1531 return ctx.mod.isPgoCompile()
1532}
1533
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001534func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1535 return ctx.mod.isNDKStubLibrary()
1536}
1537
Justin Yun8effde42017-06-23 19:24:43 +09001538func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001539 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001540}
1541
Ivan Lozanof9e21722020-12-02 09:00:51 -05001542func (ctx *moduleContextImpl) IsVndkExt() bool {
1543 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001544}
1545
Colin Cross5271fea2021-04-27 13:06:04 -07001546func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1547 return ctx.mod.IsVendorPublicLibrary()
1548}
1549
Vic Yangefd249e2018-11-12 20:19:56 -08001550func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001551 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001552}
1553
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001554func (ctx *moduleContextImpl) selectedStl() string {
1555 if stl := ctx.mod.stl; stl != nil {
1556 return stl.Properties.SelectedStl
1557 }
1558 return ""
1559}
1560
Ivan Lozanobd721262018-11-27 14:33:03 -08001561func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1562 return ctx.mod.linker.useClangLld(actx)
1563}
1564
Colin Crossce75d2c2016-10-06 16:12:58 -07001565func (ctx *moduleContextImpl) baseModuleName() string {
1566 return ctx.mod.ModuleBase.BaseModuleName()
1567}
1568
Logan Chienf3511742017-10-31 18:04:35 +08001569func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1570 return ctx.mod.getVndkExtendsModuleName()
1571}
1572
Logan Chiene274fc92019-12-03 11:18:32 -08001573func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001574 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001575}
1576
Colin Crosse07f2312020-08-13 11:24:56 -07001577func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001578 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001579}
1580
Dan Albertc8060532020-07-22 22:32:17 -07001581func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001582 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001583}
1584
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001585func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001586 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001587}
1588
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001589func (ctx *moduleContextImpl) nativeCoverage() bool {
1590 return ctx.mod.nativeCoverage()
1591}
1592
Colin Cross56a83212020-09-15 18:30:11 -07001593func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1594 return ctx.mod.DirectlyInAnyApex()
1595}
1596
Colin Cross95b07f22020-12-16 11:06:50 -08001597func (ctx *moduleContextImpl) isPreventInstall() bool {
1598 return ctx.mod.Properties.PreventInstall
1599}
1600
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001601func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1602 return ctx.mod.isCfiAssemblySupportEnabled()
1603}
1604
Colin Cross635c3b02016-05-18 15:37:25 -07001605func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001606 return &Module{
1607 hod: hod,
1608 multilib: multilib,
1609 }
1610}
1611
Colin Cross635c3b02016-05-18 15:37:25 -07001612func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001613 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001614 module.features = []feature{
1615 &tidyFeature{},
1616 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001617 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001618 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001619 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001620 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001621 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001622 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001623 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001624 return module
1625}
1626
Colin Crossce75d2c2016-10-06 16:12:58 -07001627func (c *Module) Prebuilt() *android.Prebuilt {
1628 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1629 return p.prebuilt()
1630 }
1631 return nil
1632}
1633
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001634func (c *Module) IsPrebuilt() bool {
1635 return c.Prebuilt() != nil
1636}
1637
Colin Crossce75d2c2016-10-06 16:12:58 -07001638func (c *Module) Name() string {
1639 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001640 if p, ok := c.linker.(interface {
1641 Name(string) string
1642 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001643 name = p.Name(name)
1644 }
1645 return name
1646}
1647
Alex Light3d673592019-01-18 14:37:31 -08001648func (c *Module) Symlinks() []string {
1649 if p, ok := c.installer.(interface {
1650 symlinkList() []string
1651 }); ok {
1652 return p.symlinkList()
1653 }
1654 return nil
1655}
1656
Roland Levillainf89cd092019-07-29 16:22:59 +01001657func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1658 test, ok := c.linker.(testPerSrc)
1659 return ok && test.isAllTestsVariation()
1660}
1661
Chris Parsons216e10a2020-07-09 17:12:52 -04001662func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001663 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001664 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001665 }); ok {
1666 return p.dataPaths()
1667 }
1668 return nil
1669}
1670
Justin Yun5f7f7e82019-11-18 19:52:14 +09001671func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1672 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1673 // "current", it will append the VNDK version to the name suffix.
1674 var vndkVersion string
1675 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001676 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001677 if c.ProductSpecific() {
1678 // If the module is product specific with 'product_specific: true',
1679 // do not add a name suffix because it is a base module.
1680 return ""
1681 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001682 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
Matthew Maurer52af5b02021-05-27 10:01:36 -07001683 nameSuffix = ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001684 } else {
1685 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001686 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001687 }
1688 if vndkVersion == "current" {
1689 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1690 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001691 if c.Properties.VndkVersion != vndkVersion && c.Properties.VndkVersion != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001692 // add version suffix only if the module is using different vndk version than the
1693 // version in product or vendor partition.
1694 nameSuffix += "." + c.Properties.VndkVersion
1695 }
1696 return nameSuffix
1697}
1698
Chris Parsons8d6e4332021-02-22 16:13:50 -05001699func (c *Module) setSubnameProperty(actx android.ModuleContext) {
Inseob Kim64c43952019-08-26 16:52:35 +09001700 c.Properties.SubName = ""
1701
1702 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07001703 c.Properties.SubName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001704 }
1705
Colin Cross127bb8b2020-12-16 16:46:01 -08001706 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001707 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001708 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1709 // added for product variant only when we have vendor and product variants with core
1710 // variant. The suffix is not added for vendor-only or product-only module.
1711 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
Colin Cross5271fea2021-04-27 13:06:04 -07001712 } else if c.IsVendorPublicLibrary() {
1713 c.Properties.SubName += vendorPublicLibrarySuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001714 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001715 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1716 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001717 c.Properties.SubName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001718 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07001719 c.Properties.SubName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001720 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001721 c.Properties.SubName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001722 } else if c.InRecovery() && !c.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08001723 c.Properties.SubName += RecoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001724 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001725 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001726 if c.SplitPerApiLevel() {
1727 c.Properties.SubName += "." + c.SdkVersion()
1728 }
Inseob Kim64c43952019-08-26 16:52:35 +09001729 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001730}
1731
1732// Returns true if Bazel was successfully used for the analysis of this module.
1733func (c *Module) maybeGenerateBazelActions(actx android.ModuleContext) bool {
Chris Parsons77acf2e2021-12-03 17:27:16 -05001734 var bazelModuleLabel string
1735 if actx.ModuleType() == "cc_library" && c.static() {
1736 // cc_library is a special case in bp2build; two targets are generated -- one for each
1737 // of the shared and static variants. The shared variant keeps the module name, but the
1738 // static variant uses a different suffixed name.
1739 bazelModuleLabel = bazelLabelForStaticModule(actx, c)
1740 } else {
1741 bazelModuleLabel = c.GetBazelLabel(actx, c)
1742 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001743 bazelActionsUsed := false
Chris Parsons18266212021-09-23 13:42:38 -04001744 // Mixed builds mode is disabled for modules outside of device OS.
1745 // TODO(b/200841190): Support non-device OS in mixed builds.
Chris Parsons494eef32021-11-09 10:29:52 -05001746 if c.MixedBuildsEnabled(actx) && c.bazelHandler != nil {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +00001747 bazelActionsUsed = c.bazelHandler.GenerateBazelBuildActions(actx, bazelModuleLabel)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001748 }
1749 return bazelActionsUsed
1750}
1751
1752func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1753 // TODO(cparsons): Any logic in this method occurring prior to querying Bazel should be
1754 // requested from Bazel instead.
1755
1756 // Handle the case of a test module split by `test_per_src` mutator.
1757 //
1758 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1759 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1760 // module and return early, as this module does not produce an output file per se.
1761 if c.IsTestPerSrcAllTestsVariation() {
1762 c.outputFile = android.OptionalPath{}
1763 return
1764 }
1765
1766 c.setSubnameProperty(actx)
1767 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1768 if !apexInfo.IsForPlatform() {
1769 c.hideApexVariantFromMake = true
1770 }
1771
Chris Parsonseefc9e62021-04-02 17:36:47 -04001772 c.makeLinkType = GetMakeLinkType(actx, c)
1773
Colin Crossca860ac2016-01-04 14:34:37 -08001774 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001775 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001776 moduleContextImpl: moduleContextImpl{
1777 mod: c,
1778 },
1779 }
1780 ctx.ctx = ctx
1781
Chris Parsons94a0bba2021-06-04 15:03:47 -04001782 if c.maybeGenerateBazelActions(actx) {
1783 c.maybeInstall(ctx, apexInfo)
1784 return
1785 }
1786
Colin Crossf18e1102017-11-16 14:33:08 -08001787 deps := c.depsToPaths(ctx)
1788 if ctx.Failed() {
1789 return
1790 }
1791
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001792 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1793 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1794 }
1795
Colin Crossca860ac2016-01-04 14:34:37 -08001796 flags := Flags{
1797 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001798 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001799 }
Colin Crossca860ac2016-01-04 14:34:37 -08001800 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001801 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001802 }
1803 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001804 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001805 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001806 if c.stl != nil {
1807 flags = c.stl.flags(ctx, flags)
1808 }
Colin Cross16b23492016-01-06 14:41:07 -08001809 if c.sanitize != nil {
1810 flags = c.sanitize.flags(ctx, flags)
1811 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001812 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001813 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001814 }
Stephen Craneba090d12017-05-09 15:44:35 -07001815 if c.lto != nil {
1816 flags = c.lto.flags(ctx, flags)
1817 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001818 if c.pgo != nil {
1819 flags = c.pgo.flags(ctx, flags)
1820 }
Colin Crossca860ac2016-01-04 14:34:37 -08001821 for _, feature := range c.features {
1822 flags = feature.flags(ctx, flags)
1823 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001824 if ctx.Failed() {
1825 return
1826 }
1827
Colin Cross4af21ed2019-11-04 09:37:55 -08001828 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1829 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1830 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001831
Colin Cross4af21ed2019-11-04 09:37:55 -08001832 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001833
1834 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001835 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001836 }
1837 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001838 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001839 }
1840
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001841 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001842 // We need access to all the flags seen by a source file.
1843 if c.sabi != nil {
1844 flags = c.sabi.flags(ctx, flags)
1845 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001846
Colin Cross4af21ed2019-11-04 09:37:55 -08001847 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001848
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001849 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001850 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001851 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001852 if ctx.Failed() {
1853 return
1854 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001855 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07001856 c.objFiles = objs.objFiles
1857 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001858 }
1859
Colin Crossca860ac2016-01-04 14:34:37 -08001860 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001861 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001862 if ctx.Failed() {
1863 return
1864 }
Colin Cross635c3b02016-05-18 15:37:25 -07001865 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001866
Chris Parsons94a0bba2021-06-04 15:03:47 -04001867 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001868
Jose Galmes6f843bc2020-12-11 13:36:29 -08001869 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
1870 // RECOVERY_SNAPSHOT_VERSION is current.
1871 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001872 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001873 i.collectHeadersForSnapshot(ctx)
1874 }
1875 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001876 }
Colin Cross5049f022015-03-18 13:28:46 -07001877
Chris Parsons94a0bba2021-06-04 15:03:47 -04001878 c.maybeInstall(ctx, apexInfo)
1879}
1880
1881func (c *Module) maybeUnhideFromMake() {
1882 // If a lib is directly included in any of the APEXes or is not available to the
1883 // platform (which is often the case when the stub is provided as a prebuilt),
1884 // unhide the stubs variant having the latest version gets visible to make. In
1885 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1886 // force anything in the make world to link against the stubs library. (unless it
1887 // is explicitly referenced via .bootstrap suffix or the module is marked with
1888 // 'bootstrap: true').
1889 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
1890 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
1891 c.IsStubs() && !c.InVendorRamdisk() {
1892 c.Properties.HideFromMake = false // unhide
1893 // Note: this is still non-installable
1894 }
1895}
1896
1897func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07001898 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001899 // If the module has been specifically configure to not be installed then
1900 // hide from make as otherwise it will break when running inside make
1901 // as the output path to install will not be specified. Not all uninstallable
1902 // modules can be hidden from make as some are needed for resolving make side
1903 // dependencies.
1904 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001905 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001906 c.SkipInstall()
1907 }
1908
1909 // Still call c.installer.install though, the installs will be stored as PackageSpecs
1910 // to allow using the outputs in a genrule.
1911 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001912 c.installer.install(ctx, c.outputFile.Path())
1913 if ctx.Failed() {
1914 return
Colin Crossca860ac2016-01-04 14:34:37 -08001915 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001916 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001917}
1918
Colin Cross0ea8ba82019-06-06 14:33:29 -07001919func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001920 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05001921 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08001922 }
Colin Crossca860ac2016-01-04 14:34:37 -08001923 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001924}
1925
Colin Crossca860ac2016-01-04 14:34:37 -08001926func (c *Module) begin(ctx BaseModuleContext) {
1927 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001928 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001929 }
Colin Crossca860ac2016-01-04 14:34:37 -08001930 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001931 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001932 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001933 if c.stl != nil {
1934 c.stl.begin(ctx)
1935 }
Colin Cross16b23492016-01-06 14:41:07 -08001936 if c.sanitize != nil {
1937 c.sanitize.begin(ctx)
1938 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001939 if c.coverage != nil {
1940 c.coverage.begin(ctx)
1941 }
Stephen Craneba090d12017-05-09 15:44:35 -07001942 if c.lto != nil {
1943 c.lto.begin(ctx)
1944 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001945 if c.pgo != nil {
1946 c.pgo.begin(ctx)
1947 }
Dan Albert92fe7402020-07-15 13:33:30 -07001948 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001949 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001950 if err != nil {
1951 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001952 c.Properties.Sdk_version = nil
1953 } else {
1954 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001955 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001956 }
Colin Crossca860ac2016-01-04 14:34:37 -08001957}
1958
Colin Cross37047f12016-12-13 17:06:13 -08001959func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001960 deps := Deps{}
1961
1962 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001963 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001964 }
1965 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001966 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001967 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001968 if c.stl != nil {
1969 deps = c.stl.deps(ctx, deps)
1970 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001971 if c.coverage != nil {
1972 deps = c.coverage.deps(ctx, deps)
1973 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001974
Colin Crossb6715442017-10-24 11:13:31 -07001975 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1976 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1977 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1978 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1979 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1980 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001981 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001982
Liz Kammer356f7d42021-01-26 09:18:53 -05001983 // In Bazel conversion mode, we dependency and build validations will occur in Bazel, so there is
1984 // no need to do so in Soong.
1985 if ctx.BazelConversionMode() {
1986 return deps
1987 }
1988
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001989 for _, lib := range deps.ReexportSharedLibHeaders {
1990 if !inList(lib, deps.SharedLibs) {
1991 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1992 }
1993 }
1994
1995 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00001996 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
1997 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 -07001998 }
1999 }
2000
Colin Cross5950f382016-12-13 12:50:57 -08002001 for _, lib := range deps.ReexportHeaderLibHeaders {
2002 if !inList(lib, deps.HeaderLibs) {
2003 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2004 }
2005 }
2006
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002007 for _, gen := range deps.ReexportGeneratedHeaders {
2008 if !inList(gen, deps.GeneratedHeaders) {
2009 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2010 }
2011 }
2012
Colin Crossc99deeb2016-04-11 15:06:20 -07002013 return deps
2014}
2015
Dan Albert7e9d2952016-08-04 13:02:36 -07002016func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002017 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002018 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002019 moduleContextImpl: moduleContextImpl{
2020 mod: c,
2021 },
2022 }
2023 ctx.ctx = ctx
2024
Colin Crossca860ac2016-01-04 14:34:37 -08002025 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002026}
2027
Jiyong Park7ed9de32018-10-15 22:25:07 +09002028// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002029func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002030 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2031 version := name[sharp+1:]
2032 libname := name[:sharp]
2033 return libname, version
2034 }
2035 return name, ""
2036}
2037
Dan Albert92fe7402020-07-15 13:33:30 -07002038func GetCrtVariations(ctx android.BottomUpMutatorContext,
2039 m LinkableInterface) []blueprint.Variation {
2040 if ctx.Os() != android.Android {
2041 return nil
2042 }
2043 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002044 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2045 minSdkVersion := m.MinSdkVersion()
2046 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2047 minSdkVersion = m.SdkVersion()
2048 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002049 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2050 if err != nil {
2051 ctx.PropertyErrorf("min_sdk_version", err.Error())
2052 }
Dan Albert92fe7402020-07-15 13:33:30 -07002053 return []blueprint.Variation{
2054 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002055 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002056 }
2057 }
2058 return []blueprint.Variation{
2059 {Mutator: "sdk", Variation: ""},
2060 }
2061}
2062
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002063func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2064 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002065
2066 variations = append([]blueprint.Variation(nil), variations...)
2067
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002068 if version != "" && CanBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002069 // Version is explicitly specified. i.e. libFoo#30
2070 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002071 if tag, ok := depTag.(libraryDependencyTag); ok {
2072 tag.explicitlyVersioned = true
2073 } else {
2074 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2075 }
Colin Crosse7257d22020-09-24 09:56:18 -07002076 }
Colin Crosse7257d22020-09-24 09:56:18 -07002077
Colin Cross0de8a1e2020-09-18 14:15:30 -07002078 if far {
2079 ctx.AddFarVariationDependencies(variations, depTag, name)
2080 } else {
2081 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002082 }
2083}
2084
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002085func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002086 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002087 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002088 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002089 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2090 // between the modules in the snapshot and the snapshot itself.
2091 var snapshotModule []blueprint.Module
2092 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2093 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2094 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2095 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2096 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002097 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002098 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2099 *snapshotInfo = &snapshot
2100 // republish the snapshot for use in later mutators on this module
2101 actx.SetProvider(SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002102 }
2103 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002104 if *snapshotInfo == nil {
2105 *snapshotInfo = &SnapshotInfo{}
2106 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002107 return **snapshotInfo
2108}
2109
2110func RewriteSnapshotLib(lib string, snapshotMap map[string]string) string {
2111 if snapshot, ok := snapshotMap[lib]; ok {
2112 return snapshot
2113 }
2114
2115 return lib
2116}
2117
2118// RewriteLibs takes a list of names of shared libraries and scans it for three types
2119// of names:
2120//
2121// 1. Name of an NDK library that refers to a prebuilt module.
2122// For each of these, it adds the name of the prebuilt module (which will be in
2123// prebuilts/ndk) to the list of nonvariant libs.
2124// 2. Name of an NDK library that refers to an ndk_library module.
2125// For each of these, it adds the name of the ndk_library module to the list of
2126// variant libs.
2127// 3. Anything else (so anything that isn't an NDK library).
2128// It adds these to the nonvariantLibs list.
2129//
2130// The caller can then know to add the variantLibs dependencies differently from the
2131// nonvariantLibs
2132func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2133 variantLibs = []string{}
2134
2135 nonvariantLibs = []string{}
2136 for _, entry := range list {
2137 // strip #version suffix out
2138 name, _ := StubsLibNameAndVersion(entry)
2139 if c.InRecovery() {
2140 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2141 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2142 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2143 } else if c.UseVndk() {
2144 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2145 } else {
2146 // put name#version back
2147 nonvariantLibs = append(nonvariantLibs, entry)
2148 }
2149 }
2150 return nonvariantLibs, variantLibs
2151}
2152
Colin Cross1e676be2016-10-12 14:38:15 -07002153func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002154 if !c.Enabled() {
2155 return
2156 }
2157
Colin Cross37047f12016-12-13 17:06:13 -08002158 ctx := &depsContext{
2159 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002160 moduleContextImpl: moduleContextImpl{
2161 mod: c,
2162 },
2163 }
2164 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002165
Colin Crossc99deeb2016-04-11 15:06:20 -07002166 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002167
Yo Chiang219968c2020-09-22 18:45:04 +08002168 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2169
Colin Crosse0edaf92021-01-11 17:31:17 -08002170 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002171
Dan Albert914449f2016-06-17 16:45:24 -07002172 variantNdkLibs := []string{}
2173 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002174 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002175 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2176 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2177 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002178
2179 for idx, lib := range deps.RuntimeLibs {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002180 deps.RuntimeLibs[idx] = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002181 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002182 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002183
Colin Cross32ec36c2016-12-15 07:39:51 -08002184 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002185 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002186 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002187 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002188 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002189
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002190 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002191
Jiyong Park1ad8e162020-12-01 23:40:09 +09002192 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002193 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002194 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002195 } else {
2196 actx.AddVariationDependencies(nil, depTag, lib)
2197 }
2198 }
2199
Dan Albertf1d14c72020-07-30 14:32:55 -07002200 if c.isNDKStubLibrary() {
2201 // NDK stubs depend on their implementation because the ABI dumps are
2202 // generated from the implementation library.
2203 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2204 c.ImageVariation(),
2205 blueprint.Variation{Mutator: "link", Variation: "shared"},
2206 ), stubImplementation, c.BaseModuleName())
2207 }
2208
Inseob Kim07def122020-11-23 14:43:02 +09002209 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
2210 // C++ implementation library and one Java implementation library. When a module links against
2211 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
2212 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
2213 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09002214 syspropImplLibraries := syspropImplLibraries(actx.Config())
2215
Jiyong Park5d1598f2019-02-25 22:14:17 +09002216 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002217 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09002218 if impl, ok := syspropImplLibraries[lib]; ok {
2219 lib = impl
2220 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002221
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002222 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002223
Jiyong Park5d1598f2019-02-25 22:14:17 +09002224 actx.AddVariationDependencies([]blueprint.Variation{
2225 {Mutator: "link", Variation: "static"},
2226 }, depTag, lib)
2227 }
2228
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002229 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002230 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002231 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002232 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002233 }
Jiyong Parke3867542020-12-03 17:28:25 +09002234 if inList(lib, deps.ExcludeLibsForApex) {
2235 depTag.excludeInApex = true
2236 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002237
2238 if impl, ok := syspropImplLibraries[lib]; ok {
2239 lib = impl
2240 }
2241
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002242 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002243
Dan Willemsen59339a22018-07-22 21:18:45 -07002244 actx.AddVariationDependencies([]blueprint.Variation{
2245 {Mutator: "link", Variation: "static"},
2246 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002247 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002248
Jooyung Han75568392020-03-20 04:29:24 +09002249 // staticUnwinderDep is treated as staticDep for Q apexes
2250 // so that native libraries/binaries are linked with static unwinder
2251 // because Q libc doesn't have unwinder APIs
2252 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002253 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002254 actx.AddVariationDependencies([]blueprint.Variation{
2255 {Mutator: "link", Variation: "static"},
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002256 }, depTag, RewriteSnapshotLib(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002257 }
2258
Jiyong Park7ed9de32018-10-15 22:25:07 +09002259 // shared lib names without the #version suffix
2260 var sharedLibNames []string
2261
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002262 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002263 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002264 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002265 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002266 }
Jiyong Parke3867542020-12-03 17:28:25 +09002267 if inList(lib, deps.ExcludeLibsForApex) {
2268 depTag.excludeInApex = true
2269 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002270
2271 if impl, ok := syspropImplLibraries[lib]; ok {
2272 lib = impl
2273 }
2274
Jiyong Park73c54ee2019-10-22 20:31:18 +09002275 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002276 sharedLibNames = append(sharedLibNames, name)
2277
Colin Crosse7257d22020-09-24 09:56:18 -07002278 variations := []blueprint.Variation{
2279 {Mutator: "link", Variation: "shared"},
2280 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002281 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002282 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002283
Colin Crossfe9acfe2021-06-14 16:13:03 -07002284 for _, lib := range deps.LateStaticLibs {
2285 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2286 actx.AddVariationDependencies([]blueprint.Variation{
2287 {Mutator: "link", Variation: "static"},
2288 }, depTag, RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
2289 }
2290
Jiyong Park7ed9de32018-10-15 22:25:07 +09002291 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002292 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002293 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2294 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2295 // linking against both the stubs lib and the non-stubs lib at the same time.
2296 continue
2297 }
Colin Cross6e511a92020-07-27 21:26:48 -07002298 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002299 variations := []blueprint.Variation{
2300 {Mutator: "link", Variation: "shared"},
2301 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002302 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002303 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002304
Dan Willemsen59339a22018-07-22 21:18:45 -07002305 actx.AddVariationDependencies([]blueprint.Variation{
2306 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002307 }, dataLibDepTag, deps.DataLibs...)
2308
Colin Crossc8caa062021-09-24 16:50:14 -07002309 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2310
Chris Parsons79d66a52020-06-05 17:26:16 -04002311 actx.AddVariationDependencies([]blueprint.Variation{
2312 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002313 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002314
Colin Cross68861832016-07-08 10:41:41 -07002315 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002316
2317 for _, gen := range deps.GeneratedHeaders {
2318 depTag := genHeaderDepTag
2319 if inList(gen, deps.ReexportGeneratedHeaders) {
2320 depTag = genHeaderExportDepTag
2321 }
2322 actx.AddDependency(c, depTag, gen)
2323 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002324
Dan Albert92fe7402020-07-15 13:33:30 -07002325 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002326 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002327 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002328 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002329 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002330 }
Colin Crossc465efd2021-06-11 18:00:04 -07002331 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002332 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002333 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002334 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002335 if deps.DynamicLinker != "" {
2336 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002337 }
Dan Albert914449f2016-06-17 16:45:24 -07002338
2339 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002340
2341 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002342 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002343 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002344 {Mutator: "link", Variation: "shared"},
2345 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002346
2347 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002348 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002349 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002350 {Mutator: "link", Variation: "shared"},
2351 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002352
2353 if vndkdep := c.vndkdep; vndkdep != nil {
2354 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002355 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002356 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002357 {Mutator: "link", Variation: "shared"},
Justin Yun27b95722021-07-28 17:04:44 +09002358 }, vndkExtDepTag, RewriteSnapshotLib(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002359 }
2360 }
Colin Cross6362e272015-10-29 15:25:03 -07002361}
Colin Cross21b9a242015-03-24 14:15:58 -07002362
Colin Crosse40b4ea2018-10-02 22:25:58 -07002363func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002364 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2365 c.beginMutator(ctx)
2366 }
2367}
2368
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002369// Whether a module can link to another module, taking into
2370// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002371func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002372 tag blueprint.DependencyTag) {
2373
2374 switch t := tag.(type) {
2375 case dependencyTag:
2376 if t != vndkExtDepTag {
2377 return
2378 }
2379 case libraryDependencyTag:
2380 default:
2381 return
2382 }
2383
Ivan Lozanof9e21722020-12-02 09:00:51 -05002384 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002385 // Host code is not restricted
2386 return
2387 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002388
2389 // VNDK is cc.Module supported only for now.
2390 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002391 // Though allowed dependency is limited by the image mutator,
2392 // each vendor and product module needs to check link-type
2393 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002394 if ccTo, ok := to.(*Module); ok {
2395 if ccFrom.vndkdep != nil {
2396 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2397 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002398 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002399 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002400 }
2401 return
2402 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002403 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002404 // Platform code can link to anything
2405 return
2406 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002407 if from.InRamdisk() {
2408 // Ramdisk code is not NDK
2409 return
2410 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002411 if from.InVendorRamdisk() {
2412 // Vendor ramdisk code is not NDK
2413 return
2414 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002415 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002416 // Recovery code is not NDK
2417 return
2418 }
Colin Cross31076b32020-10-23 17:22:06 -07002419 if c, ok := to.(*Module); ok {
2420 if c.ToolchainLibrary() {
2421 // These are always allowed
2422 return
2423 }
2424 if c.NdkPrebuiltStl() {
2425 // These are allowed, but they don't set sdk_version
2426 return
2427 }
2428 if c.StubDecorator() {
2429 // These aren't real libraries, but are the stub shared libraries that are included in
2430 // the NDK.
2431 return
2432 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002433 }
Logan Chien834b9a62019-01-14 15:39:03 +08002434
Ivan Lozano52767be2019-10-18 14:49:46 -07002435 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002436 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2437 // to link to libc++ (non-NDK and without sdk_version).
2438 return
2439 }
2440
Ivan Lozano52767be2019-10-18 14:49:46 -07002441 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002442 // NDK code linking to platform code is never okay.
2443 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002444 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002445 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002446 }
2447
2448 // At this point we know we have two NDK libraries, but we need to
2449 // check that we're not linking against anything built against a higher
2450 // API level, as it is only valid to link against older or equivalent
2451 // APIs.
2452
Inseob Kim01a28722018-04-11 09:48:45 +09002453 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002454 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002455 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002456 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002457 // Current can't be linked against by anything else.
2458 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002459 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002460 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002461 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002462 if err != nil {
2463 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002464 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002465 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002466 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002467 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002468 if err != nil {
2469 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002470 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002471 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002472 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002473
Inseob Kim01a28722018-04-11 09:48:45 +09002474 if toApi > fromApi {
2475 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002476 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002477 }
2478 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002479 }
Dan Albert202fe492017-12-15 13:56:59 -08002480
2481 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002482 fromStl := from.SelectedStl()
2483 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002484 if fromStl == "" || toStl == "" {
2485 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002486 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002487 // We can be permissive with the system "STL" since it is only the C++
2488 // ABI layer, but in the future we should make sure that everyone is
2489 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002490 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002491 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002492 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2493 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002494 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002495}
2496
Jooyung Han479ca172020-10-19 18:51:07 +09002497func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2498 if c, ok := ctx.Module().(*Module); ok {
2499 ctx.VisitDirectDeps(func(dep android.Module) {
2500 depTag := ctx.OtherModuleDependencyTag(dep)
2501 ccDep, ok := dep.(LinkableInterface)
2502 if ok {
2503 checkLinkType(ctx, c, ccDep, depTag)
2504 }
2505 })
2506 }
2507}
2508
Jiyong Park5fb8c102018-04-09 12:03:06 +09002509// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002510// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2511// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002512// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002513func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2514 check := func(child, parent android.Module) bool {
2515 to, ok := child.(*Module)
2516 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002517 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002518 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002519
Jooyung Hana70f0672019-01-18 15:20:43 +09002520 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2521 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002522 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002523
Jiyong Park0474e1f2021-01-14 14:26:06 +09002524 // These dependencies are not excercised at runtime. Tracking these will give us
2525 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002526 depTag := ctx.OtherModuleDependencyTag(child)
2527 if IsHeaderDepTag(depTag) {
2528 return false
2529 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002530 if depTag == staticVariantTag {
2531 return false
2532 }
2533 if depTag == stubImplDepTag {
2534 return false
2535 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002536
Justin Yun63e9ec72020-10-29 16:49:43 +09002537 // Even if target lib has no vendor variant, keep checking dependency
2538 // graph in case it depends on vendor_available or product_available
2539 // but not double_loadable transtively.
2540 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002541 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002542 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002543
Jiyong Park0474e1f2021-01-14 14:26:06 +09002544 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2545 // one.
2546 if Bool(to.VendorProperties.Double_loadable) {
2547 return true
2548 }
2549
Ivan Lozanod7586b62021-04-01 09:49:36 -04002550 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002551 return false
2552 }
2553
Jooyung Hana70f0672019-01-18 15:20:43 +09002554 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2555 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002556 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002557 return false
2558 }
2559 if module, ok := ctx.Module().(*Module); ok {
2560 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002561 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002562 ctx.WalkDeps(check)
2563 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002564 }
2565 }
2566}
2567
Colin Crossc99deeb2016-04-11 15:06:20 -07002568// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002569func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002570 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002571
Colin Cross0de8a1e2020-09-18 14:15:30 -07002572 var directStaticDeps []StaticLibraryInfo
2573 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002574
Colin Cross0de8a1e2020-09-18 14:15:30 -07002575 reexportExporter := func(exporter FlagExporterInfo) {
2576 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2577 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2578 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2579 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2580 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002581 }
2582
Jooyung Hande34d232020-07-23 13:04:15 +09002583 // For the dependency from platform to apex, use the latest stubs
2584 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002585 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2586 if !apexInfo.IsForPlatform() {
Jiyong Park4eab21d2021-04-15 15:17:54 +09002587 c.apexSdkVersion = apexInfo.MinSdkVersion
Jooyung Hande34d232020-07-23 13:04:15 +09002588 }
2589
2590 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2591 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2592 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2593 // (b/144430859)
2594 c.apexSdkVersion = android.FutureApiLevel
2595 }
2596
Colin Crossd11fcda2017-10-23 17:59:01 -07002597 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002598 depName := ctx.OtherModuleName(dep)
2599 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002600
Dan Willemsen47450072021-10-19 20:24:49 -07002601 if depTag == android.DarwinUniversalVariantTag {
2602 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
2603 return
2604 }
2605
Ivan Lozano52767be2019-10-18 14:49:46 -07002606 ccDep, ok := dep.(LinkableInterface)
2607 if !ok {
2608
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002609 // handling for a few module types that aren't cc Module but that are also supported
2610 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002611 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002612 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002613 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2614 genRule.GeneratedSourceFiles()...)
2615 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002616 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002617 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002618 // Support exported headers from a generated_sources dependency
2619 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002620 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002621 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002622 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002623 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002624 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002625 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002626 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002627 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002628 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2629 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002630 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002631 // 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 +09002632 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002633
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002634 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002635 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002636 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002637 }
Colin Crosscef792e2021-06-11 18:01:26 -07002638 case CrtBeginDepTag:
2639 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2640 case CrtEndDepTag:
2641 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002642 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002643 return
2644 }
2645
Colin Crossfe17f6f2019-03-28 19:30:56 -07002646 if depTag == android.ProtoPluginDepTag {
2647 return
2648 }
2649
Colin Crossd11fcda2017-10-23 17:59:01 -07002650 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002651 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2652 return
2653 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002654 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002655 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2656 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002657 return
2658 }
2659
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002660 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002661 // Skip reused objects for stub libraries, they use their own stub object file instead.
2662 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2663 // version mutator, so the stubs variant is created from the shared variant that
2664 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002665 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002666 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2667 objs := staticAnalogue.ReuseObjects
2668 depPaths.Objs = depPaths.Objs.Append(objs)
2669 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2670 reexportExporter(depExporterInfo)
2671 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002672 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002673 }
2674
Colin Cross6e511a92020-07-27 21:26:48 -07002675 linkFile := ccDep.OutputFile()
2676
2677 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2678 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002679 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002680 return
2681 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002682
Jiyong Parke3867542020-12-03 17:28:25 +09002683 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2684 return
2685 }
2686
Colin Cross0de8a1e2020-09-18 14:15:30 -07002687 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002688
Colin Cross6e511a92020-07-27 21:26:48 -07002689 var ptr *android.Paths
2690 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002691
Colin Cross6e511a92020-07-27 21:26:48 -07002692 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002693
Colin Cross6e511a92020-07-27 21:26:48 -07002694 switch {
2695 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002696 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2697 if !ctx.Config().AllowMissingDependencies() {
2698 ctx.ModuleErrorf("module %q is not a header library", depName)
2699 } else {
2700 ctx.AddMissingDependencies([]string{depName})
2701 }
2702 return
2703 }
Colin Cross6e511a92020-07-27 21:26:48 -07002704 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002705 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2706 if !ctx.Config().AllowMissingDependencies() {
2707 ctx.ModuleErrorf("module %q is not a shared library", depName)
2708 } else {
2709 ctx.AddMissingDependencies([]string{depName})
2710 }
2711 return
2712 }
Jiyong Parke3867542020-12-03 17:28:25 +09002713
Jiyong Park7d55b612021-06-11 17:22:09 +09002714 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
2715 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07002716
Jiyong Park1ad8e162020-12-01 23:40:09 +09002717 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2718 // linkFile, depFile, and ptr.
2719 if c.IsStubs() {
2720 break
2721 }
2722
Colin Cross0de8a1e2020-09-18 14:15:30 -07002723 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2724 depFile = sharedLibraryInfo.TableOfContents
2725
Colin Cross6e511a92020-07-27 21:26:48 -07002726 ptr = &depPaths.SharedLibs
2727 switch libDepTag.Order {
2728 case earlyLibraryDependency:
2729 ptr = &depPaths.EarlySharedLibs
2730 depPtr = &depPaths.EarlySharedLibsDeps
2731 case normalLibraryDependency:
2732 ptr = &depPaths.SharedLibs
2733 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002734 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002735 case lateLibraryDependency:
2736 ptr = &depPaths.LateSharedLibs
2737 depPtr = &depPaths.LateSharedLibsDeps
2738 default:
2739 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002740 }
Colin Cross6e511a92020-07-27 21:26:48 -07002741 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002742 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2743 if !ctx.Config().AllowMissingDependencies() {
2744 ctx.ModuleErrorf("module %q is not a static library", depName)
2745 } else {
2746 ctx.AddMissingDependencies([]string{depName})
2747 }
2748 return
2749 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002750
2751 // Stubs lib doesn't link to the static lib dependencies. Don't set
2752 // linkFile, depFile, and ptr.
2753 if c.IsStubs() {
2754 break
2755 }
2756
Colin Cross0de8a1e2020-09-18 14:15:30 -07002757 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2758 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002759 if libDepTag.wholeStatic {
2760 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002761 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2762 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002763 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002764 // This case normally catches prebuilt static
2765 // libraries, but it can also occur when
2766 // AllowMissingDependencies is on and the
2767 // dependencies has no sources of its own
2768 // but has a whole_static_libs dependency
2769 // on a missing library. We want to depend
2770 // on the .a file so that there is something
2771 // in the dependency tree that contains the
2772 // error rule for the missing transitive
2773 // dependency.
2774 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002775 }
Colin Cross6e511a92020-07-27 21:26:48 -07002776 } else {
2777 switch libDepTag.Order {
2778 case earlyLibraryDependency:
2779 panic(fmt.Errorf("early static libs not suppported"))
2780 case normalLibraryDependency:
2781 // static dependencies will be handled separately so they can be ordered
2782 // using transitive dependencies.
2783 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002784 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002785 case lateLibraryDependency:
2786 ptr = &depPaths.LateStaticLibs
2787 default:
2788 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002789 }
2790 }
2791 }
2792
Colin Cross6e511a92020-07-27 21:26:48 -07002793 if libDepTag.static() && !libDepTag.wholeStatic {
2794 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2795 ctx.ModuleErrorf("module %q not a static library", depName)
2796 return
2797 }
Logan Chien43d34c32017-12-20 01:17:32 +08002798
Colin Cross6e511a92020-07-27 21:26:48 -07002799 // When combining coverage files for shared libraries and executables, coverage files
2800 // in static libraries act as if they were whole static libraries. The same goes for
2801 // source based Abi dump files.
2802 if c, ok := ccDep.(*Module); ok {
2803 staticLib := c.linker.(libraryInterface)
2804 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2805 staticLib.objs().coverageFiles...)
2806 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2807 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002808 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002809 // Handle non-CC modules here
2810 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002811 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002812 }
2813 }
2814
Colin Cross6e511a92020-07-27 21:26:48 -07002815 if ptr != nil {
2816 if !linkFile.Valid() {
2817 if !ctx.Config().AllowMissingDependencies() {
2818 ctx.ModuleErrorf("module %q missing output file", depName)
2819 } else {
2820 ctx.AddMissingDependencies([]string{depName})
2821 }
2822 return
2823 }
2824 *ptr = append(*ptr, linkFile.Path())
2825 }
2826
2827 if depPtr != nil {
2828 dep := depFile
2829 if !dep.Valid() {
2830 dep = linkFile
2831 }
2832 *depPtr = append(*depPtr, dep.Path())
2833 }
2834
Colin Cross0de8a1e2020-09-18 14:15:30 -07002835 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2836 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2837 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2838 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2839
2840 if libDepTag.reexportFlags {
2841 reexportExporter(depExporterInfo)
2842 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2843 // Re-exported shared library headers must be included as well since they can help us with type information
2844 // about template instantiations (instantiated from their headers).
2845 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2846 // scripts.
2847 c.sabi.Properties.ReexportedIncludes = append(
2848 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2849 }
2850
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002851 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002852 switch {
2853 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002854 c.Properties.AndroidMkHeaderLibs = append(
2855 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002856 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002857 if lib := moduleLibraryInterface(dep); lib != nil {
2858 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002859 // Add the dependency to the APEX(es) providing the library so that
2860 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002861 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09002862 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07002863 c.Properties.ApexesProvidingSharedLibs = append(
2864 c.Properties.ApexesProvidingSharedLibs, an)
2865 }
2866 }
2867 }
2868
2869 // Note: the order of libs in this list is not important because
2870 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002871 c.Properties.AndroidMkSharedLibs = append(
2872 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002873 // Record BaseLibName for snapshots.
2874 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002875 case libDepTag.static():
2876 if libDepTag.wholeStatic {
2877 c.Properties.AndroidMkWholeStaticLibs = append(
2878 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2879 } else {
2880 c.Properties.AndroidMkStaticLibs = append(
2881 c.Properties.AndroidMkStaticLibs, makeLibName)
2882 }
Justin Yun5e035862021-06-29 20:50:37 +09002883 // Record BaseLibName for snapshots.
2884 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002885 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002886 } else if !c.IsStubs() {
2887 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2888
Colin Cross6e511a92020-07-27 21:26:48 -07002889 switch depTag {
2890 case runtimeDepTag:
2891 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002892 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002893 // Record BaseLibName for snapshots.
2894 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002895 case objDepTag:
2896 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2897 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002898 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002899 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002900 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002901 case dynamicLinkerDepTag:
2902 depPaths.DynamicLinker = linkFile
2903 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002904 }
Colin Crossca860ac2016-01-04 14:34:37 -08002905 })
2906
Jeff Gaston294356f2017-09-27 17:05:30 -07002907 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002908 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2909 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2910 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002911
Colin Crossdd84e052017-05-17 13:44:16 -07002912 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002913 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002914 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2915 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002916 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002917 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2918 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002919 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002920 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002921 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002922
2923 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002924 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002925 }
Colin Crossdd84e052017-05-17 13:44:16 -07002926
Colin Crossca860ac2016-01-04 14:34:37 -08002927 return depPaths
2928}
2929
Jiyong Park7d55b612021-06-11 17:22:09 +09002930// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
2931// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
2932// dependency. The stub variant is selected when the dependency crosses a boundary where each side
2933// has different level of updatability. For example, if a library foo in an APEX depends on a
2934// library bar which provides stable interface and exists in the platform, foo uses the stub variant
2935// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
2936// same APEX as foo, the non-stub variant of bar is used.
2937func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
2938 depName := ctx.OtherModuleName(dep)
2939 depTag := ctx.OtherModuleDependencyTag(dep)
2940 libDepTag, ok := depTag.(libraryDependencyTag)
2941 if !ok || !libDepTag.shared() {
2942 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2943 }
2944
2945 thisModule, ok := ctx.Module().(android.ApexModule)
2946 if !ok {
2947 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
2948 }
2949
2950 useVndk := false
2951 bootstrap := false
2952 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
2953 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
2954 } else {
2955 useVndk = linkable.UseVndk()
2956 bootstrap = linkable.Bootstrap()
2957 }
2958
2959 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2960 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2961 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
2962 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2963
2964 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
2965 useStubs := false
2966
2967 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
2968 if !apexInfo.IsForPlatform() {
2969 // For platform libraries, use current version of LLNDK
2970 // If this is for use_vendor apex we will apply the same rules
2971 // of apex sdk enforcement below to choose right version.
2972 useStubs = true
2973 }
Jiyong Park9477c262021-06-22 20:23:05 +09002974 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
2975 // If not building for APEX or the containing APEX allows the use of
2976 // platform APIs, use stubs only when it is from an APEX (and not from
2977 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
2978 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09002979 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
2980 if useStubs {
2981 // Another exception: if this module is a test for an APEX, then
2982 // it is linked with the non-stub variant of a module in the APEX
2983 // as if this is part of the APEX.
2984 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2985 for _, apexContents := range testFor.ApexContents {
2986 if apexContents.DirectlyInApex(depName) {
2987 useStubs = false
2988 break
2989 }
2990 }
2991 }
2992 if useStubs {
2993 // Yet another exception: If this module and the dependency are
2994 // available to the same APEXes then skip stubs between their
2995 // platform variants. This complements the test_for case above,
2996 // which avoids the stubs on a direct APEX library dependency, by
2997 // avoiding stubs for indirect test dependencies as well.
2998 //
2999 // TODO(b/183882457): This doesn't work if the two libraries have
3000 // only partially overlapping apex_available. For that test_for
3001 // modules would need to be split into APEX variants and resolved
3002 // separately for each APEX they have access to.
3003 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3004 useStubs = false
3005 }
3006 }
3007 } else {
3008 // If building for APEX, use stubs when the parent is in any APEX that
3009 // the child is not in.
3010 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3011 }
3012
3013 // when to use (unspecified) stubs, use the latest one.
3014 if useStubs {
3015 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3016 toUse := stubs[len(stubs)-1]
3017 sharedLibraryInfo = toUse.SharedLibraryInfo
3018 depExporterInfo = toUse.FlagExporterInfo
3019 }
3020 }
3021 return sharedLibraryInfo, depExporterInfo
3022}
3023
Colin Cross0de8a1e2020-09-18 14:15:30 -07003024// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3025// to match the topological order of the dependency tree, including any static analogues of
3026// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3027// of the transitive dependencies.
3028func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
3029 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
3030 var staticPaths android.Paths
3031 for _, staticDep := range staticDeps {
3032 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3033 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3034 }
3035 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003036 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3037 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003038 }
3039 }
3040 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3041
3042 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3043
3044 // reorder the dependencies based on transitive dependencies
3045 staticPaths = android.FirstUniquePaths(staticPaths)
3046 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3047
3048 if len(orderedStaticPaths) != len(staticPaths) {
3049 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3050 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3051 }
3052
3053 return orderedStaticPaths, transitiveStaticLibs
3054}
3055
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003056// BaseLibName trims known prefixes and suffixes
3057func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003058 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3059 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003060 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003061 return libName
3062}
3063
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003064func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003065 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003066 ccDepModule, _ := ccDep.(*Module)
3067 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003068 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003069
Justin Yuncbca3732021-02-03 19:24:13 +09003070 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003071 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07003072 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003073 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003074 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003075
Ivan Lozanod1dec542021-05-26 15:33:11 -04003076 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003077 }
3078 }
3079
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003080 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3081 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003082 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3083 // core module instead.
3084 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003085 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003086 // The vendor and product modules in Make will have been renamed to not conflict with the
3087 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003088 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003089 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003090 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003091 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003092 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003093 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003094 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003095 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003096 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003097 } else {
3098 return libName
3099 }
3100}
3101
Colin Crossca860ac2016-01-04 14:34:37 -08003102func (c *Module) InstallInData() bool {
3103 if c.installer == nil {
3104 return false
3105 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003106 return c.installer.inData()
3107}
3108
3109func (c *Module) InstallInSanitizerDir() bool {
3110 if c.installer == nil {
3111 return false
3112 }
3113 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003114 return true
3115 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003116 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003117}
3118
Yifan Hong1b3348d2020-01-21 15:53:22 -08003119func (c *Module) InstallInRamdisk() bool {
3120 return c.InRamdisk()
3121}
3122
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003123func (c *Module) InstallInVendorRamdisk() bool {
3124 return c.InVendorRamdisk()
3125}
3126
Jiyong Parkf9332f12018-02-01 00:54:12 +09003127func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003128 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003129}
3130
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003131func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003132 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003133 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003134 return
3135 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003136 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003137}
3138
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003139func (c *Module) HostToolPath() android.OptionalPath {
3140 if c.installer == nil {
3141 return android.OptionalPath{}
3142 }
3143 return c.installer.hostToolPath()
3144}
3145
Nan Zhangd4e641b2017-07-12 12:55:28 -07003146func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3147 return c.outputFile
3148}
3149
Colin Cross41955e82019-05-29 14:40:35 -07003150func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3151 switch tag {
3152 case "":
3153 if c.outputFile.Valid() {
3154 return android.Paths{c.outputFile.Path()}, nil
3155 }
3156 return android.Paths{}, nil
3157 default:
3158 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003159 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003160}
3161
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003162func (c *Module) static() bool {
3163 if static, ok := c.linker.(interface {
3164 static() bool
3165 }); ok {
3166 return static.static()
3167 }
3168 return false
3169}
3170
Jiyong Park379de2f2018-12-19 02:47:14 +09003171func (c *Module) staticBinary() bool {
3172 if static, ok := c.linker.(interface {
3173 staticBinary() bool
3174 }); ok {
3175 return static.staticBinary()
3176 }
3177 return false
3178}
3179
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003180func (c *Module) testBinary() bool {
3181 if test, ok := c.linker.(interface {
3182 testBinary() bool
3183 }); ok {
3184 return test.testBinary()
3185 }
3186 return false
3187}
3188
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003189func (c *Module) benchmarkBinary() bool {
3190 if b, ok := c.linker.(interface {
3191 benchmarkBinary() bool
3192 }); ok {
3193 return b.benchmarkBinary()
3194 }
3195 return false
3196}
3197
3198func (c *Module) fuzzBinary() bool {
3199 if f, ok := c.linker.(interface {
3200 fuzzBinary() bool
3201 }); ok {
3202 return f.fuzzBinary()
3203 }
3204 return false
3205}
3206
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003207// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3208func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003209 if h, ok := c.linker.(interface {
3210 header() bool
3211 }); ok {
3212 return h.header()
3213 }
3214 return false
3215}
3216
Ivan Lozanod7586b62021-04-01 09:49:36 -04003217func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003218 if b, ok := c.linker.(interface {
3219 binary() bool
3220 }); ok {
3221 return b.binary()
3222 }
3223 return false
3224}
3225
Justin Yun5e035862021-06-29 20:50:37 +09003226func (c *Module) StaticExecutable() bool {
3227 if b, ok := c.linker.(*binaryDecorator); ok {
3228 return b.static()
3229 }
3230 return false
3231}
3232
Ivan Lozanod7586b62021-04-01 09:49:36 -04003233func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003234 if o, ok := c.linker.(interface {
3235 object() bool
3236 }); ok {
3237 return o.object()
3238 }
3239 return false
3240}
3241
Ivan Lozanof9e21722020-12-02 09:00:51 -05003242func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003243 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003244 if c.IsLlndk() {
3245 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003246 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003247 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003248 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003249 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003250 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003251 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003252 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003253 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003254 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003255 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003256 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003257 return "native:product"
3258 }
Jooyung Han38002912019-05-16 04:01:54 +09003259 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003260 } else if c.InRamdisk() {
3261 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003262 } else if c.InVendorRamdisk() {
3263 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003264 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003265 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003266 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003267 return "native:ndk:none:none"
3268 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3269 //family, link := getNdkStlFamilyAndLinkType(c)
3270 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003271 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003272 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003273 } else {
3274 return "native:platform"
3275 }
3276}
3277
Jiyong Park9d452992018-10-03 00:38:19 +09003278// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003279// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003280func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003281 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003282 // Stub libs and prebuilt libs in a versioned SDK are not
3283 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07003284 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01003285 } else if _, ok := c.linker.(testPerSrc); ok {
3286 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003287 }
3288 return false
3289}
3290
Jiyong Parka90ca002019-10-07 15:47:24 +09003291func (c *Module) AvailableFor(what string) bool {
3292 if linker, ok := c.linker.(interface {
3293 availableFor(string) bool
3294 }); ok {
3295 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3296 } else {
3297 return c.ApexModuleBase.AvailableFor(what)
3298 }
3299}
3300
Jiyong Park62304bb2020-04-13 16:19:48 +09003301func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003302 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003303}
3304
Paul Duffin0cb37b92020-03-04 14:52:46 +00003305func (c *Module) EverInstallable() bool {
3306 return c.installer != nil &&
3307 // Check to see whether the module is actually ever installable.
3308 c.installer.everInstallable()
3309}
3310
Ivan Lozanod7586b62021-04-01 09:49:36 -04003311func (c *Module) PreventInstall() bool {
3312 return c.Properties.PreventInstall
3313}
3314
3315func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003316 if c.library != nil {
3317 if i := c.library.installable(); i != nil {
3318 return i
3319 }
3320 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003321 return c.Properties.Installable
3322}
3323
3324func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003325 ret := c.EverInstallable() &&
3326 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003327 proptools.BoolDefault(c.Installable(), true) &&
3328 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003329
3330 // The platform variant doesn't need further condition. Apex variants however might not
3331 // be installable because it will likely to be included in the APEX and won't appear
3332 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003333 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003334 return ret
3335 }
3336
3337 // Special case for modules that are configured to be installed to /data, which includes
3338 // test modules. For these modules, both APEX and non-APEX variants are considered as
3339 // installable. This is because even the APEX variants won't be included in the APEX, but
3340 // will anyway be installed to /data/*.
3341 // See b/146995717
3342 if c.InstallInData() {
3343 return ret
3344 }
3345
3346 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003347}
3348
Logan Chien41eabe62019-04-10 13:33:58 +08003349func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3350 if c.linker != nil {
3351 if library, ok := c.linker.(*libraryDecorator); ok {
3352 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3353 }
3354 }
3355}
3356
Jiyong Park45bf82e2020-12-15 22:29:02 +09003357var _ android.ApexModule = (*Module)(nil)
3358
3359// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003360func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003361 depTag := ctx.OtherModuleDependencyTag(dep)
3362 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3363
3364 if cc, ok := dep.(*Module); ok {
3365 if cc.HasStubsVariants() {
3366 if isLibDepTag && libDepTag.shared() {
3367 // dynamic dep to a stubs lib crosses APEX boundary
3368 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003369 }
Colin Cross6e511a92020-07-27 21:26:48 -07003370 if IsRuntimeDepTag(depTag) {
3371 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003372 return false
3373 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003374 }
Zhijun Heec285872021-04-24 10:47:08 -07003375 if cc.IsLlndk() {
3376 return false
3377 }
Colin Crossaac32222020-07-29 12:51:56 -07003378 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003379 // shared_lib dependency from a static lib is considered as crossing
3380 // the APEX boundary because the dependency doesn't actually is
3381 // linked; the dependency is used only during the compilation phase.
3382 return false
3383 }
Jiyong Parke3867542020-12-03 17:28:25 +09003384
3385 if isLibDepTag && libDepTag.excludeInApex {
3386 return false
3387 }
Colin Cross6e511a92020-07-27 21:26:48 -07003388 }
Colin Crossc1b36442021-05-06 13:42:48 -07003389 if depTag == stubImplDepTag {
3390 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003391 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003392 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003393 if depTag == staticVariantTag {
3394 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3395 // actually mean that the static lib (and its dependencies) are copied into the
3396 // APEX.
3397 return false
3398 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003399 return true
3400}
3401
Jiyong Park45bf82e2020-12-15 22:29:02 +09003402// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003403func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3404 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003405 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3406 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3407 return nil
3408 }
3409 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3410 if c.ToolchainLibrary() {
3411 return nil
3412 }
3413 // We don't check for prebuilt modules
3414 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3415 return nil
3416 }
3417 minSdkVersion := c.MinSdkVersion()
3418 if minSdkVersion == "apex_inherit" {
3419 return nil
3420 }
3421 if minSdkVersion == "" {
3422 // JNI libs within APK-in-APEX fall into here
3423 // Those are okay to set sdk_version instead
3424 // We don't have to check if this is a SDK variant because
3425 // non-SDK variant resets sdk_version, which works too.
3426 minSdkVersion = c.SdkVersion()
3427 }
Dan Albertc8060532020-07-22 22:32:17 -07003428 if minSdkVersion == "" {
3429 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3430 }
3431 // Not using nativeApiLevelFromUser because the context here is not
3432 // necessarily a native context.
3433 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003434 if err != nil {
3435 return err
3436 }
Dan Albertc8060532020-07-22 22:32:17 -07003437
3438 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003439 return fmt.Errorf("newer SDK(%v)", ver)
3440 }
3441 return nil
3442}
3443
Paul Duffinb5769c12021-05-12 16:16:51 +01003444// Implements android.ApexModule
3445func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3446 // stub libraries and native bridge libraries are always available to platform
3447 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3448}
3449
Rob Seymour925aa092021-08-10 20:42:03 +00003450var _ snapshot.RelativeInstallPath = (*Module)(nil)
3451
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003452// ConvertWithBp2build converts Module to Bazel for bp2build.
3453func (c *Module) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
Liz Kammerbdc922f2021-12-14 14:21:21 -05003454 prebuilt := c.IsPrebuilt()
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003455 if c.Binary() {
Liz Kammerbdc922f2021-12-14 14:21:21 -05003456 if !prebuilt {
3457 binaryBp2build(ctx, c, ctx.ModuleType())
3458 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003459 } else if c.Object() {
Liz Kammerbdc922f2021-12-14 14:21:21 -05003460 if !prebuilt {
3461 objectBp2Build(ctx, c)
3462 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003463 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05003464 static := false
3465 shared := false
3466 if library, ok := c.linker.(*libraryDecorator); ok {
3467 static = library.MutatedProperties.BuildStatic
3468 shared = library.MutatedProperties.BuildShared
3469 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
3470 static = library.MutatedProperties.BuildStatic
3471 shared = library.MutatedProperties.BuildShared
3472 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003473
3474 if static && shared {
Liz Kammerbdc922f2021-12-14 14:21:21 -05003475 if !prebuilt {
3476 libraryBp2Build(ctx, c)
3477 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003478 } else if !static && !shared {
Liz Kammer3d3b35c2022-01-11 16:02:50 +00003479 libraryHeadersBp2Build(ctx, c)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003480 } else if static {
3481 if prebuilt {
3482 prebuiltLibraryStaticBp2Build(ctx, c)
3483 } else {
3484 sharedOrStaticLibraryBp2Build(ctx, c, true)
3485 }
3486 } else if shared {
3487 if prebuilt {
3488 prebuiltLibrarySharedBp2Build(ctx, c)
3489 } else {
3490 sharedOrStaticLibraryBp2Build(ctx, c, false)
3491 }
3492 }
3493 }
3494}
3495
Colin Cross2ba19d92015-05-07 15:44:20 -07003496//
Colin Crosscfad1192015-11-02 16:43:11 -08003497// Defaults
3498//
Colin Crossca860ac2016-01-04 14:34:37 -08003499type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003500 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003501 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003502 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003503}
3504
Patrice Arrudac249c712019-03-19 17:00:29 -07003505// cc_defaults provides a set of properties that can be inherited by other cc
3506// modules. A module can use the properties from a cc_defaults using
3507// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3508// merged (when possible) by prepending the default module's values to the
3509// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003510func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003511 return DefaultsFactory()
3512}
3513
Colin Cross36242852017-06-23 15:06:31 -07003514func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003515 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003516
Colin Cross36242852017-06-23 15:06:31 -07003517 module.AddProperties(props...)
3518 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003519 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003520 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003521 &BaseCompilerProperties{},
3522 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003523 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003524 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003525 &StaticProperties{},
3526 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003527 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003528 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003529 &TestProperties{},
3530 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003531 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07003532 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003533 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003534 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003535 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003536 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003537 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003538 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003539 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003540 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003541 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003542 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003543 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003544 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3545 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07003546 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003547 )
Colin Crosscfad1192015-11-02 16:43:11 -08003548
Jooyung Hancc372c52019-09-25 15:18:44 +09003549 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003550
3551 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003552}
3553
Jiyong Park2286afd2020-06-16 21:58:53 +09003554func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003555 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003556}
3557
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003558func kytheExtractAllFactory() android.Singleton {
3559 return &kytheExtractAllSingleton{}
3560}
3561
3562type kytheExtractAllSingleton struct {
3563}
3564
3565func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3566 var xrefTargets android.Paths
3567 ctx.VisitAllModules(func(module android.Module) {
3568 if ccModule, ok := module.(xref); ok {
3569 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3570 }
3571 })
3572 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3573 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003574 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003575 }
3576}
3577
Colin Cross06a931b2015-10-28 17:23:31 -07003578var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003579var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003580var BoolPtr = proptools.BoolPtr
3581var String = proptools.String
3582var StringPtr = proptools.StringPtr