blob: afc96bacb324eb9a7f12b7220d5c07e181e4083d [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"
Colin Cross5049f022015-03-18 13:28:46 -070032 "android/soong/genrule"
Colin Cross3f40fa42015-01-30 17:27:36 -080033)
34
Colin Cross463a90e2015-06-17 14:20:06 -070035func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000036 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070037
Paul Duffin036e7002019-12-19 19:16:28 +000038 pctx.Import("android/soong/cc/config")
39}
40
41func RegisterCCBuildComponents(ctx android.RegistrationContext) {
42 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
43
44 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000045 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090046 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070047 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010048 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070049 ctx.BottomUp("version_selector", versionSelectorMutator).Parallel()
50 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070051 ctx.BottomUp("begin", BeginMutator).Parallel()
Inseob Kimac1e9862019-12-09 18:15:47 +090052 ctx.BottomUp("sysprop_cc", SyspropMutator).Parallel()
Inseob Kimeec88e12020-01-22 11:11:29 +090053 ctx.BottomUp("vendor_snapshot", VendorSnapshotMutator).Parallel()
54 ctx.BottomUp("vendor_snapshot_source", VendorSnapshotSourceMutator).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) {
Colin Cross1e676be2016-10-12 14:38:15 -070058 ctx.TopDown("asan_deps", sanitizerDepsMutator(asan))
59 ctx.BottomUp("asan", sanitizerMutator(asan)).Parallel()
Colin Cross16b23492016-01-06 14:41:07 -080060
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070061 ctx.TopDown("hwasan_deps", sanitizerDepsMutator(hwasan))
62 ctx.BottomUp("hwasan", sanitizerMutator(hwasan)).Parallel()
63
Mitch Phillipsbfeade62019-05-01 14:42:05 -070064 ctx.TopDown("fuzzer_deps", sanitizerDepsMutator(fuzzer))
65 ctx.BottomUp("fuzzer", sanitizerMutator(fuzzer)).Parallel()
66
Jiyong Park1d1119f2019-07-29 21:27:18 +090067 // cfi mutator shouldn't run before sanitizers that return true for
68 // incompatibleWithCfi()
Vishwath Mohanb743e9c2017-11-01 09:20:21 +000069 ctx.TopDown("cfi_deps", sanitizerDepsMutator(cfi))
70 ctx.BottomUp("cfi", sanitizerMutator(cfi)).Parallel()
71
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -080072 ctx.TopDown("scs_deps", sanitizerDepsMutator(scs))
73 ctx.BottomUp("scs", sanitizerMutator(scs)).Parallel()
74
Colin Cross1e676be2016-10-12 14:38:15 -070075 ctx.TopDown("tsan_deps", sanitizerDepsMutator(tsan))
76 ctx.BottomUp("tsan", sanitizerMutator(tsan)).Parallel()
Dan Willemsen581341d2017-02-09 16:16:31 -080077
Colin Cross0b908332019-06-19 23:00:20 -070078 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090079 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080080
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080081 ctx.BottomUp("coverage", coverageMutator).Parallel()
Stephen Craneba090d12017-05-09 15:44:35 -070082
83 ctx.TopDown("lto_deps", ltoDepsMutator)
84 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090085
Jooyung Han479ca172020-10-19 18:51:07 +090086 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090087 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070088 })
Colin Crossb98c8b02016-07-29 13:44:28 -070089
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080090 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
91 // sabi mutator needs to be run after apex mutator finishes.
92 ctx.TopDown("sabi_deps", sabiDepsMutator)
93 })
94
Colin Cross57898582020-10-29 18:25:19 -070095 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070096}
97
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050098// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
99// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
100// edges to these modules.
101// This object is constructed in DepsMutator, by calling to various module delegates to set
102// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
103// dependencies.
104// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
105// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800106type Deps struct {
107 SharedLibs, LateSharedLibs []string
108 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800109 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800110 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700111
Chris Parsons79d66a52020-06-05 17:26:16 -0400112 // Used for data dependencies adjacent to tests
113 DataLibs []string
114
Yo Chiang219968c2020-09-22 18:45:04 +0800115 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
116 SystemSharedLibs []string
117
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500118 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800119 StaticUnwinderIfLegacy bool
120
Colin Cross5950f382016-12-13 12:50:57 -0800121 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700122
Colin Cross81413472016-04-11 14:37:39 -0700123 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700124
Dan Willemsenb40aab62016-04-20 14:21:14 -0700125 GeneratedSources []string
126 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900127 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700128
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700129 ReexportGeneratedHeaders []string
130
Colin Cross97ba0732015-03-23 17:50:24 -0700131 CrtBegin, CrtEnd string
Dan Willemsena0790e32018-10-12 00:24:23 -0700132
133 // Used for host bionic
134 LinkerFlagsFile string
135 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900136
137 // List of libs that need to be excluded for APEX variant
138 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700139}
140
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500141// PathDeps is a struct containing file paths to dependencies of a module.
142// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
143// It's used to construct flags for various build statements (such as for compiling and linking).
144// It is then passed to module decorator functions responsible for registering build statements
145// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800146type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700147 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900148 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700149 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900150 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700151 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700152 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700153
Colin Cross0de8a1e2020-09-18 14:15:30 -0700154 // Transitive static library dependencies of static libraries for use in ordering.
155 TranstiveStaticLibrariesForOrdering *android.DepSet
156
Colin Cross26c34ed2016-09-30 17:10:16 -0700157 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100158 Objs Objects
159 // Paths to .o files in dependencies that provide them. Note that these lists
160 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800161 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700162 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700163
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100164 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
165 // the libs from all whole_static_lib dependencies.
166 WholeStaticLibsFromPrebuilts android.Paths
167
Colin Cross26c34ed2016-09-30 17:10:16 -0700168 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700169 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900170 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700171
Inseob Kimd110f872019-12-06 13:15:38 +0900172 Flags []string
173 IncludeDirs android.Paths
174 SystemIncludeDirs android.Paths
175 ReexportedDirs android.Paths
176 ReexportedSystemDirs android.Paths
177 ReexportedFlags []string
178 ReexportedGeneratedHeaders android.Paths
179 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700180
Colin Cross26c34ed2016-09-30 17:10:16 -0700181 // Paths to crt*.o files
Colin Cross635c3b02016-05-18 15:37:25 -0700182 CrtBegin, CrtEnd android.OptionalPath
Dan Willemsena0790e32018-10-12 00:24:23 -0700183
184 // Path to the file container flags to use with the linker
185 LinkerFlagsFile android.OptionalPath
186
187 // Path to the dynamic linker binary
188 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700189}
190
Colin Cross4af21ed2019-11-04 09:37:55 -0800191// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
192// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
193// command line so they can be overridden by the local module flags).
194type LocalOrGlobalFlags struct {
195 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700196 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800197 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700198 CFlags []string // Flags that apply to C and C++ source files
199 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
200 ConlyFlags []string // Flags that apply to C source files
201 CppFlags []string // Flags that apply to C++ source files
202 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700203 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800204}
205
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500206// Flags contains various types of command line flags (and settings) for use in building build
207// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800208type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500209 // Local flags (which individual modules are responsible for). These may override global flags.
210 Local LocalOrGlobalFlags
211 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800212 Global LocalOrGlobalFlags
213
214 aidlFlags []string // Flags that apply to aidl source files
215 rsFlags []string // Flags that apply to renderscript source files
216 libFlags []string // Flags to add libraries early to the link order
217 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
218 TidyFlags []string // Flags that apply to clang-tidy
219 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700220
Colin Crossc3199482017-03-30 15:03:04 -0700221 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800222 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700223 SystemIncludeFlags []string
224
Oliver Nguyen04526782020-04-21 12:40:27 -0700225 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500226 Tidy bool // True if clang-tidy is enabled.
227 GcovCoverage bool // True if coverage files should be generated.
228 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700229 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800230
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500231 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800232 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500233 // The target-device system path to the dynamic linker.
234 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800235
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700236 CFlagsDeps android.Paths // Files depended on by compiler flags
237 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800238
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500239 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700240 AssemblerWithCpp bool
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500241 // True if static libraries should be grouped (using `-Wl,--start-group` and `-Wl,--end-group`).
242 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800243
Colin Cross19878da2019-03-28 14:45:07 -0700244 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700245 protoC bool // Whether to use C instead of C++
246 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700247
248 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200249 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700250}
251
Colin Crossca860ac2016-01-04 14:34:37 -0800252// Properties used to compile all C or C++ modules
253type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700254 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800255 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700256
Colin Crossc511bc52020-04-07 16:50:32 +0000257 // Minimum sdk version supported when compiling against the ndk. Setting this property causes
258 // two variants to be built, one for the platform and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800259 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700260
Jooyung Han379660c2020-04-21 15:24:00 +0900261 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
262 Min_sdk_version *string
263
Colin Crossc511bc52020-04-07 16:50:32 +0000264 // If true, always create an sdk variant and don't create a platform variant.
265 Sdk_variant_only *bool
266
Jiyong Parkde866cb2018-12-07 23:08:36 +0900267 AndroidMkSharedLibs []string `blueprint:"mutated"`
268 AndroidMkStaticLibs []string `blueprint:"mutated"`
269 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
270 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700271 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900272 HideFromMake bool `blueprint:"mutated"`
273 PreventInstall bool `blueprint:"mutated"`
274 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700275
Yo Chiang219968c2020-09-22 18:45:04 +0800276 // Set by DepsMutator.
277 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
278
Justin Yun5f7f7e82019-11-18 19:52:14 +0900279 ImageVariationPrefix string `blueprint:"mutated"`
280 VndkVersion string `blueprint:"mutated"`
281 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800282
283 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
284 // file
285 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900286
Yifan Hong39143a92020-10-26 12:43:12 -0700287 // Make this module available when building for ramdisk.
288 // On device without a dedicated recovery partition, the module is only
289 // available after switching root into
290 // /first_stage_ramdisk. To expose the module before switching root, install
291 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800292 Ramdisk_available *bool
293
Yifan Hong39143a92020-10-26 12:43:12 -0700294 // Make this module available when building for vendor ramdisk.
295 // On device without a dedicated recovery partition, the module is only
296 // available after switching root into
297 // /first_stage_ramdisk. To expose the module before switching root, install
298 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700299 Vendor_ramdisk_available *bool
300
Jiyong Parkf9332f12018-02-01 00:54:12 +0900301 // Make this module available when building for recovery
302 Recovery_available *bool
303
Colin Crossae6c5202019-11-20 13:35:50 -0800304 // Set by imageMutator
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700305 CoreVariantNeeded bool `blueprint:"mutated"`
306 RamdiskVariantNeeded bool `blueprint:"mutated"`
307 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
308 RecoveryVariantNeeded bool `blueprint:"mutated"`
309 ExtraVariants []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900310
311 // Allows this module to use non-APEX version of libraries. Useful
312 // for building binaries that are started before APEXes are activated.
313 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900314
315 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
316 // see soong/cc/config/vndk.go
317 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900318
319 // Used by vendor snapshot to record dependencies from snapshot modules.
320 SnapshotSharedLibs []string `blueprint:"mutated"`
321 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000322
323 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000324
325 // Set by factories of module types that can only be referenced from variants compiled against
326 // the SDK.
327 AlwaysSdk bool `blueprint:"mutated"`
328
329 // Variant is an SDK variant created by sdkMutator
330 IsSdkVariant bool `blueprint:"mutated"`
331 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
332 // variant to have a ".sdk" suffix.
333 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700334
335 // Normally Soong uses the directory structure to decide which modules
336 // should be included (framework) or excluded (non-framework) from the
Jose Galmesf7294582020-11-13 12:07:36 -0800337 // different snapshots (vendor, recovery, etc.), but these properties
338 // allow a partner to exclude a module normally thought of as a
339 // framework module from a snapshot.
340 Exclude_from_vendor_snapshot *bool
341 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900342
343 // List of APEXes that this module has private access to for testing purpose. The module
344 // can depend on libraries that are not exported by the APEXes and use private symbols
345 // from the exported libraries.
346 Test_for []string
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700347}
348
349type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900350 // whether this module should be allowed to be directly depended by other
351 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900352 // If set to true, two variants will be built separately, one like
353 // normal, and the other limited to the set of libraries and headers
354 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700355 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900356 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700357 // so it shouldn't have any unversioned runtime dependencies, or
358 // make assumptions about the system that may not be true in the
359 // future.
360 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900361 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900362 //
363 // Default value is true when vndk: {enabled: true} or vendor: true.
364 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700365 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
366 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900367
Justin Yun63e9ec72020-10-29 16:49:43 +0900368 // whether this module should be allowed to be directly depended by other
369 // modules with `product_specific: true` or `product_available: true`.
370 // If set to true, an additional product variant will be built separately
371 // that is limited to the set of libraries and headers that are exposed to
372 // /product modules.
373 //
374 // The product variant may be used with a different (newer) /system,
375 // so it shouldn't have any unversioned runtime dependencies, or
376 // make assumptions about the system that may not be true in the
377 // future.
378 //
379 // It must be set to true by default for vndk: {enabled: true} modules.
380 //
381 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
382 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
383 Product_available *bool
384
Jiyong Park5fb8c102018-04-09 12:03:06 +0900385 // whether this module is capable of being loaded with other instance
386 // (possibly an older version) of the same module in the same process.
387 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
388 // can be double loaded in a vendor process if the library is also a
389 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
390 // explicitly marked as `double_loadable: true` by the owner, or the dependency
391 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
392 Double_loadable *bool
Colin Crossca860ac2016-01-04 14:34:37 -0800393}
394
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500395// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
396// to understanding details about the type of the current module.
397// For example, one might call these functions to determine whether the current module is a static
398// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800399type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800400 static() bool
401 staticBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900402 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900403 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900404 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700405 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900406 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700407 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800408 sdkVersion() string
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700409 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700410 isNdk(config android.Config) bool
Inseob Kim9516ee92019-05-09 10:56:13 +0900411 isLlndk(config android.Config) bool
412 isLlndkPublic(config android.Config) bool
413 isVndkPrivate(config android.Config) bool
Justin Yun8effde42017-06-23 19:24:43 +0900414 isVndk() bool
415 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500416 IsVndkExt() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900417 inProduct() bool
418 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800419 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700420 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900421 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700422 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700423 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800424 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800425 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800426 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800427 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800428 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700429 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700430 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900431 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800432 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700433 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700434 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800435 isPreventInstall() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800436}
437
438type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700439 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800440 ModuleContextIntf
441}
442
443type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700444 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800445 ModuleContextIntf
446}
447
Colin Cross37047f12016-12-13 17:06:13 -0800448type DepsContext interface {
449 android.BottomUpMutatorContext
450 ModuleContextIntf
451}
452
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500453// feature represents additional (optional) steps to building cc-related modules, such as invocation
454// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800455type feature interface {
456 begin(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800457 deps(ctx DepsContext, deps Deps) Deps
Colin Crossca860ac2016-01-04 14:34:37 -0800458 flags(ctx ModuleContext, flags Flags) Flags
459 props() []interface{}
460}
461
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500462// compiler is the interface for a compiler helper object. Different module decorators may implement
463// this helper differently. For example, compiling a `cc_library` may use a different build
464// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800465type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700466 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800467 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800468 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700469 compilerProps() []interface{}
470
Colin Cross76fada02016-07-27 10:31:13 -0700471 appendCflags([]string)
472 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700473 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800474}
475
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500476// linker is the interface for a linker decorator object. Individual module types can provide
477// their own implementation for this decorator, and thus specify custom logic regarding build
478// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800479type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700480 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800481 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700482 linkerFlags(ctx ModuleContext, flags Flags) Flags
483 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800484 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700485
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700486 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700487 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900488 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700489
490 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900491 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000492
493 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000494 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
495}
496
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500497// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000498type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500499 sharedLibs []string
500 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
501 // libc, libm, etc.)
502 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800503}
504
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500505// installer is the interface for an installer helper object. This helper is responsible for
506// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800507type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700508 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700509 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000510 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800511 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700512 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700513 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900514 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100515 makeUninstallable(mod *Module)
Colin Crossca860ac2016-01-04 14:34:37 -0800516}
517
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800518type xref interface {
519 XrefCcFiles() android.Paths
520}
521
Colin Cross6e511a92020-07-27 21:26:48 -0700522type libraryDependencyKind int
523
524const (
525 headerLibraryDependency = iota
526 sharedLibraryDependency
527 staticLibraryDependency
528)
529
530func (k libraryDependencyKind) String() string {
531 switch k {
532 case headerLibraryDependency:
533 return "headerLibraryDependency"
534 case sharedLibraryDependency:
535 return "sharedLibraryDependency"
536 case staticLibraryDependency:
537 return "staticLibraryDependency"
538 default:
539 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
540 }
541}
542
543type libraryDependencyOrder int
544
545const (
546 earlyLibraryDependency = -1
547 normalLibraryDependency = 0
548 lateLibraryDependency = 1
549)
550
551func (o libraryDependencyOrder) String() string {
552 switch o {
553 case earlyLibraryDependency:
554 return "earlyLibraryDependency"
555 case normalLibraryDependency:
556 return "normalLibraryDependency"
557 case lateLibraryDependency:
558 return "lateLibraryDependency"
559 default:
560 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
561 }
562}
563
564// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
565// tags that have a set of predefined tag objects that are reused for each dependency, a
566// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
567// That means that comparing a libraryDependencyTag for equality will only be equal if all
568// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
569// then check individual metadata fields instead.
570type libraryDependencyTag struct {
571 blueprint.BaseDependencyTag
572
573 // These are exported so that fmt.Printf("%#v") can call their String methods.
574 Kind libraryDependencyKind
575 Order libraryDependencyOrder
576
577 wholeStatic bool
578
579 reexportFlags bool
580 explicitlyVersioned bool
581 dataLib bool
582 ndk bool
583
584 staticUnwinder bool
585
586 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900587
588 // Whether or not this dependency has to be followed for the apex variants
589 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700590}
591
592// header returns true if the libraryDependencyTag is tagging a header lib dependency.
593func (d libraryDependencyTag) header() bool {
594 return d.Kind == headerLibraryDependency
595}
596
597// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
598func (d libraryDependencyTag) shared() bool {
599 return d.Kind == sharedLibraryDependency
600}
601
602// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
603func (d libraryDependencyTag) static() bool {
604 return d.Kind == staticLibraryDependency
605}
606
Colin Crosse9fe2942020-11-10 18:12:15 -0800607// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
608// binaries or other shared libraries are installed as dependencies.
609func (d libraryDependencyTag) InstallDepNeeded() bool {
610 return d.shared()
611}
612
613var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
614
615// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700616// libraryDependencyTag. Each tag object is created globally and reused for multiple
617// dependencies (although since the object contains no references, assigning a tag to a
618// variable and modifying it will not modify the original). Users can compare the tag
619// returned by ctx.OtherModuleDependencyTag against the global original
620type dependencyTag struct {
621 blueprint.BaseDependencyTag
622 name string
623}
624
Colin Crosse9fe2942020-11-10 18:12:15 -0800625// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
626// libraryDependencyTag, but where the dependency needs to be installed when the parent is
627// installed.
628type installDependencyTag struct {
629 blueprint.BaseDependencyTag
630 android.InstallAlwaysNeededDependencyTag
631 name string
632}
633
Colin Crossc99deeb2016-04-11 15:06:20 -0700634var (
Colin Cross6e511a92020-07-27 21:26:48 -0700635 genSourceDepTag = dependencyTag{name: "gen source"}
636 genHeaderDepTag = dependencyTag{name: "gen header"}
637 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
638 objDepTag = dependencyTag{name: "obj"}
639 linkerFlagsDepTag = dependencyTag{name: "linker flags file"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900640 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700641 reuseObjTag = dependencyTag{name: "reuse objects"}
642 staticVariantTag = dependencyTag{name: "static variant"}
643 vndkExtDepTag = dependencyTag{name: "vndk extends"}
644 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800645 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700646 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700647 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700648)
649
Colin Cross56a83212020-09-15 18:30:11 -0700650type copyDirectlyInAnyApexDependencyTag dependencyTag
651
652func (copyDirectlyInAnyApexDependencyTag) CopyDirectlyInAnyApex() {}
653
654var _ android.CopyDirectlyInAnyApexTag = copyDirectlyInAnyApexDependencyTag{}
655
Roland Levillainf89cd092019-07-29 16:22:59 +0100656func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700657 ccLibDepTag, ok := depTag.(libraryDependencyTag)
658 return ok && ccLibDepTag.shared()
659}
660
661func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
662 ccLibDepTag, ok := depTag.(libraryDependencyTag)
663 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100664}
665
Zach Johnson3df4e632020-11-06 11:56:27 -0800666func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
667 ccLibDepTag, ok := depTag.(libraryDependencyTag)
668 return ok && ccLibDepTag.header()
669}
670
Roland Levillainf89cd092019-07-29 16:22:59 +0100671func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800672 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100673}
674
675func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700676 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100677 return ok && ccDepTag == testPerSrcDepTag
678}
679
Colin Crossca860ac2016-01-04 14:34:37 -0800680// Module contains the properties and members used by all C/C++ module types, and implements
681// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500682// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
683// interface.
684//
685// To define a C/C++ related module, construct a new Module object and point its delegates to
686// type-specific structs. These delegates will be invoked to register module-specific build
687// statements which may be unique to the module type. For example, module.compiler.compile() should
688// be defined so as to register build statements which are responsible for compiling the module.
689//
690// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
691// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
692// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
693// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800694type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700695 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700696 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900697 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900698 android.SdkBase
Colin Crossc472d572015-03-17 15:06:21 -0700699
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700700 Properties BaseProperties
701 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700702
Colin Crossca860ac2016-01-04 14:34:37 -0800703 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700704 hod android.HostOrDeviceSupported
705 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700706
Paul Duffina0843f62019-12-13 19:50:38 +0000707 // Allowable SdkMemberTypes of this module type.
708 sdkMemberTypes []android.SdkMemberType
709
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500710 // decorator delegates, initialize before calling Init
711 // these may contain module-specific implementations, and effectively allow for custom
712 // type-specific logic. These members may reference different objects or the same object.
713 // Functions of these decorators will be invoked to initialize and register type-specific
714 // build statements.
Colin Crossb4ce0ec2016-09-13 13:41:39 -0700715 compiler compiler
716 linker linker
717 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500718
719 features []feature
720 stl *stl
721 sanitize *sanitize
722 coverage *coverage
723 sabi *sabi
724 vndkdep *vndkdep
725 lto *lto
726 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800727
Colin Cross31076b32020-10-23 17:22:06 -0700728 library libraryInterface
729
Colin Cross635c3b02016-05-18 15:37:25 -0700730 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800731
Colin Crossb98c8b02016-07-29 13:44:28 -0700732 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700733
734 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800735
736 // Flags used to compile this module
737 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700738
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800739 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700740 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900741
742 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800743 // Kythe (source file indexer) paths for this compilation module
744 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900745
746 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700747 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700748
749 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700750}
751
Ivan Lozano52767be2019-10-18 14:49:46 -0700752func (c *Module) Toc() android.OptionalPath {
753 if c.linker != nil {
754 if library, ok := c.linker.(libraryInterface); ok {
755 return library.toc()
756 }
757 }
758 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
759}
760
761func (c *Module) ApiLevel() string {
762 if c.linker != nil {
763 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700764 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700765 }
766 }
767 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
768}
769
770func (c *Module) Static() bool {
771 if c.linker != nil {
772 if library, ok := c.linker.(libraryInterface); ok {
773 return library.static()
774 }
775 }
776 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
777}
778
779func (c *Module) Shared() bool {
780 if c.linker != nil {
781 if library, ok := c.linker.(libraryInterface); ok {
782 return library.shared()
783 }
784 }
785 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
786}
787
788func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000789 if c.stl != nil {
790 return c.stl.Properties.SelectedStl
791 }
792 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700793}
794
795func (c *Module) ToolchainLibrary() bool {
796 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
797 return true
798 }
799 return false
800}
801
802func (c *Module) NdkPrebuiltStl() bool {
803 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
804 return true
805 }
806 return false
807}
808
809func (c *Module) StubDecorator() bool {
810 if _, ok := c.linker.(*stubDecorator); ok {
811 return true
812 }
813 return false
814}
815
816func (c *Module) SdkVersion() string {
817 return String(c.Properties.Sdk_version)
818}
819
Artur Satayev480e25b2020-04-27 18:53:18 +0100820func (c *Module) MinSdkVersion() string {
821 return String(c.Properties.Min_sdk_version)
822}
823
Dan Albert92fe7402020-07-15 13:33:30 -0700824func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700825 if !c.canUseSdk() {
826 return false
827 }
Dan Albert92fe7402020-07-15 13:33:30 -0700828 if linker, ok := c.linker.(*objectLinker); ok {
829 return linker.isCrt()
830 }
831 return false
832}
833
Colin Crossc511bc52020-04-07 16:50:32 +0000834func (c *Module) AlwaysSdk() bool {
835 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
836}
837
Ivan Lozano183a3212019-10-18 14:18:45 -0700838func (c *Module) CcLibrary() bool {
839 if c.linker != nil {
840 if _, ok := c.linker.(*libraryDecorator); ok {
841 return true
842 }
Colin Crossd48fe732020-09-23 20:37:24 -0700843 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
844 return true
845 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700846 }
847 return false
848}
849
850func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700851 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700852 return true
853 }
854 return false
855}
856
Ivan Lozano2b262972019-11-21 12:30:50 -0800857func (c *Module) NonCcVariants() bool {
858 return false
859}
860
Ivan Lozano183a3212019-10-18 14:18:45 -0700861func (c *Module) SetStatic() {
862 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700863 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700864 library.setStatic()
865 return
866 }
867 }
868 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
869}
870
871func (c *Module) SetShared() {
872 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700873 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700874 library.setShared()
875 return
876 }
877 }
878 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
879}
880
881func (c *Module) BuildStaticVariant() bool {
882 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700883 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700884 return library.buildStatic()
885 }
886 }
887 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
888}
889
890func (c *Module) BuildSharedVariant() bool {
891 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700892 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700893 return library.buildShared()
894 }
895 }
896 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
897}
898
899func (c *Module) Module() android.Module {
900 return c
901}
902
Jiyong Parkc20eee32018-09-05 22:36:17 +0900903func (c *Module) OutputFile() android.OptionalPath {
904 return c.outputFile
905}
906
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400907func (c *Module) CoverageFiles() android.Paths {
908 if c.linker != nil {
909 if library, ok := c.linker.(libraryInterface); ok {
910 return library.objs().coverageFiles
911 }
912 }
913 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
914}
915
Ivan Lozano183a3212019-10-18 14:18:45 -0700916var _ LinkableInterface = (*Module)(nil)
917
Jiyong Park719b4462019-01-13 00:39:51 +0900918func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900919 if c.linker != nil {
920 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +0900921 }
922 return nil
923}
924
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900925func (c *Module) CoverageOutputFile() android.OptionalPath {
926 if c.linker != nil {
927 return c.linker.coverageOutputFilePath()
928 }
929 return android.OptionalPath{}
930}
931
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900932func (c *Module) RelativeInstallPath() string {
933 if c.installer != nil {
934 return c.installer.relativeInstallPath()
935 }
936 return ""
937}
938
Jooyung Han344d5432019-08-23 11:17:39 +0900939func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +0900940 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +0900941}
942
Colin Cross36242852017-06-23 15:06:31 -0700943func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -0700944 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -0800945 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -0700946 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800947 }
948 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -0700949 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800950 }
951 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -0700952 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800953 }
Colin Crossa8e07cc2016-04-04 15:07:06 -0700954 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -0700955 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -0700956 }
Colin Cross16b23492016-01-06 14:41:07 -0800957 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -0700958 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -0800959 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800960 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -0700961 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -0800962 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800963 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -0700964 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800965 }
Justin Yun8effde42017-06-23 19:24:43 +0900966 if c.vndkdep != nil {
967 c.AddProperties(c.vndkdep.props()...)
968 }
Stephen Craneba090d12017-05-09 15:44:35 -0700969 if c.lto != nil {
970 c.AddProperties(c.lto.props()...)
971 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700972 if c.pgo != nil {
973 c.AddProperties(c.pgo.props()...)
974 }
Colin Crossca860ac2016-01-04 14:34:37 -0800975 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -0700976 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800977 }
Colin Crossc472d572015-03-17 15:06:21 -0700978
Jiyong Park1613e552020-09-14 19:43:17 +0900979 c.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, os android.OsType) bool {
Elliott Hughes79ae3412020-04-17 15:49:49 -0700980 // Windows builds always prefer 32-bit
Jiyong Park1613e552020-09-14 19:43:17 +0900981 return os == android.Windows
Colin Crossa9d8bee2018-10-02 13:59:46 -0700982 })
Colin Cross36242852017-06-23 15:06:31 -0700983 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +0900984 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900985 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +0900986 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +0900987
Colin Cross36242852017-06-23 15:06:31 -0700988 return c
Colin Crossc472d572015-03-17 15:06:21 -0700989}
990
Colin Crossb916a382016-07-29 17:28:03 -0700991// Returns true for dependency roots (binaries)
992// TODO(ccross): also handle dlopenable libraries
993func (c *Module) isDependencyRoot() bool {
994 if root, ok := c.linker.(interface {
995 isDependencyRoot() bool
996 }); ok {
997 return root.isDependencyRoot()
998 }
999 return false
1000}
1001
Justin Yun5f7f7e82019-11-18 19:52:14 +09001002// Returns true if the module is using VNDK libraries instead of the libraries in /system/lib or /system/lib64.
1003// "product" and "vendor" variant modules return true for this function.
1004// When BOARD_VNDK_VERSION is set, vendor variants of "vendor_available: true", "vendor: true",
1005// "soc_specific: true" and more vendor installed modules are included here.
Justin Yun63e9ec72020-10-29 16:49:43 +09001006// When PRODUCT_PRODUCT_VNDK_VERSION is set, product variants of "product_available: true" or
Justin Yun5f7f7e82019-11-18 19:52:14 +09001007// "product_specific: true" modules are included here.
Ivan Lozano52767be2019-10-18 14:49:46 -07001008func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001009 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001010}
1011
Colin Crossc511bc52020-04-07 16:50:32 +00001012func (c *Module) canUseSdk() bool {
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001013 return c.Os() == android.Android && !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001014}
1015
1016func (c *Module) UseSdk() bool {
1017 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001018 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001019 }
1020 return false
1021}
1022
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001023func (c *Module) isCoverageVariant() bool {
1024 return c.coverage.Properties.IsCoverageVariant
1025}
1026
Colin Cross95f1ca02020-10-29 20:47:22 -07001027func (c *Module) IsNdk(config android.Config) bool {
1028 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001029}
1030
Inseob Kim9516ee92019-05-09 10:56:13 +09001031func (c *Module) isLlndk(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001032 // Returns true for both LLNDK (public) and LLNDK-private libs.
Jooyung Han0302a842019-10-30 18:43:49 +09001033 return isLlndkLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001034}
1035
Inseob Kim9516ee92019-05-09 10:56:13 +09001036func (c *Module) isLlndkPublic(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001037 // Returns true only for LLNDK (public) libs.
Jooyung Han0302a842019-10-30 18:43:49 +09001038 name := c.BaseModuleName()
1039 return isLlndkLibrary(name, config) && !isVndkPrivateLibrary(name, config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001040}
1041
Ivan Lozanof9e21722020-12-02 09:00:51 -05001042func (c *Module) IsVndkPrivate(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001043 // Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Jooyung Han0302a842019-10-30 18:43:49 +09001044 return isVndkPrivateLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001045}
1046
Ivan Lozano52767be2019-10-18 14:49:46 -07001047func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001048 if vndkdep := c.vndkdep; vndkdep != nil {
1049 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001050 }
1051 return false
1052}
1053
Yi Kong7e53c572018-02-14 18:16:12 +08001054func (c *Module) isPgoCompile() bool {
1055 if pgo := c.pgo; pgo != nil {
1056 return pgo.Properties.PgoCompile
1057 }
1058 return false
1059}
1060
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001061func (c *Module) isNDKStubLibrary() bool {
1062 if _, ok := c.compiler.(*stubDecorator); ok {
1063 return true
1064 }
1065 return false
1066}
1067
Logan Chienf3511742017-10-31 18:04:35 +08001068func (c *Module) isVndkSp() bool {
1069 if vndkdep := c.vndkdep; vndkdep != nil {
1070 return vndkdep.isVndkSp()
1071 }
1072 return false
1073}
1074
Ivan Lozanof9e21722020-12-02 09:00:51 -05001075func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001076 if vndkdep := c.vndkdep; vndkdep != nil {
1077 return vndkdep.isVndkExt()
1078 }
1079 return false
1080}
1081
Ivan Lozano52767be2019-10-18 14:49:46 -07001082func (c *Module) MustUseVendorVariant() bool {
Jooyung Han097087b2019-10-22 19:32:18 +09001083 return c.isVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001084}
1085
Logan Chienf3511742017-10-31 18:04:35 +08001086func (c *Module) getVndkExtendsModuleName() string {
1087 if vndkdep := c.vndkdep; vndkdep != nil {
1088 return vndkdep.getVndkExtendsModuleName()
1089 }
1090 return ""
1091}
1092
Jiyong Park25fc6a92018-11-18 18:02:45 +09001093func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001094 if lib := c.library; lib != nil {
1095 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001096 }
1097 return false
1098}
1099
1100func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001101 if lib := c.library; lib != nil {
1102 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001103 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001104 return false
1105}
1106
Colin Cross0477b422020-10-13 18:43:54 -07001107// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1108// the implementation. If it is an implementation library it returns its own name.
1109func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1110 name := ctx.OtherModuleName(c)
1111 if versioned, ok := c.linker.(versionedInterface); ok {
1112 name = versioned.implementationModuleName(name)
1113 }
1114 return name
1115}
1116
Martin Stjernholm2856c662020-12-02 15:03:42 +00001117// Similar to ImplementationModuleName, but uses the Make variant of the module
1118// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1119// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1120// under the premise that the prebuilt module overrides its source counterpart
1121// if it is exposed to Make).
1122func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1123 name := c.BaseModuleName()
1124 if versioned, ok := c.linker.(versionedInterface); ok {
1125 name = versioned.implementationModuleName(name)
1126 }
1127 return name
1128}
1129
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001130func (c *Module) bootstrap() bool {
1131 return Bool(c.Properties.Bootstrap)
1132}
1133
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001134func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001135 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1136 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1137 return false
1138 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001139 return c.linker != nil && c.linker.nativeCoverage()
1140}
1141
Inseob Kim8471cda2019-11-15 09:59:12 +09001142func (c *Module) isSnapshotPrebuilt() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09001143 if p, ok := c.linker.(interface{ isSnapshotPrebuilt() bool }); ok {
1144 return p.isSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001145 }
1146 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001147}
1148
Bill Peckham945441c2020-08-31 16:07:58 -07001149func (c *Module) ExcludeFromVendorSnapshot() bool {
1150 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1151}
1152
Jose Galmesf7294582020-11-13 12:07:36 -08001153func (c *Module) ExcludeFromRecoverySnapshot() bool {
1154 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1155}
1156
Jiyong Parkf1194352019-02-25 11:05:47 +09001157func isBionic(name string) bool {
1158 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001159 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001160 return true
1161 }
1162 return false
1163}
1164
Martin Stjernholm279de572019-09-10 23:18:20 +01001165func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001166 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001167 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001168 }
1169 return isBionic(name)
1170}
1171
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001172func (c *Module) XrefCcFiles() android.Paths {
1173 return c.kytheFiles
1174}
1175
Colin Crossca860ac2016-01-04 14:34:37 -08001176type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001177 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001178 moduleContextImpl
1179}
1180
Colin Cross37047f12016-12-13 17:06:13 -08001181type depsContext struct {
1182 android.BottomUpMutatorContext
1183 moduleContextImpl
1184}
1185
Colin Crossca860ac2016-01-04 14:34:37 -08001186type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001187 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001188 moduleContextImpl
1189}
1190
1191type moduleContextImpl struct {
1192 mod *Module
1193 ctx BaseModuleContext
1194}
1195
Colin Crossb98c8b02016-07-29 13:44:28 -07001196func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001197 return ctx.mod.toolchain(ctx.ctx)
1198}
1199
1200func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001201 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001202}
1203
1204func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001205 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001206}
1207
Jiyong Park1d1119f2019-07-29 21:27:18 +09001208func (ctx *moduleContextImpl) header() bool {
1209 return ctx.mod.header()
1210}
1211
Inseob Kim7f283f42020-06-01 21:53:49 +09001212func (ctx *moduleContextImpl) binary() bool {
1213 return ctx.mod.binary()
1214}
1215
Inseob Kim1042d292020-06-01 23:23:05 +09001216func (ctx *moduleContextImpl) object() bool {
1217 return ctx.mod.object()
1218}
1219
Jooyung Hanccce2f22020-03-07 03:45:53 +09001220func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001221 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001222}
1223
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001224func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001225 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001226}
1227
1228func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001229 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001230 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001231 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001232 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001233 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001234 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001235 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001236 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001237 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001238 }
1239 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001240}
1241
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001242func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001243 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001244}
Justin Yun8effde42017-06-23 19:24:43 +09001245
Colin Cross95f1ca02020-10-29 20:47:22 -07001246func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1247 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001248}
1249
Inseob Kim9516ee92019-05-09 10:56:13 +09001250func (ctx *moduleContextImpl) isLlndk(config android.Config) bool {
1251 return ctx.mod.isLlndk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001252}
1253
Inseob Kim9516ee92019-05-09 10:56:13 +09001254func (ctx *moduleContextImpl) isLlndkPublic(config android.Config) bool {
1255 return ctx.mod.isLlndkPublic(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001256}
1257
Inseob Kim9516ee92019-05-09 10:56:13 +09001258func (ctx *moduleContextImpl) isVndkPrivate(config android.Config) bool {
Ivan Lozanof9e21722020-12-02 09:00:51 -05001259 return ctx.mod.IsVndkPrivate(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001260}
1261
Logan Chienf3511742017-10-31 18:04:35 +08001262func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001263 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001264}
1265
Yi Kong7e53c572018-02-14 18:16:12 +08001266func (ctx *moduleContextImpl) isPgoCompile() bool {
1267 return ctx.mod.isPgoCompile()
1268}
1269
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001270func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1271 return ctx.mod.isNDKStubLibrary()
1272}
1273
Justin Yun8effde42017-06-23 19:24:43 +09001274func (ctx *moduleContextImpl) isVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001275 return ctx.mod.isVndkSp()
1276}
1277
Ivan Lozanof9e21722020-12-02 09:00:51 -05001278func (ctx *moduleContextImpl) IsVndkExt() bool {
1279 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001280}
1281
Vic Yangefd249e2018-11-12 20:19:56 -08001282func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001283 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001284}
1285
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001286func (ctx *moduleContextImpl) selectedStl() string {
1287 if stl := ctx.mod.stl; stl != nil {
1288 return stl.Properties.SelectedStl
1289 }
1290 return ""
1291}
1292
Ivan Lozanobd721262018-11-27 14:33:03 -08001293func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1294 return ctx.mod.linker.useClangLld(actx)
1295}
1296
Colin Crossce75d2c2016-10-06 16:12:58 -07001297func (ctx *moduleContextImpl) baseModuleName() string {
1298 return ctx.mod.ModuleBase.BaseModuleName()
1299}
1300
Logan Chienf3511742017-10-31 18:04:35 +08001301func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1302 return ctx.mod.getVndkExtendsModuleName()
1303}
1304
Logan Chiene274fc92019-12-03 11:18:32 -08001305func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001306 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001307}
1308
Colin Crosse07f2312020-08-13 11:24:56 -07001309func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001310 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001311}
1312
Dan Albertc8060532020-07-22 22:32:17 -07001313func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001314 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001315}
1316
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001317func (ctx *moduleContextImpl) bootstrap() bool {
1318 return ctx.mod.bootstrap()
1319}
1320
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001321func (ctx *moduleContextImpl) nativeCoverage() bool {
1322 return ctx.mod.nativeCoverage()
1323}
1324
Colin Cross56a83212020-09-15 18:30:11 -07001325func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1326 return ctx.mod.DirectlyInAnyApex()
1327}
1328
Colin Cross95b07f22020-12-16 11:06:50 -08001329func (ctx *moduleContextImpl) isPreventInstall() bool {
1330 return ctx.mod.Properties.PreventInstall
1331}
1332
Colin Cross635c3b02016-05-18 15:37:25 -07001333func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001334 return &Module{
1335 hod: hod,
1336 multilib: multilib,
1337 }
1338}
1339
Colin Cross635c3b02016-05-18 15:37:25 -07001340func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001341 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001342 module.features = []feature{
1343 &tidyFeature{},
1344 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001345 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001346 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001347 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001348 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001349 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001350 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001351 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001352 return module
1353}
1354
Colin Crossce75d2c2016-10-06 16:12:58 -07001355func (c *Module) Prebuilt() *android.Prebuilt {
1356 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1357 return p.prebuilt()
1358 }
1359 return nil
1360}
1361
1362func (c *Module) Name() string {
1363 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001364 if p, ok := c.linker.(interface {
1365 Name(string) string
1366 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001367 name = p.Name(name)
1368 }
1369 return name
1370}
1371
Alex Light3d673592019-01-18 14:37:31 -08001372func (c *Module) Symlinks() []string {
1373 if p, ok := c.installer.(interface {
1374 symlinkList() []string
1375 }); ok {
1376 return p.symlinkList()
1377 }
1378 return nil
1379}
1380
Roland Levillainf89cd092019-07-29 16:22:59 +01001381func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1382 test, ok := c.linker.(testPerSrc)
1383 return ok && test.isAllTestsVariation()
1384}
1385
Chris Parsons216e10a2020-07-09 17:12:52 -04001386func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001387 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001388 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001389 }); ok {
1390 return p.dataPaths()
1391 }
1392 return nil
1393}
1394
Justin Yun5f7f7e82019-11-18 19:52:14 +09001395func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1396 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1397 // "current", it will append the VNDK version to the name suffix.
1398 var vndkVersion string
1399 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001400 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001401 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1402 nameSuffix = productSuffix
1403 } else {
1404 vndkVersion = ctx.DeviceConfig().VndkVersion()
1405 nameSuffix = vendorSuffix
1406 }
1407 if vndkVersion == "current" {
1408 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1409 }
1410 if c.Properties.VndkVersion != vndkVersion {
1411 // add version suffix only if the module is using different vndk version than the
1412 // version in product or vendor partition.
1413 nameSuffix += "." + c.Properties.VndkVersion
1414 }
1415 return nameSuffix
1416}
1417
Colin Cross635c3b02016-05-18 15:37:25 -07001418func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Roland Levillainf2fad972019-06-28 15:41:19 +01001419 // Handle the case of a test module split by `test_per_src` mutator.
Roland Levillainf89cd092019-07-29 16:22:59 +01001420 //
1421 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1422 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1423 // module and return early, as this module does not produce an output file per se.
1424 if c.IsTestPerSrcAllTestsVariation() {
1425 c.outputFile = android.OptionalPath{}
1426 return
Roland Levillainf2fad972019-06-28 15:41:19 +01001427 }
1428
Colin Cross56a83212020-09-15 18:30:11 -07001429 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1430 if !apexInfo.IsForPlatform() {
1431 c.hideApexVariantFromMake = true
1432 }
1433
Ivan Lozanof9e21722020-12-02 09:00:51 -05001434 c.makeLinkType = GetMakeLinkType(actx, c)
Inseob Kim9516ee92019-05-09 10:56:13 +09001435
Inseob Kim64c43952019-08-26 16:52:35 +09001436 c.Properties.SubName = ""
1437
1438 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1439 c.Properties.SubName += nativeBridgeSuffix
1440 }
1441
Justin Yun5f7f7e82019-11-18 19:52:14 +09001442 _, llndk := c.linker.(*llndkStubDecorator)
1443 _, llndkHeader := c.linker.(*llndkHeadersDecorator)
Justin Yun63e9ec72020-10-29 16:49:43 +09001444 if llndk || llndkHeader || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001445 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1446 // added for product variant only when we have vendor and product variants with core
1447 // variant. The suffix is not added for vendor-only or product-only module.
1448 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
1449 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001450 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1451 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
1452 c.Properties.SubName += vendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001453 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1454 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001455 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
1456 c.Properties.SubName += vendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001457 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001458 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001459 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001460 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001461 if c.SplitPerApiLevel() {
1462 c.Properties.SubName += "." + c.SdkVersion()
1463 }
Inseob Kim64c43952019-08-26 16:52:35 +09001464 }
1465
Colin Crossca860ac2016-01-04 14:34:37 -08001466 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001467 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001468 moduleContextImpl: moduleContextImpl{
1469 mod: c,
1470 },
1471 }
1472 ctx.ctx = ctx
1473
Colin Crossf18e1102017-11-16 14:33:08 -08001474 deps := c.depsToPaths(ctx)
1475 if ctx.Failed() {
1476 return
1477 }
1478
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001479 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1480 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1481 }
1482
Colin Crossca860ac2016-01-04 14:34:37 -08001483 flags := Flags{
1484 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001485 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001486 }
Colin Crossca860ac2016-01-04 14:34:37 -08001487 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001488 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001489 }
1490 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001491 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001492 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001493 if c.stl != nil {
1494 flags = c.stl.flags(ctx, flags)
1495 }
Colin Cross16b23492016-01-06 14:41:07 -08001496 if c.sanitize != nil {
1497 flags = c.sanitize.flags(ctx, flags)
1498 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001499 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001500 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001501 }
Stephen Craneba090d12017-05-09 15:44:35 -07001502 if c.lto != nil {
1503 flags = c.lto.flags(ctx, flags)
1504 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001505 if c.pgo != nil {
1506 flags = c.pgo.flags(ctx, flags)
1507 }
Colin Crossca860ac2016-01-04 14:34:37 -08001508 for _, feature := range c.features {
1509 flags = feature.flags(ctx, flags)
1510 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001511 if ctx.Failed() {
1512 return
1513 }
1514
Colin Cross4af21ed2019-11-04 09:37:55 -08001515 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1516 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1517 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001518
Colin Cross4af21ed2019-11-04 09:37:55 -08001519 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001520
1521 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001522 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001523 }
1524 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001525 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001526 }
1527
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001528 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001529 // We need access to all the flags seen by a source file.
1530 if c.sabi != nil {
1531 flags = c.sabi.flags(ctx, flags)
1532 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001533
Colin Cross4af21ed2019-11-04 09:37:55 -08001534 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001535
Colin Crossca860ac2016-01-04 14:34:37 -08001536 // Optimization to reduce size of build.ninja
1537 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001538 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1539 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1540 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1541 flags.Local.CFlags = []string{"$cflags"}
1542 flags.Local.CppFlags = []string{"$cppflags"}
1543 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001544
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001545 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001546 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001547 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001548 if ctx.Failed() {
1549 return
1550 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001551 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001552 }
1553
Colin Crossca860ac2016-01-04 14:34:37 -08001554 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001555 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001556 if ctx.Failed() {
1557 return
1558 }
Colin Cross635c3b02016-05-18 15:37:25 -07001559 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001560
Jiyong Parkf7c3bbe2020-12-09 21:18:56 +09001561 // If a lib is directly included in any of the APEXes or is not available to the
1562 // platform (which is often the case when the stub is provided as a prebuilt),
1563 // unhide the stubs variant having the latest version gets visible to make. In
1564 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1565 // force anything in the make world to link against the stubs library. (unless it
1566 // is explicitly referenced via .bootstrap suffix or the module is marked with
1567 // 'bootstrap: true').
1568 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Ivan Lozano52767be2019-10-18 14:49:46 -07001569 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001570 c.IsStubs() && !c.InVendorRamdisk() {
Jiyong Parkb0788572018-12-20 22:10:17 +09001571 c.Properties.HideFromMake = false // unhide
1572 // Note: this is still non-installable
1573 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001574
1575 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current.
1576 if i, ok := c.linker.(snapshotLibraryInterface); ok && ctx.DeviceConfig().VndkVersion() == "current" {
Inseob Kimde5744a2020-12-02 13:14:28 +09001577 if shouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001578 i.collectHeadersForSnapshot(ctx)
1579 }
1580 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001581 }
Colin Cross5049f022015-03-18 13:28:46 -07001582
Colin Cross56a83212020-09-15 18:30:11 -07001583 if c.installable(apexInfo) {
Colin Crossce75d2c2016-10-06 16:12:58 -07001584 c.installer.install(ctx, c.outputFile.Path())
1585 if ctx.Failed() {
1586 return
Colin Crossca860ac2016-01-04 14:34:37 -08001587 }
Paul Duffin0cb37b92020-03-04 14:52:46 +00001588 } else if !proptools.BoolDefault(c.Properties.Installable, true) {
1589 // If the module has been specifically configure to not be installed then
1590 // skip the installation as otherwise it will break when running inside make
1591 // as the output path to install will not be specified. Not all uninstallable
1592 // modules can skip installation as some are needed for resolving make side
1593 // dependencies.
1594 c.SkipInstall()
Dan Albertc403f7c2015-03-18 14:01:18 -07001595 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001596}
1597
Colin Cross0ea8ba82019-06-06 14:33:29 -07001598func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001599 if c.cachedToolchain == nil {
Colin Crossb98c8b02016-07-29 13:44:28 -07001600 c.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
Colin Cross3f40fa42015-01-30 17:27:36 -08001601 }
Colin Crossca860ac2016-01-04 14:34:37 -08001602 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001603}
1604
Colin Crossca860ac2016-01-04 14:34:37 -08001605func (c *Module) begin(ctx BaseModuleContext) {
1606 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001607 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001608 }
Colin Crossca860ac2016-01-04 14:34:37 -08001609 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001610 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001611 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001612 if c.stl != nil {
1613 c.stl.begin(ctx)
1614 }
Colin Cross16b23492016-01-06 14:41:07 -08001615 if c.sanitize != nil {
1616 c.sanitize.begin(ctx)
1617 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001618 if c.coverage != nil {
1619 c.coverage.begin(ctx)
1620 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001621 if c.sabi != nil {
1622 c.sabi.begin(ctx)
1623 }
Justin Yun8effde42017-06-23 19:24:43 +09001624 if c.vndkdep != nil {
1625 c.vndkdep.begin(ctx)
1626 }
Stephen Craneba090d12017-05-09 15:44:35 -07001627 if c.lto != nil {
1628 c.lto.begin(ctx)
1629 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001630 if c.pgo != nil {
1631 c.pgo.begin(ctx)
1632 }
Colin Crossca860ac2016-01-04 14:34:37 -08001633 for _, feature := range c.features {
1634 feature.begin(ctx)
1635 }
Dan Albert92fe7402020-07-15 13:33:30 -07001636 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001637 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001638 if err != nil {
1639 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001640 c.Properties.Sdk_version = nil
1641 } else {
1642 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001643 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001644 }
Colin Crossca860ac2016-01-04 14:34:37 -08001645}
1646
Colin Cross37047f12016-12-13 17:06:13 -08001647func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001648 deps := Deps{}
1649
1650 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001651 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001652 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001653 // Add the PGO dependency (the clang_rt.profile runtime library), which
1654 // sometimes depends on symbols from libgcc, before libgcc gets added
1655 // in linkerDeps().
Pirama Arumuga Nainar49b53d52017-10-04 16:47:29 -07001656 if c.pgo != nil {
1657 deps = c.pgo.deps(ctx, deps)
1658 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001659 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001660 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001661 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001662 if c.stl != nil {
1663 deps = c.stl.deps(ctx, deps)
1664 }
Colin Cross16b23492016-01-06 14:41:07 -08001665 if c.sanitize != nil {
1666 deps = c.sanitize.deps(ctx, deps)
1667 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001668 if c.coverage != nil {
1669 deps = c.coverage.deps(ctx, deps)
1670 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001671 if c.sabi != nil {
1672 deps = c.sabi.deps(ctx, deps)
1673 }
Justin Yun8effde42017-06-23 19:24:43 +09001674 if c.vndkdep != nil {
1675 deps = c.vndkdep.deps(ctx, deps)
1676 }
Stephen Craneba090d12017-05-09 15:44:35 -07001677 if c.lto != nil {
1678 deps = c.lto.deps(ctx, deps)
1679 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001680 for _, feature := range c.features {
1681 deps = feature.deps(ctx, deps)
1682 }
1683
Colin Crossb6715442017-10-24 11:13:31 -07001684 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1685 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1686 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1687 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1688 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1689 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001690 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001691
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001692 for _, lib := range deps.ReexportSharedLibHeaders {
1693 if !inList(lib, deps.SharedLibs) {
1694 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1695 }
1696 }
1697
1698 for _, lib := range deps.ReexportStaticLibHeaders {
1699 if !inList(lib, deps.StaticLibs) {
1700 ctx.PropertyErrorf("export_static_lib_headers", "Static library not in static_libs: '%s'", lib)
1701 }
1702 }
1703
Colin Cross5950f382016-12-13 12:50:57 -08001704 for _, lib := range deps.ReexportHeaderLibHeaders {
1705 if !inList(lib, deps.HeaderLibs) {
1706 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1707 }
1708 }
1709
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001710 for _, gen := range deps.ReexportGeneratedHeaders {
1711 if !inList(gen, deps.GeneratedHeaders) {
1712 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1713 }
1714 }
1715
Colin Crossc99deeb2016-04-11 15:06:20 -07001716 return deps
1717}
1718
Dan Albert7e9d2952016-08-04 13:02:36 -07001719func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001720 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001721 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001722 moduleContextImpl: moduleContextImpl{
1723 mod: c,
1724 },
1725 }
1726 ctx.ctx = ctx
1727
Colin Crossca860ac2016-01-04 14:34:37 -08001728 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001729}
1730
Jiyong Park7ed9de32018-10-15 22:25:07 +09001731// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001732func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001733 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1734 version := name[sharp+1:]
1735 libname := name[:sharp]
1736 return libname, version
1737 }
1738 return name, ""
1739}
1740
Dan Albert92fe7402020-07-15 13:33:30 -07001741func GetCrtVariations(ctx android.BottomUpMutatorContext,
1742 m LinkableInterface) []blueprint.Variation {
1743 if ctx.Os() != android.Android {
1744 return nil
1745 }
1746 if m.UseSdk() {
1747 return []blueprint.Variation{
1748 {Mutator: "sdk", Variation: "sdk"},
Colin Crossbbc941b2020-09-30 12:27:01 -07001749 {Mutator: "version", Variation: m.SdkVersion()},
Dan Albert92fe7402020-07-15 13:33:30 -07001750 }
1751 }
1752 return []blueprint.Variation{
1753 {Mutator: "sdk", Variation: ""},
1754 }
1755}
1756
Colin Crosse7257d22020-09-24 09:56:18 -07001757func (c *Module) addSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext,
1758 variations []blueprint.Variation, depTag libraryDependencyTag, name, version string, far bool) {
1759
1760 variations = append([]blueprint.Variation(nil), variations...)
1761
Colin Cross3146c5c2020-09-30 15:34:40 -07001762 if version != "" && CanBeOrLinkAgainstVersionVariants(c) {
Colin Crosse7257d22020-09-24 09:56:18 -07001763 // Version is explicitly specified. i.e. libFoo#30
1764 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
1765 depTag.explicitlyVersioned = true
1766 }
Colin Crosse7257d22020-09-24 09:56:18 -07001767
Colin Cross0de8a1e2020-09-18 14:15:30 -07001768 if far {
1769 ctx.AddFarVariationDependencies(variations, depTag, name)
1770 } else {
1771 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07001772 }
1773}
1774
Colin Cross1e676be2016-10-12 14:38:15 -07001775func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09001776 if !c.Enabled() {
1777 return
1778 }
1779
Colin Cross37047f12016-12-13 17:06:13 -08001780 ctx := &depsContext{
1781 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07001782 moduleContextImpl: moduleContextImpl{
1783 mod: c,
1784 },
1785 }
1786 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08001787
Colin Crossc99deeb2016-04-11 15:06:20 -07001788 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001789
Yo Chiang219968c2020-09-22 18:45:04 +08001790 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
1791
Dan Albert914449f2016-06-17 16:45:24 -07001792 variantNdkLibs := []string{}
1793 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07001794 if ctx.Os() == android.Android {
Inseob Kimeec88e12020-01-22 11:11:29 +09001795 // rewriteLibs takes a list of names of shared libraries and scans it for three types
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001796 // of names:
Dan Albert914449f2016-06-17 16:45:24 -07001797 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001798 // 1. Name of an NDK library that refers to a prebuilt module.
1799 // For each of these, it adds the name of the prebuilt module (which will be in
1800 // prebuilts/ndk) to the list of nonvariant libs.
1801 // 2. Name of an NDK library that refers to an ndk_library module.
1802 // For each of these, it adds the name of the ndk_library module to the list of
1803 // variant libs.
1804 // 3. Anything else (so anything that isn't an NDK library).
1805 // It adds these to the nonvariantLibs list.
Dan Albert914449f2016-06-17 16:45:24 -07001806 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001807 // The caller can then know to add the variantLibs dependencies differently from the
1808 // nonvariantLibs
Inseob Kim9516ee92019-05-09 10:56:13 +09001809
Inseob Kim9516ee92019-05-09 10:56:13 +09001810 vendorPublicLibraries := vendorPublicLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001811 vendorSnapshotSharedLibs := vendorSnapshotSharedLibs(actx.Config())
1812
1813 rewriteVendorLibs := func(lib string) string {
1814 if isLlndkLibrary(lib, ctx.Config()) {
1815 return lib + llndkLibrarySuffix
1816 }
1817
1818 // only modules with BOARD_VNDK_VERSION uses snapshot.
1819 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1820 return lib
1821 }
1822
1823 if snapshot, ok := vendorSnapshotSharedLibs.get(lib, actx.Arch().ArchType); ok {
1824 return snapshot
1825 }
1826
1827 return lib
1828 }
1829
1830 rewriteLibs := func(list []string) (nonvariantLibs []string, variantLibs []string) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001831 variantLibs = []string{}
1832 nonvariantLibs = []string{}
Dan Albert914449f2016-06-17 16:45:24 -07001833 for _, entry := range list {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001834 // strip #version suffix out
Jiyong Park73c54ee2019-10-22 20:31:18 +09001835 name, _ := StubsLibNameAndVersion(entry)
Colin Cross95f1ca02020-10-29 20:47:22 -07001836 if ctx.useSdk() && inList(name, *getNDKKnownLibs(ctx.Config())) {
Dan Albertde5aade2020-06-30 12:32:51 -07001837 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Inseob Kimeec88e12020-01-22 11:11:29 +09001838 } else if ctx.useVndk() {
1839 nonvariantLibs = append(nonvariantLibs, rewriteVendorLibs(entry))
Inseob Kim9516ee92019-05-09 10:56:13 +09001840 } else if (ctx.Platform() || ctx.ProductSpecific()) && inList(name, *vendorPublicLibraries) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001841 vendorPublicLib := name + vendorPublicLibrarySuffix
Jiyong Park374510b2018-03-19 18:23:01 +09001842 if actx.OtherModuleExists(vendorPublicLib) {
1843 nonvariantLibs = append(nonvariantLibs, vendorPublicLib)
1844 } else {
1845 // This can happen if vendor_public_library module is defined in a
1846 // namespace that isn't visible to the current module. In that case,
1847 // link to the original library.
Jiyong Park7ed9de32018-10-15 22:25:07 +09001848 nonvariantLibs = append(nonvariantLibs, name)
Jiyong Park374510b2018-03-19 18:23:01 +09001849 }
Dan Albert914449f2016-06-17 16:45:24 -07001850 } else {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001851 // put name#version back
Dan Willemsen7cbf5f82017-03-28 00:08:30 -07001852 nonvariantLibs = append(nonvariantLibs, entry)
Dan Willemsen72d39932016-07-08 23:23:48 -07001853 }
1854 }
Dan Albert914449f2016-06-17 16:45:24 -07001855 return nonvariantLibs, variantLibs
Dan Willemsen72d39932016-07-08 23:23:48 -07001856 }
1857
Inseob Kimeec88e12020-01-22 11:11:29 +09001858 deps.SharedLibs, variantNdkLibs = rewriteLibs(deps.SharedLibs)
1859 deps.LateSharedLibs, variantLateNdkLibs = rewriteLibs(deps.LateSharedLibs)
1860 deps.ReexportSharedLibHeaders, _ = rewriteLibs(deps.ReexportSharedLibHeaders)
1861 if ctx.useVndk() {
1862 for idx, lib := range deps.RuntimeLibs {
1863 deps.RuntimeLibs[idx] = rewriteVendorLibs(lib)
1864 }
1865 }
Dan Willemsen72d39932016-07-08 23:23:48 -07001866 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001867
Inseob Kimeec88e12020-01-22 11:11:29 +09001868 rewriteSnapshotLibs := func(lib string, snapshotMap *snapshotMap) string {
1869 // only modules with BOARD_VNDK_VERSION uses snapshot.
1870 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1871 return lib
1872 }
1873
1874 if snapshot, ok := snapshotMap.get(lib, actx.Arch().ArchType); ok {
1875 return snapshot
1876 }
1877
1878 return lib
1879 }
1880
1881 vendorSnapshotHeaderLibs := vendorSnapshotHeaderLibs(actx.Config())
Colin Cross32ec36c2016-12-15 07:39:51 -08001882 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001883 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08001884 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001885 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08001886 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001887
1888 lib = rewriteSnapshotLibs(lib, vendorSnapshotHeaderLibs)
1889
Jiyong Park1ad8e162020-12-01 23:40:09 +09001890 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08001891 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001892 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09001893 } else {
1894 actx.AddVariationDependencies(nil, depTag, lib)
1895 }
1896 }
1897
Inseob Kim07def122020-11-23 14:43:02 +09001898 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
1899 // C++ implementation library and one Java implementation library. When a module links against
1900 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
1901 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
1902 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09001903 syspropImplLibraries := syspropImplLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001904 vendorSnapshotStaticLibs := vendorSnapshotStaticLibs(actx.Config())
Inseob Kimc0907f12019-02-08 21:00:45 +09001905
Jiyong Park5d1598f2019-02-25 22:14:17 +09001906 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001907 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09001908 if impl, ok := syspropImplLibraries[lib]; ok {
1909 lib = impl
1910 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001911
1912 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1913
Jiyong Park5d1598f2019-02-25 22:14:17 +09001914 actx.AddVariationDependencies([]blueprint.Variation{
1915 {Mutator: "link", Variation: "static"},
1916 }, depTag, lib)
1917 }
1918
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001919 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001920 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001921 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001922 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001923 }
Jiyong Parke3867542020-12-03 17:28:25 +09001924 if inList(lib, deps.ExcludeLibsForApex) {
1925 depTag.excludeInApex = true
1926 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001927
1928 if impl, ok := syspropImplLibraries[lib]; ok {
1929 lib = impl
1930 }
1931
Inseob Kimeec88e12020-01-22 11:11:29 +09001932 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1933
Dan Willemsen59339a22018-07-22 21:18:45 -07001934 actx.AddVariationDependencies([]blueprint.Variation{
1935 {Mutator: "link", Variation: "static"},
1936 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001937 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001938
Jooyung Han75568392020-03-20 04:29:24 +09001939 // staticUnwinderDep is treated as staticDep for Q apexes
1940 // so that native libraries/binaries are linked with static unwinder
1941 // because Q libc doesn't have unwinder APIs
1942 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07001943 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001944 actx.AddVariationDependencies([]blueprint.Variation{
1945 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001946 }, depTag, rewriteSnapshotLibs(staticUnwinder(actx), vendorSnapshotStaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001947 }
1948
Inseob Kimeec88e12020-01-22 11:11:29 +09001949 for _, lib := range deps.LateStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001950 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Inseob Kimeec88e12020-01-22 11:11:29 +09001951 actx.AddVariationDependencies([]blueprint.Variation{
1952 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001953 }, depTag, rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs))
Inseob Kimeec88e12020-01-22 11:11:29 +09001954 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001955
Jiyong Park7ed9de32018-10-15 22:25:07 +09001956 // shared lib names without the #version suffix
1957 var sharedLibNames []string
1958
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001959 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001960 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001961 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001962 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001963 }
Jiyong Parke3867542020-12-03 17:28:25 +09001964 if inList(lib, deps.ExcludeLibsForApex) {
1965 depTag.excludeInApex = true
1966 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001967
1968 if impl, ok := syspropImplLibraries[lib]; ok {
1969 lib = impl
1970 }
1971
Jiyong Park73c54ee2019-10-22 20:31:18 +09001972 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09001973 sharedLibNames = append(sharedLibNames, name)
1974
Colin Crosse7257d22020-09-24 09:56:18 -07001975 variations := []blueprint.Variation{
1976 {Mutator: "link", Variation: "shared"},
1977 }
1978 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001979 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001980
Jiyong Park7ed9de32018-10-15 22:25:07 +09001981 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09001982 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001983 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
1984 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
1985 // linking against both the stubs lib and the non-stubs lib at the same time.
1986 continue
1987 }
Colin Cross6e511a92020-07-27 21:26:48 -07001988 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07001989 variations := []blueprint.Variation{
1990 {Mutator: "link", Variation: "shared"},
1991 }
1992 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001993 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001994
Dan Willemsen59339a22018-07-22 21:18:45 -07001995 actx.AddVariationDependencies([]blueprint.Variation{
1996 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04001997 }, dataLibDepTag, deps.DataLibs...)
1998
1999 actx.AddVariationDependencies([]blueprint.Variation{
2000 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002001 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002002
Colin Cross68861832016-07-08 10:41:41 -07002003 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002004
2005 for _, gen := range deps.GeneratedHeaders {
2006 depTag := genHeaderDepTag
2007 if inList(gen, deps.ReexportGeneratedHeaders) {
2008 depTag = genHeaderExportDepTag
2009 }
2010 actx.AddDependency(c, depTag, gen)
2011 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002012
Inseob Kim1042d292020-06-01 23:23:05 +09002013 vendorSnapshotObjects := vendorSnapshotObjects(actx.Config())
2014
Dan Albert92fe7402020-07-15 13:33:30 -07002015 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002016 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc99deeb2016-04-11 15:06:20 -07002017 if deps.CrtBegin != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07002018 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
2019 rewriteSnapshotLibs(deps.CrtBegin, vendorSnapshotObjects))
Colin Crossca860ac2016-01-04 14:34:37 -08002020 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002021 if deps.CrtEnd != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07002022 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
2023 rewriteSnapshotLibs(deps.CrtEnd, vendorSnapshotObjects))
Colin Cross21b9a242015-03-24 14:15:58 -07002024 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002025 if deps.LinkerFlagsFile != "" {
2026 actx.AddDependency(c, linkerFlagsDepTag, deps.LinkerFlagsFile)
2027 }
2028 if deps.DynamicLinker != "" {
2029 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002030 }
Dan Albert914449f2016-06-17 16:45:24 -07002031
2032 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002033
2034 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002035 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002036 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002037 {Mutator: "link", Variation: "shared"},
2038 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002039
2040 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002041 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002042 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002043 {Mutator: "link", Variation: "shared"},
2044 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002045
2046 if vndkdep := c.vndkdep; vndkdep != nil {
2047 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002048 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002049 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002050 {Mutator: "link", Variation: "shared"},
2051 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002052 }
2053 }
Colin Cross6362e272015-10-29 15:25:03 -07002054}
Colin Cross21b9a242015-03-24 14:15:58 -07002055
Colin Crosse40b4ea2018-10-02 22:25:58 -07002056func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002057 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2058 c.beginMutator(ctx)
2059 }
2060}
2061
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002062// Whether a module can link to another module, taking into
2063// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002064func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002065 tag blueprint.DependencyTag) {
2066
2067 switch t := tag.(type) {
2068 case dependencyTag:
2069 if t != vndkExtDepTag {
2070 return
2071 }
2072 case libraryDependencyTag:
2073 default:
2074 return
2075 }
2076
Ivan Lozanof9e21722020-12-02 09:00:51 -05002077 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002078 // Host code is not restricted
2079 return
2080 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002081
2082 // VNDK is cc.Module supported only for now.
2083 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002084 // Though allowed dependency is limited by the image mutator,
2085 // each vendor and product module needs to check link-type
2086 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002087 if ccTo, ok := to.(*Module); ok {
2088 if ccFrom.vndkdep != nil {
2089 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2090 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05002091 } else if linkableMod, ok := to.(LinkableInterface); ok {
2092 // Static libraries from other languages can be linked
2093 if !linkableMod.Static() {
2094 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
2095 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002096 } else {
2097 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002098 }
2099 return
2100 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002101 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002102 // Platform code can link to anything
2103 return
2104 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002105 if from.InRamdisk() {
2106 // Ramdisk code is not NDK
2107 return
2108 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002109 if from.InVendorRamdisk() {
2110 // Vendor ramdisk code is not NDK
2111 return
2112 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002113 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002114 // Recovery code is not NDK
2115 return
2116 }
Colin Cross31076b32020-10-23 17:22:06 -07002117 if c, ok := to.(*Module); ok {
2118 if c.ToolchainLibrary() {
2119 // These are always allowed
2120 return
2121 }
2122 if c.NdkPrebuiltStl() {
2123 // These are allowed, but they don't set sdk_version
2124 return
2125 }
2126 if c.StubDecorator() {
2127 // These aren't real libraries, but are the stub shared libraries that are included in
2128 // the NDK.
2129 return
2130 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002131 }
Logan Chien834b9a62019-01-14 15:39:03 +08002132
Ivan Lozano52767be2019-10-18 14:49:46 -07002133 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002134 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2135 // to link to libc++ (non-NDK and without sdk_version).
2136 return
2137 }
2138
Ivan Lozano52767be2019-10-18 14:49:46 -07002139 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002140 // NDK code linking to platform code is never okay.
2141 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002142 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002143 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002144 }
2145
2146 // At this point we know we have two NDK libraries, but we need to
2147 // check that we're not linking against anything built against a higher
2148 // API level, as it is only valid to link against older or equivalent
2149 // APIs.
2150
Inseob Kim01a28722018-04-11 09:48:45 +09002151 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002152 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002153 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002154 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002155 // Current can't be linked against by anything else.
2156 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002157 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002158 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002159 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002160 if err != nil {
2161 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002162 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002163 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002164 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002165 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002166 if err != nil {
2167 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002168 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002169 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002170 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002171
Inseob Kim01a28722018-04-11 09:48:45 +09002172 if toApi > fromApi {
2173 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002174 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002175 }
2176 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002177 }
Dan Albert202fe492017-12-15 13:56:59 -08002178
2179 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002180 fromStl := from.SelectedStl()
2181 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002182 if fromStl == "" || toStl == "" {
2183 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002184 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002185 // We can be permissive with the system "STL" since it is only the C++
2186 // ABI layer, but in the future we should make sure that everyone is
2187 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002188 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002189 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002190 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2191 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002192 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002193}
2194
Jooyung Han479ca172020-10-19 18:51:07 +09002195func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2196 if c, ok := ctx.Module().(*Module); ok {
2197 ctx.VisitDirectDeps(func(dep android.Module) {
2198 depTag := ctx.OtherModuleDependencyTag(dep)
2199 ccDep, ok := dep.(LinkableInterface)
2200 if ok {
2201 checkLinkType(ctx, c, ccDep, depTag)
2202 }
2203 })
2204 }
2205}
2206
Jiyong Park5fb8c102018-04-09 12:03:06 +09002207// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002208// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2209// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002210// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002211func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2212 check := func(child, parent android.Module) bool {
2213 to, ok := child.(*Module)
2214 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002215 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002216 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002217
Jooyung Hana70f0672019-01-18 15:20:43 +09002218 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2219 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002220 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002221
Jiyong Park1ad8e162020-12-01 23:40:09 +09002222 depTag := ctx.OtherModuleDependencyTag(child)
2223 if IsHeaderDepTag(depTag) {
2224 return false
2225 }
2226
Justin Yun63e9ec72020-10-29 16:49:43 +09002227 // Even if target lib has no vendor variant, keep checking dependency
2228 // graph in case it depends on vendor_available or product_available
2229 // but not double_loadable transtively.
2230 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002231 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002232 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002233
Jooyung Han0302a842019-10-30 18:43:49 +09002234 if to.isVndkSp() || to.isLlndk(ctx.Config()) || Bool(to.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002235 return false
2236 }
2237
2238 var stringPath []string
2239 for _, m := range ctx.GetWalkPath() {
2240 stringPath = append(stringPath, m.Name())
2241 }
2242 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2243 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
2244 "(dependency: %s)", ctx.OtherModuleName(to), strings.Join(stringPath, " -> "))
2245 return false
2246 }
2247 if module, ok := ctx.Module().(*Module); ok {
2248 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jooyung Han0302a842019-10-30 18:43:49 +09002249 if module.isLlndk(ctx.Config()) || Bool(module.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002250 ctx.WalkDeps(check)
2251 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002252 }
2253 }
2254}
2255
Colin Cross0de8a1e2020-09-18 14:15:30 -07002256// Returns the highest version which is <= maxSdkVersion.
2257// For example, with maxSdkVersion is 10 and versionList is [9,11]
2258// it returns 9 as string. The list of stubs must be in order from
2259// oldest to newest.
Chris Parsons3c27ca32020-11-20 12:42:07 -05002260func (c *Module) chooseSdkVersion(ctx android.PathContext, stubsInfo []SharedStubLibrary,
2261 maxSdkVersion android.ApiLevel) (SharedStubLibrary, error) {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002262
2263 for i := range stubsInfo {
2264 stubInfo := stubsInfo[len(stubsInfo)-i-1]
2265 var ver android.ApiLevel
2266 if stubInfo.Version == "" {
2267 ver = android.FutureApiLevel
2268 } else {
2269 var err error
2270 ver, err = android.ApiLevelFromUser(ctx, stubInfo.Version)
2271 if err != nil {
Chris Parsons3c27ca32020-11-20 12:42:07 -05002272 return SharedStubLibrary{}, err
Colin Cross0de8a1e2020-09-18 14:15:30 -07002273 }
2274 }
2275 if ver.LessThanOrEqualTo(maxSdkVersion) {
2276 return stubInfo, nil
2277 }
2278 }
2279 var versionList []string
2280 for _, stubInfo := range stubsInfo {
2281 versionList = append(versionList, stubInfo.Version)
2282 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05002283 return SharedStubLibrary{}, fmt.Errorf("not found a version(<=%s) in versionList: %v", maxSdkVersion.String(), versionList)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002284}
2285
Colin Crossc99deeb2016-04-11 15:06:20 -07002286// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002287func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002288 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002289
Colin Cross0de8a1e2020-09-18 14:15:30 -07002290 var directStaticDeps []StaticLibraryInfo
2291 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002292
Colin Cross0de8a1e2020-09-18 14:15:30 -07002293 reexportExporter := func(exporter FlagExporterInfo) {
2294 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2295 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2296 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2297 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2298 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002299 }
2300
Jooyung Hande34d232020-07-23 13:04:15 +09002301 // For the dependency from platform to apex, use the latest stubs
2302 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002303 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2304 if !apexInfo.IsForPlatform() {
2305 c.apexSdkVersion = apexInfo.MinSdkVersion(ctx)
Jooyung Hande34d232020-07-23 13:04:15 +09002306 }
2307
2308 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2309 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2310 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2311 // (b/144430859)
2312 c.apexSdkVersion = android.FutureApiLevel
2313 }
2314
Colin Crossd11fcda2017-10-23 17:59:01 -07002315 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002316 depName := ctx.OtherModuleName(dep)
2317 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002318
Ivan Lozano52767be2019-10-18 14:49:46 -07002319 ccDep, ok := dep.(LinkableInterface)
2320 if !ok {
2321
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002322 // handling for a few module types that aren't cc Module but that are also supported
2323 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002324 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002325 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002326 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2327 genRule.GeneratedSourceFiles()...)
2328 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002329 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002330 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002331 // Support exported headers from a generated_sources dependency
2332 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002333 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002334 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002335 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002336 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002337 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002338 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002339 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002340 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002341 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2342 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002343 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002344 // 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 +09002345 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002346
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002347 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002348 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002349 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002350 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002351 case linkerFlagsDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002352 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002353 files := genRule.GeneratedSourceFiles()
2354 if len(files) == 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002355 depPaths.LinkerFlagsFile = android.OptionalPathForPath(files[0])
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002356 } else if len(files) > 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002357 ctx.ModuleErrorf("module %q can only generate a single file if used for a linker flag file", depName)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002358 }
2359 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002360 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002361 }
Colin Crossca860ac2016-01-04 14:34:37 -08002362 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002363 return
2364 }
2365
Colin Crossfe17f6f2019-03-28 19:30:56 -07002366 if depTag == android.ProtoPluginDepTag {
2367 return
2368 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002369 if depTag == llndkImplDep {
2370 return
2371 }
Colin Crossfe17f6f2019-03-28 19:30:56 -07002372
Colin Crossd11fcda2017-10-23 17:59:01 -07002373 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002374 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2375 return
2376 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002377 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002378 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2379 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002380 return
2381 }
2382
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002383 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002384 // Skip reused objects for stub libraries, they use their own stub object file instead.
2385 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2386 // version mutator, so the stubs variant is created from the shared variant that
2387 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002388 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002389 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2390 objs := staticAnalogue.ReuseObjects
2391 depPaths.Objs = depPaths.Objs.Append(objs)
2392 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2393 reexportExporter(depExporterInfo)
2394 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002395 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002396 }
2397
Colin Cross6e511a92020-07-27 21:26:48 -07002398 linkFile := ccDep.OutputFile()
2399
2400 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2401 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002402 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002403 return
2404 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002405
Jiyong Parke3867542020-12-03 17:28:25 +09002406 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2407 return
2408 }
2409
Colin Cross0de8a1e2020-09-18 14:15:30 -07002410 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002411
Colin Cross6e511a92020-07-27 21:26:48 -07002412 var ptr *android.Paths
2413 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002414
Colin Cross6e511a92020-07-27 21:26:48 -07002415 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002416
Colin Cross6e511a92020-07-27 21:26:48 -07002417 switch {
2418 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002419 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2420 if !ctx.Config().AllowMissingDependencies() {
2421 ctx.ModuleErrorf("module %q is not a header library", depName)
2422 } else {
2423 ctx.AddMissingDependencies([]string{depName})
2424 }
2425 return
2426 }
Colin Cross6e511a92020-07-27 21:26:48 -07002427 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002428 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2429 if !ctx.Config().AllowMissingDependencies() {
2430 ctx.ModuleErrorf("module %q is not a shared library", depName)
2431 } else {
2432 ctx.AddMissingDependencies([]string{depName})
2433 }
2434 return
2435 }
Jiyong Parke3867542020-12-03 17:28:25 +09002436
Colin Cross0de8a1e2020-09-18 14:15:30 -07002437 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05002438 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002439
Chris Parsons3c27ca32020-11-20 12:42:07 -05002440 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002441 useStubs := false
Colin Cross31076b32020-10-23 17:22:06 -07002442
2443 if lib := moduleLibraryInterface(dep); lib.buildStubs() && c.UseVndk() { // LLNDK
Colin Cross0de8a1e2020-09-18 14:15:30 -07002444 if !apexInfo.IsForPlatform() {
2445 // For platform libraries, use current version of LLNDK
2446 // If this is for use_vendor apex we will apply the same rules
2447 // of apex sdk enforcement below to choose right version.
2448 useStubs = true
2449 }
2450 } else if apexInfo.IsForPlatform() {
2451 // If not building for APEX, use stubs only when it is from
2452 // an APEX (and not from platform)
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002453 // However, for host, ramdisk, vendor_ramdisk, recovery or bootstrap modules,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002454 // always link to non-stub variant
Jiyong Parkf7c3bbe2020-12-09 21:18:56 +09002455 useStubs = dep.(android.ApexModule).NotInPlatform() && !c.bootstrap()
Colin Cross0de8a1e2020-09-18 14:15:30 -07002456 // Another exception: if this module is bundled with an APEX, then
2457 // it is linked with the non-stub variant of a module in the APEX
2458 // as if this is part of the APEX.
2459 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2460 for _, apexContents := range testFor.ApexContents {
2461 if apexContents.DirectlyInApex(depName) {
2462 useStubs = false
2463 break
2464 }
2465 }
2466 } else {
2467 // If building for APEX, use stubs when the parent is in any APEX that
2468 // the child is not in.
2469 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2470 }
2471
2472 // when to use (unspecified) stubs, check min_sdk_version and choose the right one
2473 if useStubs {
2474 sharedLibraryStubsInfo, err :=
Chris Parsons3c27ca32020-11-20 12:42:07 -05002475 c.chooseSdkVersion(ctx, sharedLibraryStubsInfo.SharedStubLibraries, c.apexSdkVersion)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002476 if err != nil {
2477 ctx.OtherModuleErrorf(dep, err.Error())
2478 return
2479 }
2480 sharedLibraryInfo = sharedLibraryStubsInfo.SharedLibraryInfo
2481 depExporterInfo = sharedLibraryStubsInfo.FlagExporterInfo
2482 }
2483 }
2484
Jiyong Park1ad8e162020-12-01 23:40:09 +09002485 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2486 // linkFile, depFile, and ptr.
2487 if c.IsStubs() {
2488 break
2489 }
2490
Colin Cross0de8a1e2020-09-18 14:15:30 -07002491 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2492 depFile = sharedLibraryInfo.TableOfContents
2493
Colin Cross6e511a92020-07-27 21:26:48 -07002494 ptr = &depPaths.SharedLibs
2495 switch libDepTag.Order {
2496 case earlyLibraryDependency:
2497 ptr = &depPaths.EarlySharedLibs
2498 depPtr = &depPaths.EarlySharedLibsDeps
2499 case normalLibraryDependency:
2500 ptr = &depPaths.SharedLibs
2501 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002502 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002503 case lateLibraryDependency:
2504 ptr = &depPaths.LateSharedLibs
2505 depPtr = &depPaths.LateSharedLibsDeps
2506 default:
2507 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002508 }
Colin Cross6e511a92020-07-27 21:26:48 -07002509 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002510 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2511 if !ctx.Config().AllowMissingDependencies() {
2512 ctx.ModuleErrorf("module %q is not a static library", depName)
2513 } else {
2514 ctx.AddMissingDependencies([]string{depName})
2515 }
2516 return
2517 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002518
2519 // Stubs lib doesn't link to the static lib dependencies. Don't set
2520 // linkFile, depFile, and ptr.
2521 if c.IsStubs() {
2522 break
2523 }
2524
Colin Cross0de8a1e2020-09-18 14:15:30 -07002525 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2526 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002527 if libDepTag.wholeStatic {
2528 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002529 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2530 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002531 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002532 // This case normally catches prebuilt static
2533 // libraries, but it can also occur when
2534 // AllowMissingDependencies is on and the
2535 // dependencies has no sources of its own
2536 // but has a whole_static_libs dependency
2537 // on a missing library. We want to depend
2538 // on the .a file so that there is something
2539 // in the dependency tree that contains the
2540 // error rule for the missing transitive
2541 // dependency.
2542 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002543 }
Colin Cross6e511a92020-07-27 21:26:48 -07002544 } else {
2545 switch libDepTag.Order {
2546 case earlyLibraryDependency:
2547 panic(fmt.Errorf("early static libs not suppported"))
2548 case normalLibraryDependency:
2549 // static dependencies will be handled separately so they can be ordered
2550 // using transitive dependencies.
2551 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002552 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002553 case lateLibraryDependency:
2554 ptr = &depPaths.LateStaticLibs
2555 default:
2556 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002557 }
2558 }
2559 }
2560
Colin Cross6e511a92020-07-27 21:26:48 -07002561 if libDepTag.static() && !libDepTag.wholeStatic {
2562 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2563 ctx.ModuleErrorf("module %q not a static library", depName)
2564 return
2565 }
Logan Chien43d34c32017-12-20 01:17:32 +08002566
Colin Cross6e511a92020-07-27 21:26:48 -07002567 // When combining coverage files for shared libraries and executables, coverage files
2568 // in static libraries act as if they were whole static libraries. The same goes for
2569 // source based Abi dump files.
2570 if c, ok := ccDep.(*Module); ok {
2571 staticLib := c.linker.(libraryInterface)
2572 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2573 staticLib.objs().coverageFiles...)
2574 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2575 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002576 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002577 // Handle non-CC modules here
2578 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002579 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002580 }
2581 }
2582
Colin Cross6e511a92020-07-27 21:26:48 -07002583 if ptr != nil {
2584 if !linkFile.Valid() {
2585 if !ctx.Config().AllowMissingDependencies() {
2586 ctx.ModuleErrorf("module %q missing output file", depName)
2587 } else {
2588 ctx.AddMissingDependencies([]string{depName})
2589 }
2590 return
2591 }
2592 *ptr = append(*ptr, linkFile.Path())
2593 }
2594
2595 if depPtr != nil {
2596 dep := depFile
2597 if !dep.Valid() {
2598 dep = linkFile
2599 }
2600 *depPtr = append(*depPtr, dep.Path())
2601 }
2602
Colin Cross0de8a1e2020-09-18 14:15:30 -07002603 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2604 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2605 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2606 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2607
2608 if libDepTag.reexportFlags {
2609 reexportExporter(depExporterInfo)
2610 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2611 // Re-exported shared library headers must be included as well since they can help us with type information
2612 // about template instantiations (instantiated from their headers).
2613 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2614 // scripts.
2615 c.sabi.Properties.ReexportedIncludes = append(
2616 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2617 }
2618
Colin Cross6e511a92020-07-27 21:26:48 -07002619 makeLibName := c.makeLibName(ctx, ccDep, depName) + libDepTag.makeSuffix
2620 switch {
2621 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002622 c.Properties.AndroidMkHeaderLibs = append(
2623 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002624 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002625 if lib := moduleLibraryInterface(dep); lib != nil {
2626 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002627 // Add the dependency to the APEX(es) providing the library so that
2628 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002629 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
2630 for _, an := range depApexInfo.InApexes {
Colin Cross6e511a92020-07-27 21:26:48 -07002631 c.Properties.ApexesProvidingSharedLibs = append(
2632 c.Properties.ApexesProvidingSharedLibs, an)
2633 }
2634 }
2635 }
2636
2637 // Note: the order of libs in this list is not important because
2638 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002639 c.Properties.AndroidMkSharedLibs = append(
2640 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002641 // Record baseLibName for snapshots.
2642 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, baseLibName(depName))
2643 case libDepTag.static():
2644 if libDepTag.wholeStatic {
2645 c.Properties.AndroidMkWholeStaticLibs = append(
2646 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2647 } else {
2648 c.Properties.AndroidMkStaticLibs = append(
2649 c.Properties.AndroidMkStaticLibs, makeLibName)
2650 }
2651 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002652 } else if !c.IsStubs() {
2653 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2654
Colin Cross6e511a92020-07-27 21:26:48 -07002655 switch depTag {
2656 case runtimeDepTag:
2657 c.Properties.AndroidMkRuntimeLibs = append(
2658 c.Properties.AndroidMkRuntimeLibs, c.makeLibName(ctx, ccDep, depName)+libDepTag.makeSuffix)
2659 // Record baseLibName for snapshots.
2660 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, baseLibName(depName))
2661 case objDepTag:
2662 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2663 case CrtBeginDepTag:
2664 depPaths.CrtBegin = linkFile
2665 case CrtEndDepTag:
2666 depPaths.CrtEnd = linkFile
2667 case dynamicLinkerDepTag:
2668 depPaths.DynamicLinker = linkFile
2669 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002670 }
Colin Crossca860ac2016-01-04 14:34:37 -08002671 })
2672
Jeff Gaston294356f2017-09-27 17:05:30 -07002673 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002674 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2675 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2676 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002677
Colin Crossdd84e052017-05-17 13:44:16 -07002678 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002679 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002680 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2681 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002682 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002683 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2684 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002685 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002686 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002687 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002688
2689 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002690 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002691 }
Colin Crossdd84e052017-05-17 13:44:16 -07002692
Colin Crossca860ac2016-01-04 14:34:37 -08002693 return depPaths
2694}
2695
Colin Cross0de8a1e2020-09-18 14:15:30 -07002696// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2697// to match the topological order of the dependency tree, including any static analogues of
2698// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2699// of the transitive dependencies.
2700func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2701 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2702 var staticPaths android.Paths
2703 for _, staticDep := range staticDeps {
2704 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2705 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2706 }
2707 for _, sharedDep := range sharedDeps {
2708 if sharedDep.StaticAnalogue != nil {
2709 transitiveStaticLibsBuilder.Transitive(sharedDep.StaticAnalogue.TransitiveStaticLibrariesForOrdering)
2710 }
2711 }
2712 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2713
2714 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2715
2716 // reorder the dependencies based on transitive dependencies
2717 staticPaths = android.FirstUniquePaths(staticPaths)
2718 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2719
2720 if len(orderedStaticPaths) != len(staticPaths) {
2721 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2722 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2723 }
2724
2725 return orderedStaticPaths, transitiveStaticLibs
2726}
2727
Colin Cross6e511a92020-07-27 21:26:48 -07002728// baseLibName trims known prefixes and suffixes
2729func baseLibName(depName string) string {
2730 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
2731 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00002732 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07002733 return libName
2734}
2735
2736func (c *Module) makeLibName(ctx android.ModuleContext, ccDep LinkableInterface, depName string) string {
2737 vendorSuffixModules := vendorSuffixModules(ctx.Config())
2738 vendorPublicLibraries := vendorPublicLibraries(ctx.Config())
2739
2740 libName := baseLibName(depName)
2741 isLLndk := isLlndkLibrary(libName, ctx.Config())
2742 isVendorPublicLib := inList(libName, *vendorPublicLibraries)
2743 bothVendorAndCoreVariantsExist := ccDep.HasVendorVariant() || isLLndk
2744
2745 if c, ok := ccDep.(*Module); ok {
2746 // Use base module name for snapshots when exporting to Makefile.
2747 if c.isSnapshotPrebuilt() {
2748 baseName := c.BaseModuleName()
2749
2750 if c.IsVndk() {
2751 return baseName + ".vendor"
2752 }
2753
2754 if vendorSuffixModules[baseName] {
2755 return baseName + ".vendor"
2756 } else {
2757 return baseName
2758 }
2759 }
2760 }
2761
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002762 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
2763 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07002764 // The vendor module is a no-vendor-variant VNDK library. Depend on the
2765 // core module instead.
2766 return libName
2767 } else if c.UseVndk() && bothVendorAndCoreVariantsExist {
2768 // The vendor module in Make will have been renamed to not conflict with the core
2769 // module, so update the dependency name here accordingly.
2770 return libName + c.getNameSuffixWithVndkVersion(ctx)
2771 } else if (ctx.Platform() || ctx.ProductSpecific()) && isVendorPublicLib {
2772 return libName + vendorPublicLibrarySuffix
2773 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
2774 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002775 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
2776 return libName + vendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002777 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
2778 return libName + recoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05002779 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Colin Cross6e511a92020-07-27 21:26:48 -07002780 return libName + nativeBridgeSuffix
2781 } else {
2782 return libName
2783 }
2784}
2785
Colin Crossca860ac2016-01-04 14:34:37 -08002786func (c *Module) InstallInData() bool {
2787 if c.installer == nil {
2788 return false
2789 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002790 return c.installer.inData()
2791}
2792
2793func (c *Module) InstallInSanitizerDir() bool {
2794 if c.installer == nil {
2795 return false
2796 }
2797 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07002798 return true
2799 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002800 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08002801}
2802
Yifan Hong1b3348d2020-01-21 15:53:22 -08002803func (c *Module) InstallInRamdisk() bool {
2804 return c.InRamdisk()
2805}
2806
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002807func (c *Module) InstallInVendorRamdisk() bool {
2808 return c.InVendorRamdisk()
2809}
2810
Jiyong Parkf9332f12018-02-01 00:54:12 +09002811func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07002812 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09002813}
2814
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002815func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002816 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002817 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002818 return
2819 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002820 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002821}
2822
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07002823func (c *Module) HostToolPath() android.OptionalPath {
2824 if c.installer == nil {
2825 return android.OptionalPath{}
2826 }
2827 return c.installer.hostToolPath()
2828}
2829
Nan Zhangd4e641b2017-07-12 12:55:28 -07002830func (c *Module) IntermPathForModuleOut() android.OptionalPath {
2831 return c.outputFile
2832}
2833
Colin Cross41955e82019-05-29 14:40:35 -07002834func (c *Module) OutputFiles(tag string) (android.Paths, error) {
2835 switch tag {
2836 case "":
2837 if c.outputFile.Valid() {
2838 return android.Paths{c.outputFile.Path()}, nil
2839 }
2840 return android.Paths{}, nil
2841 default:
2842 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002843 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002844}
2845
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00002846func (c *Module) static() bool {
2847 if static, ok := c.linker.(interface {
2848 static() bool
2849 }); ok {
2850 return static.static()
2851 }
2852 return false
2853}
2854
Jiyong Park379de2f2018-12-19 02:47:14 +09002855func (c *Module) staticBinary() bool {
2856 if static, ok := c.linker.(interface {
2857 staticBinary() bool
2858 }); ok {
2859 return static.staticBinary()
2860 }
2861 return false
2862}
2863
Jiyong Park1d1119f2019-07-29 21:27:18 +09002864func (c *Module) header() bool {
2865 if h, ok := c.linker.(interface {
2866 header() bool
2867 }); ok {
2868 return h.header()
2869 }
2870 return false
2871}
2872
Inseob Kim7f283f42020-06-01 21:53:49 +09002873func (c *Module) binary() bool {
2874 if b, ok := c.linker.(interface {
2875 binary() bool
2876 }); ok {
2877 return b.binary()
2878 }
2879 return false
2880}
2881
Inseob Kim1042d292020-06-01 23:23:05 +09002882func (c *Module) object() bool {
2883 if o, ok := c.linker.(interface {
2884 object() bool
2885 }); ok {
2886 return o.object()
2887 }
2888 return false
2889}
2890
Ivan Lozanof9e21722020-12-02 09:00:51 -05002891func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07002892 if c.UseVndk() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05002893 if ccModule, ok := c.Module().(*Module); ok {
2894 // Only CC modules provide stubs at the moment.
2895 if lib, ok := ccModule.linker.(*llndkStubDecorator); ok {
2896 if Bool(lib.Properties.Vendor_available) {
2897 return "native:vndk"
2898 }
2899 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07002900 }
Colin Crossb60190a2018-09-04 16:28:17 -07002901 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05002902 if c.IsVndk() && !c.IsVndkExt() {
2903 if c.IsVndkPrivate(actx.Config()) {
2904 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09002905 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05002906 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09002907 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05002908 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09002909 return "native:product"
2910 }
Jooyung Han38002912019-05-16 04:01:54 +09002911 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08002912 } else if c.InRamdisk() {
2913 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002914 } else if c.InVendorRamdisk() {
2915 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07002916 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07002917 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05002918 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07002919 return "native:ndk:none:none"
2920 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
2921 //family, link := getNdkStlFamilyAndLinkType(c)
2922 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07002923 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08002924 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07002925 } else {
2926 return "native:platform"
2927 }
2928}
2929
Jiyong Park9d452992018-10-03 00:38:19 +09002930// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01002931// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09002932func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07002933 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09002934 // Stub libs and prebuilt libs in a versioned SDK are not
2935 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07002936 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01002937 } else if _, ok := c.linker.(testPerSrc); ok {
2938 return true
Jiyong Park9d452992018-10-03 00:38:19 +09002939 }
2940 return false
2941}
2942
Jiyong Parka90ca002019-10-07 15:47:24 +09002943func (c *Module) AvailableFor(what string) bool {
2944 if linker, ok := c.linker.(interface {
2945 availableFor(string) bool
2946 }); ok {
2947 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
2948 } else {
2949 return c.ApexModuleBase.AvailableFor(what)
2950 }
2951}
2952
Jiyong Park62304bb2020-04-13 16:19:48 +09002953func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09002954 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09002955}
2956
Colin Crossaede88c2020-08-11 12:17:01 -07002957func (c *Module) UniqueApexVariations() bool {
2958 if u, ok := c.compiler.(interface {
2959 uniqueApexVariations() bool
2960 }); ok {
2961 return u.uniqueApexVariations()
2962 } else {
2963 return false
2964 }
2965}
2966
Paul Duffin0cb37b92020-03-04 14:52:46 +00002967// Return true if the module is ever installable.
2968func (c *Module) EverInstallable() bool {
2969 return c.installer != nil &&
2970 // Check to see whether the module is actually ever installable.
2971 c.installer.everInstallable()
2972}
2973
Colin Cross56a83212020-09-15 18:30:11 -07002974func (c *Module) installable(apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00002975 ret := c.EverInstallable() &&
2976 // Check to see whether the module has been configured to not be installed.
2977 proptools.BoolDefault(c.Properties.Installable, true) &&
2978 !c.Properties.PreventInstall && c.outputFile.Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002979
2980 // The platform variant doesn't need further condition. Apex variants however might not
2981 // be installable because it will likely to be included in the APEX and won't appear
2982 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07002983 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002984 return ret
2985 }
2986
2987 // Special case for modules that are configured to be installed to /data, which includes
2988 // test modules. For these modules, both APEX and non-APEX variants are considered as
2989 // installable. This is because even the APEX variants won't be included in the APEX, but
2990 // will anyway be installed to /data/*.
2991 // See b/146995717
2992 if c.InstallInData() {
2993 return ret
2994 }
2995
2996 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09002997}
2998
Logan Chien41eabe62019-04-10 13:33:58 +08002999func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3000 if c.linker != nil {
3001 if library, ok := c.linker.(*libraryDecorator); ok {
3002 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3003 }
3004 }
3005}
3006
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003007func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003008 depTag := ctx.OtherModuleDependencyTag(dep)
3009 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3010
3011 if cc, ok := dep.(*Module); ok {
3012 if cc.HasStubsVariants() {
3013 if isLibDepTag && libDepTag.shared() {
3014 // dynamic dep to a stubs lib crosses APEX boundary
3015 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003016 }
Colin Cross6e511a92020-07-27 21:26:48 -07003017 if IsRuntimeDepTag(depTag) {
3018 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003019 return false
3020 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003021 }
Colin Crossaac32222020-07-29 12:51:56 -07003022 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003023 // shared_lib dependency from a static lib is considered as crossing
3024 // the APEX boundary because the dependency doesn't actually is
3025 // linked; the dependency is used only during the compilation phase.
3026 return false
3027 }
Jiyong Parke3867542020-12-03 17:28:25 +09003028
3029 if isLibDepTag && libDepTag.excludeInApex {
3030 return false
3031 }
Colin Cross6e511a92020-07-27 21:26:48 -07003032 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003033 if depTag == stubImplDepTag || depTag == llndkImplDep {
3034 // We don't track beyond LLNDK or from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003035 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003036 }
3037 return true
3038}
3039
Dan Albertc8060532020-07-22 22:32:17 -07003040func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3041 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003042 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3043 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3044 return nil
3045 }
3046 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3047 if c.ToolchainLibrary() {
3048 return nil
3049 }
3050 // We don't check for prebuilt modules
3051 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3052 return nil
3053 }
3054 minSdkVersion := c.MinSdkVersion()
3055 if minSdkVersion == "apex_inherit" {
3056 return nil
3057 }
3058 if minSdkVersion == "" {
3059 // JNI libs within APK-in-APEX fall into here
3060 // Those are okay to set sdk_version instead
3061 // We don't have to check if this is a SDK variant because
3062 // non-SDK variant resets sdk_version, which works too.
3063 minSdkVersion = c.SdkVersion()
3064 }
Dan Albertc8060532020-07-22 22:32:17 -07003065 if minSdkVersion == "" {
3066 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3067 }
3068 // Not using nativeApiLevelFromUser because the context here is not
3069 // necessarily a native context.
3070 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003071 if err != nil {
3072 return err
3073 }
Dan Albertc8060532020-07-22 22:32:17 -07003074
3075 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003076 return fmt.Errorf("newer SDK(%v)", ver)
3077 }
3078 return nil
3079}
3080
Colin Cross2ba19d92015-05-07 15:44:20 -07003081//
Colin Crosscfad1192015-11-02 16:43:11 -08003082// Defaults
3083//
Colin Crossca860ac2016-01-04 14:34:37 -08003084type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003085 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003086 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003087 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003088}
3089
Patrice Arrudac249c712019-03-19 17:00:29 -07003090// cc_defaults provides a set of properties that can be inherited by other cc
3091// modules. A module can use the properties from a cc_defaults using
3092// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3093// merged (when possible) by prepending the default module's values to the
3094// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003095func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003096 return DefaultsFactory()
3097}
3098
Colin Cross36242852017-06-23 15:06:31 -07003099func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003100 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003101
Colin Cross36242852017-06-23 15:06:31 -07003102 module.AddProperties(props...)
3103 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003104 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003105 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003106 &BaseCompilerProperties{},
3107 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003108 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003109 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003110 &StaticProperties{},
3111 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003112 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003113 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003114 &TestProperties{},
3115 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003116 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003117 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003118 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003119 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003120 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003121 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003122 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003123 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003124 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003125 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003126 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003127 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003128 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003129 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3130 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003131 )
Colin Crosscfad1192015-11-02 16:43:11 -08003132
Jooyung Hancc372c52019-09-25 15:18:44 +09003133 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003134
3135 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003136}
3137
Jiyong Park2286afd2020-06-16 21:58:53 +09003138func (c *Module) IsSdkVariant() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07003139 return c.Properties.IsSdkVariant || c.AlwaysSdk()
Jiyong Park2286afd2020-06-16 21:58:53 +09003140}
3141
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003142func kytheExtractAllFactory() android.Singleton {
3143 return &kytheExtractAllSingleton{}
3144}
3145
3146type kytheExtractAllSingleton struct {
3147}
3148
3149func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3150 var xrefTargets android.Paths
3151 ctx.VisitAllModules(func(module android.Module) {
3152 if ccModule, ok := module.(xref); ok {
3153 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3154 }
3155 })
3156 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3157 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003158 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003159 }
3160}
3161
Colin Cross06a931b2015-10-28 17:23:31 -07003162var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003163var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003164var BoolPtr = proptools.BoolPtr
3165var String = proptools.String
3166var StringPtr = proptools.StringPtr