blob: a2d6cd9314bae9bba8b9c283e21c546fe96a9e62 [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()
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -080082 ctx.TopDown("vndk_deps", sabiDepsMutator)
Stephen Craneba090d12017-05-09 15:44:35 -070083
84 ctx.TopDown("lto_deps", ltoDepsMutator)
85 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090086
Jooyung Han479ca172020-10-19 18:51:07 +090087 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090088 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070089 })
Colin Crossb98c8b02016-07-29 13:44:28 -070090
Sasha Smundak2a4549e2018-11-05 16:49:08 -080091 android.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070092}
93
Colin Crossca860ac2016-01-04 14:34:37 -080094type Deps struct {
95 SharedLibs, LateSharedLibs []string
96 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080097 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +080098 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -070099
Chris Parsons79d66a52020-06-05 17:26:16 -0400100 // Used for data dependencies adjacent to tests
101 DataLibs []string
102
Yo Chiang219968c2020-09-22 18:45:04 +0800103 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
104 SystemSharedLibs []string
105
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800106 StaticUnwinderIfLegacy bool
107
Colin Cross5950f382016-12-13 12:50:57 -0800108 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700109
Colin Cross81413472016-04-11 14:37:39 -0700110 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700111
Dan Willemsenb40aab62016-04-20 14:21:14 -0700112 GeneratedSources []string
113 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900114 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700115
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700116 ReexportGeneratedHeaders []string
117
Colin Cross97ba0732015-03-23 17:50:24 -0700118 CrtBegin, CrtEnd string
Dan Willemsena0790e32018-10-12 00:24:23 -0700119
120 // Used for host bionic
121 LinkerFlagsFile string
122 DynamicLinker string
Colin Crossc472d572015-03-17 15:06:21 -0700123}
124
Colin Crossca860ac2016-01-04 14:34:37 -0800125type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700126 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900127 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700128 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900129 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700130 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700131 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700132
Colin Cross0de8a1e2020-09-18 14:15:30 -0700133 // Transitive static library dependencies of static libraries for use in ordering.
134 TranstiveStaticLibrariesForOrdering *android.DepSet
135
Colin Cross26c34ed2016-09-30 17:10:16 -0700136 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100137 Objs Objects
138 // Paths to .o files in dependencies that provide them. Note that these lists
139 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800140 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700141 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700142
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100143 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
144 // the libs from all whole_static_lib dependencies.
145 WholeStaticLibsFromPrebuilts android.Paths
146
Colin Cross26c34ed2016-09-30 17:10:16 -0700147 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700148 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900149 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700150
Inseob Kimd110f872019-12-06 13:15:38 +0900151 Flags []string
152 IncludeDirs android.Paths
153 SystemIncludeDirs android.Paths
154 ReexportedDirs android.Paths
155 ReexportedSystemDirs android.Paths
156 ReexportedFlags []string
157 ReexportedGeneratedHeaders android.Paths
158 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700159
Colin Cross26c34ed2016-09-30 17:10:16 -0700160 // Paths to crt*.o files
Colin Cross635c3b02016-05-18 15:37:25 -0700161 CrtBegin, CrtEnd android.OptionalPath
Dan Willemsena0790e32018-10-12 00:24:23 -0700162
163 // Path to the file container flags to use with the linker
164 LinkerFlagsFile android.OptionalPath
165
166 // Path to the dynamic linker binary
167 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700168}
169
Colin Cross4af21ed2019-11-04 09:37:55 -0800170// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
171// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
172// command line so they can be overridden by the local module flags).
173type LocalOrGlobalFlags struct {
174 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700175 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800176 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700177 CFlags []string // Flags that apply to C and C++ source files
178 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
179 ConlyFlags []string // Flags that apply to C source files
180 CppFlags []string // Flags that apply to C++ source files
181 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700182 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800183}
184
185type Flags struct {
186 Local LocalOrGlobalFlags
187 Global LocalOrGlobalFlags
188
189 aidlFlags []string // Flags that apply to aidl source files
190 rsFlags []string // Flags that apply to renderscript source files
191 libFlags []string // Flags to add libraries early to the link order
192 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
193 TidyFlags []string // Flags that apply to clang-tidy
194 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700195
Colin Crossc3199482017-03-30 15:03:04 -0700196 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800197 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700198 SystemIncludeFlags []string
199
Oliver Nguyen04526782020-04-21 12:40:27 -0700200 Toolchain config.Toolchain
201 Tidy bool
202 GcovCoverage bool
203 SAbiDump bool
204 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800205
206 RequiredInstructionSet string
Colin Cross16b23492016-01-06 14:41:07 -0800207 DynamicLinker string
208
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700209 CFlagsDeps android.Paths // Files depended on by compiler flags
210 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800211
Dan Willemsen98ab3112019-08-27 21:20:40 -0700212 AssemblerWithCpp bool
213 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800214
Colin Cross19878da2019-03-28 14:45:07 -0700215 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700216 protoC bool // Whether to use C instead of C++
217 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700218
219 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200220 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700221}
222
Colin Crossca860ac2016-01-04 14:34:37 -0800223// Properties used to compile all C or C++ modules
224type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700225 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800226 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700227
Colin Crossc511bc52020-04-07 16:50:32 +0000228 // Minimum sdk version supported when compiling against the ndk. Setting this property causes
229 // two variants to be built, one for the platform and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800230 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700231
Jooyung Han379660c2020-04-21 15:24:00 +0900232 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
233 Min_sdk_version *string
234
Colin Crossc511bc52020-04-07 16:50:32 +0000235 // If true, always create an sdk variant and don't create a platform variant.
236 Sdk_variant_only *bool
237
Jiyong Parkde866cb2018-12-07 23:08:36 +0900238 AndroidMkSharedLibs []string `blueprint:"mutated"`
239 AndroidMkStaticLibs []string `blueprint:"mutated"`
240 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
241 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700242 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900243 HideFromMake bool `blueprint:"mutated"`
244 PreventInstall bool `blueprint:"mutated"`
245 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700246
Yo Chiang219968c2020-09-22 18:45:04 +0800247 // Set by DepsMutator.
248 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
249
Justin Yun5f7f7e82019-11-18 19:52:14 +0900250 ImageVariationPrefix string `blueprint:"mutated"`
251 VndkVersion string `blueprint:"mutated"`
252 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800253
254 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
255 // file
256 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900257
Yifan Hong39143a92020-10-26 12:43:12 -0700258 // Make this module available when building for ramdisk.
259 // On device without a dedicated recovery partition, the module is only
260 // available after switching root into
261 // /first_stage_ramdisk. To expose the module before switching root, install
262 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800263 Ramdisk_available *bool
264
Yifan Hong39143a92020-10-26 12:43:12 -0700265 // Make this module available when building for vendor ramdisk.
266 // On device without a dedicated recovery partition, the module is only
267 // available after switching root into
268 // /first_stage_ramdisk. To expose the module before switching root, install
269 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700270 Vendor_ramdisk_available *bool
271
Jiyong Parkf9332f12018-02-01 00:54:12 +0900272 // Make this module available when building for recovery
273 Recovery_available *bool
274
Colin Crossae6c5202019-11-20 13:35:50 -0800275 // Set by imageMutator
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700276 CoreVariantNeeded bool `blueprint:"mutated"`
277 RamdiskVariantNeeded bool `blueprint:"mutated"`
278 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
279 RecoveryVariantNeeded bool `blueprint:"mutated"`
280 ExtraVariants []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900281
282 // Allows this module to use non-APEX version of libraries. Useful
283 // for building binaries that are started before APEXes are activated.
284 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900285
286 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
287 // see soong/cc/config/vndk.go
288 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900289
290 // Used by vendor snapshot to record dependencies from snapshot modules.
291 SnapshotSharedLibs []string `blueprint:"mutated"`
292 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000293
294 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000295
296 // Set by factories of module types that can only be referenced from variants compiled against
297 // the SDK.
298 AlwaysSdk bool `blueprint:"mutated"`
299
300 // Variant is an SDK variant created by sdkMutator
301 IsSdkVariant bool `blueprint:"mutated"`
302 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
303 // variant to have a ".sdk" suffix.
304 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700305
306 // Normally Soong uses the directory structure to decide which modules
307 // should be included (framework) or excluded (non-framework) from the
Jose Galmesf7294582020-11-13 12:07:36 -0800308 // different snapshots (vendor, recovery, etc.), but these properties
309 // allow a partner to exclude a module normally thought of as a
310 // framework module from a snapshot.
311 Exclude_from_vendor_snapshot *bool
312 Exclude_from_recovery_snapshot *bool
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700313}
314
315type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900316 // whether this module should be allowed to be directly depended by other
317 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900318 // If set to true, two variants will be built separately, one like
319 // normal, and the other limited to the set of libraries and headers
320 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700321 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900322 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700323 // so it shouldn't have any unversioned runtime dependencies, or
324 // make assumptions about the system that may not be true in the
325 // future.
326 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900327 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900328 //
329 // Default value is true when vndk: {enabled: true} or vendor: true.
330 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700331 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
332 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900333
Justin Yun63e9ec72020-10-29 16:49:43 +0900334 // whether this module should be allowed to be directly depended by other
335 // modules with `product_specific: true` or `product_available: true`.
336 // If set to true, an additional product variant will be built separately
337 // that is limited to the set of libraries and headers that are exposed to
338 // /product modules.
339 //
340 // The product variant may be used with a different (newer) /system,
341 // so it shouldn't have any unversioned runtime dependencies, or
342 // make assumptions about the system that may not be true in the
343 // future.
344 //
345 // It must be set to true by default for vndk: {enabled: true} modules.
346 //
347 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
348 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
349 Product_available *bool
350
Jiyong Park5fb8c102018-04-09 12:03:06 +0900351 // whether this module is capable of being loaded with other instance
352 // (possibly an older version) of the same module in the same process.
353 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
354 // can be double loaded in a vendor process if the library is also a
355 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
356 // explicitly marked as `double_loadable: true` by the owner, or the dependency
357 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
358 Double_loadable *bool
Colin Crossca860ac2016-01-04 14:34:37 -0800359}
360
Colin Crossca860ac2016-01-04 14:34:37 -0800361type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800362 static() bool
363 staticBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900364 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900365 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900366 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700367 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900368 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700369 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800370 sdkVersion() string
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700371 useVndk() bool
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800372 isNdk() bool
Inseob Kim9516ee92019-05-09 10:56:13 +0900373 isLlndk(config android.Config) bool
374 isLlndkPublic(config android.Config) bool
375 isVndkPrivate(config android.Config) bool
Justin Yun8effde42017-06-23 19:24:43 +0900376 isVndk() bool
377 isVndkSp() bool
Logan Chienf3511742017-10-31 18:04:35 +0800378 isVndkExt() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900379 inProduct() bool
380 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800381 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700382 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900383 inRecovery() bool
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +0800384 shouldCreateSourceAbiDump() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700385 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700386 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800387 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800388 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800389 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800390 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800391 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700392 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700393 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900394 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800395 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700396 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700397 directlyInAnyApex() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800398}
399
400type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700401 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800402 ModuleContextIntf
403}
404
405type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700406 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800407 ModuleContextIntf
408}
409
Colin Cross37047f12016-12-13 17:06:13 -0800410type DepsContext interface {
411 android.BottomUpMutatorContext
412 ModuleContextIntf
413}
414
Colin Crossca860ac2016-01-04 14:34:37 -0800415type feature interface {
416 begin(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800417 deps(ctx DepsContext, deps Deps) Deps
Colin Crossca860ac2016-01-04 14:34:37 -0800418 flags(ctx ModuleContext, flags Flags) Flags
419 props() []interface{}
420}
421
422type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700423 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800424 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800425 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700426 compilerProps() []interface{}
427
Colin Cross76fada02016-07-27 10:31:13 -0700428 appendCflags([]string)
429 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700430 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800431}
432
433type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700434 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800435 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700436 linkerFlags(ctx ModuleContext, flags Flags) Flags
437 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800438 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700439
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700440 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700441 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900442 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700443
444 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900445 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000446
447 // Get the deps that have been explicitly specified in the properties.
448 // Only updates the
449 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
450}
451
452type specifiedDeps struct {
453 sharedLibs []string
Martin Stjernholm10566a02020-03-24 01:19:52 +0000454 systemSharedLibs []string // Note nil and [] are semantically distinct.
Colin Crossca860ac2016-01-04 14:34:37 -0800455}
456
457type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700458 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700459 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000460 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800461 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700462 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700463 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900464 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100465 makeUninstallable(mod *Module)
Colin Crossca860ac2016-01-04 14:34:37 -0800466}
467
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800468type xref interface {
469 XrefCcFiles() android.Paths
470}
471
Colin Cross6e511a92020-07-27 21:26:48 -0700472type libraryDependencyKind int
473
474const (
475 headerLibraryDependency = iota
476 sharedLibraryDependency
477 staticLibraryDependency
478)
479
480func (k libraryDependencyKind) String() string {
481 switch k {
482 case headerLibraryDependency:
483 return "headerLibraryDependency"
484 case sharedLibraryDependency:
485 return "sharedLibraryDependency"
486 case staticLibraryDependency:
487 return "staticLibraryDependency"
488 default:
489 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
490 }
491}
492
493type libraryDependencyOrder int
494
495const (
496 earlyLibraryDependency = -1
497 normalLibraryDependency = 0
498 lateLibraryDependency = 1
499)
500
501func (o libraryDependencyOrder) String() string {
502 switch o {
503 case earlyLibraryDependency:
504 return "earlyLibraryDependency"
505 case normalLibraryDependency:
506 return "normalLibraryDependency"
507 case lateLibraryDependency:
508 return "lateLibraryDependency"
509 default:
510 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
511 }
512}
513
514// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
515// tags that have a set of predefined tag objects that are reused for each dependency, a
516// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
517// That means that comparing a libraryDependencyTag for equality will only be equal if all
518// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
519// then check individual metadata fields instead.
520type libraryDependencyTag struct {
521 blueprint.BaseDependencyTag
522
523 // These are exported so that fmt.Printf("%#v") can call their String methods.
524 Kind libraryDependencyKind
525 Order libraryDependencyOrder
526
527 wholeStatic bool
528
529 reexportFlags bool
530 explicitlyVersioned bool
531 dataLib bool
532 ndk bool
533
534 staticUnwinder bool
535
536 makeSuffix string
537}
538
539// header returns true if the libraryDependencyTag is tagging a header lib dependency.
540func (d libraryDependencyTag) header() bool {
541 return d.Kind == headerLibraryDependency
542}
543
544// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
545func (d libraryDependencyTag) shared() bool {
546 return d.Kind == sharedLibraryDependency
547}
548
549// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
550func (d libraryDependencyTag) static() bool {
551 return d.Kind == staticLibraryDependency
552}
553
554// dependencyTag is used for tagging miscellanous dependency types that don't fit into
555// libraryDependencyTag. Each tag object is created globally and reused for multiple
556// dependencies (although since the object contains no references, assigning a tag to a
557// variable and modifying it will not modify the original). Users can compare the tag
558// returned by ctx.OtherModuleDependencyTag against the global original
559type dependencyTag struct {
560 blueprint.BaseDependencyTag
561 name string
562}
563
Colin Crossc99deeb2016-04-11 15:06:20 -0700564var (
Colin Cross6e511a92020-07-27 21:26:48 -0700565 genSourceDepTag = dependencyTag{name: "gen source"}
566 genHeaderDepTag = dependencyTag{name: "gen header"}
567 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
568 objDepTag = dependencyTag{name: "obj"}
569 linkerFlagsDepTag = dependencyTag{name: "linker flags file"}
570 dynamicLinkerDepTag = dependencyTag{name: "dynamic linker"}
571 reuseObjTag = dependencyTag{name: "reuse objects"}
572 staticVariantTag = dependencyTag{name: "static variant"}
573 vndkExtDepTag = dependencyTag{name: "vndk extends"}
574 dataLibDepTag = dependencyTag{name: "data lib"}
575 runtimeDepTag = dependencyTag{name: "runtime lib"}
576 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700577 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700578)
579
Colin Cross56a83212020-09-15 18:30:11 -0700580type copyDirectlyInAnyApexDependencyTag dependencyTag
581
582func (copyDirectlyInAnyApexDependencyTag) CopyDirectlyInAnyApex() {}
583
584var _ android.CopyDirectlyInAnyApexTag = copyDirectlyInAnyApexDependencyTag{}
585
Roland Levillainf89cd092019-07-29 16:22:59 +0100586func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700587 ccLibDepTag, ok := depTag.(libraryDependencyTag)
588 return ok && ccLibDepTag.shared()
589}
590
591func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
592 ccLibDepTag, ok := depTag.(libraryDependencyTag)
593 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100594}
595
Zach Johnson3df4e632020-11-06 11:56:27 -0800596func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
597 ccLibDepTag, ok := depTag.(libraryDependencyTag)
598 return ok && ccLibDepTag.header()
599}
600
Roland Levillainf89cd092019-07-29 16:22:59 +0100601func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700602 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100603 return ok && ccDepTag == runtimeDepTag
604}
605
606func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700607 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100608 return ok && ccDepTag == testPerSrcDepTag
609}
610
Colin Crossca860ac2016-01-04 14:34:37 -0800611// Module contains the properties and members used by all C/C++ module types, and implements
612// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
613// to construct the output file. Behavior can be customized with a Customizer interface
614type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700615 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700616 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900617 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900618 android.SdkBase
Colin Crossc472d572015-03-17 15:06:21 -0700619
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700620 Properties BaseProperties
621 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700622
Colin Crossca860ac2016-01-04 14:34:37 -0800623 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700624 hod android.HostOrDeviceSupported
625 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700626
Paul Duffina0843f62019-12-13 19:50:38 +0000627 // Allowable SdkMemberTypes of this module type.
628 sdkMemberTypes []android.SdkMemberType
629
Colin Crossca860ac2016-01-04 14:34:37 -0800630 // delegates, initialize before calling Init
Colin Crossb4ce0ec2016-09-13 13:41:39 -0700631 features []feature
632 compiler compiler
633 linker linker
634 installer installer
635 stl *stl
636 sanitize *sanitize
Dan Willemsen581341d2017-02-09 16:16:31 -0800637 coverage *coverage
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800638 sabi *sabi
Justin Yun8effde42017-06-23 19:24:43 +0900639 vndkdep *vndkdep
Stephen Craneba090d12017-05-09 15:44:35 -0700640 lto *lto
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700641 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800642
Colin Cross31076b32020-10-23 17:22:06 -0700643 library libraryInterface
644
Colin Cross635c3b02016-05-18 15:37:25 -0700645 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800646
Colin Crossb98c8b02016-07-29 13:44:28 -0700647 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700648
649 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800650
651 // Flags used to compile this module
652 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700653
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800654 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700655 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900656
657 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800658 // Kythe (source file indexer) paths for this compilation module
659 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900660
661 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700662 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700663
664 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700665}
666
Ivan Lozano52767be2019-10-18 14:49:46 -0700667func (c *Module) Toc() android.OptionalPath {
668 if c.linker != nil {
669 if library, ok := c.linker.(libraryInterface); ok {
670 return library.toc()
671 }
672 }
673 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
674}
675
676func (c *Module) ApiLevel() string {
677 if c.linker != nil {
678 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700679 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700680 }
681 }
682 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
683}
684
685func (c *Module) Static() bool {
686 if c.linker != nil {
687 if library, ok := c.linker.(libraryInterface); ok {
688 return library.static()
689 }
690 }
691 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
692}
693
694func (c *Module) Shared() bool {
695 if c.linker != nil {
696 if library, ok := c.linker.(libraryInterface); ok {
697 return library.shared()
698 }
699 }
700 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
701}
702
703func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000704 if c.stl != nil {
705 return c.stl.Properties.SelectedStl
706 }
707 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700708}
709
710func (c *Module) ToolchainLibrary() bool {
711 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
712 return true
713 }
714 return false
715}
716
717func (c *Module) NdkPrebuiltStl() bool {
718 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
719 return true
720 }
721 return false
722}
723
724func (c *Module) StubDecorator() bool {
725 if _, ok := c.linker.(*stubDecorator); ok {
726 return true
727 }
728 return false
729}
730
731func (c *Module) SdkVersion() string {
732 return String(c.Properties.Sdk_version)
733}
734
Artur Satayev480e25b2020-04-27 18:53:18 +0100735func (c *Module) MinSdkVersion() string {
736 return String(c.Properties.Min_sdk_version)
737}
738
Dan Albert92fe7402020-07-15 13:33:30 -0700739func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700740 if !c.canUseSdk() {
741 return false
742 }
Dan Albert92fe7402020-07-15 13:33:30 -0700743 if linker, ok := c.linker.(*objectLinker); ok {
744 return linker.isCrt()
745 }
746 return false
747}
748
Colin Crossc511bc52020-04-07 16:50:32 +0000749func (c *Module) AlwaysSdk() bool {
750 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
751}
752
Ivan Lozano183a3212019-10-18 14:18:45 -0700753func (c *Module) CcLibrary() bool {
754 if c.linker != nil {
755 if _, ok := c.linker.(*libraryDecorator); ok {
756 return true
757 }
Colin Crossd48fe732020-09-23 20:37:24 -0700758 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
759 return true
760 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700761 }
762 return false
763}
764
765func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700766 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700767 return true
768 }
769 return false
770}
771
Ivan Lozano2b262972019-11-21 12:30:50 -0800772func (c *Module) NonCcVariants() bool {
773 return false
774}
775
Ivan Lozano183a3212019-10-18 14:18:45 -0700776func (c *Module) SetStatic() {
777 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700778 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700779 library.setStatic()
780 return
781 }
782 }
783 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
784}
785
786func (c *Module) SetShared() {
787 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700788 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700789 library.setShared()
790 return
791 }
792 }
793 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
794}
795
796func (c *Module) BuildStaticVariant() bool {
797 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700798 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700799 return library.buildStatic()
800 }
801 }
802 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
803}
804
805func (c *Module) BuildSharedVariant() bool {
806 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700807 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700808 return library.buildShared()
809 }
810 }
811 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
812}
813
814func (c *Module) Module() android.Module {
815 return c
816}
817
Jiyong Parkc20eee32018-09-05 22:36:17 +0900818func (c *Module) OutputFile() android.OptionalPath {
819 return c.outputFile
820}
821
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400822func (c *Module) CoverageFiles() android.Paths {
823 if c.linker != nil {
824 if library, ok := c.linker.(libraryInterface); ok {
825 return library.objs().coverageFiles
826 }
827 }
828 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
829}
830
Ivan Lozano183a3212019-10-18 14:18:45 -0700831var _ LinkableInterface = (*Module)(nil)
832
Jiyong Park719b4462019-01-13 00:39:51 +0900833func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900834 if c.linker != nil {
835 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +0900836 }
837 return nil
838}
839
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900840func (c *Module) CoverageOutputFile() android.OptionalPath {
841 if c.linker != nil {
842 return c.linker.coverageOutputFilePath()
843 }
844 return android.OptionalPath{}
845}
846
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900847func (c *Module) RelativeInstallPath() string {
848 if c.installer != nil {
849 return c.installer.relativeInstallPath()
850 }
851 return ""
852}
853
Jooyung Han344d5432019-08-23 11:17:39 +0900854func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +0900855 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +0900856}
857
Colin Cross36242852017-06-23 15:06:31 -0700858func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -0700859 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -0800860 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -0700861 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800862 }
863 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -0700864 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800865 }
866 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -0700867 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800868 }
Colin Crossa8e07cc2016-04-04 15:07:06 -0700869 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -0700870 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -0700871 }
Colin Cross16b23492016-01-06 14:41:07 -0800872 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -0700873 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -0800874 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800875 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -0700876 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -0800877 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800878 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -0700879 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800880 }
Justin Yun8effde42017-06-23 19:24:43 +0900881 if c.vndkdep != nil {
882 c.AddProperties(c.vndkdep.props()...)
883 }
Stephen Craneba090d12017-05-09 15:44:35 -0700884 if c.lto != nil {
885 c.AddProperties(c.lto.props()...)
886 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700887 if c.pgo != nil {
888 c.AddProperties(c.pgo.props()...)
889 }
Colin Crossca860ac2016-01-04 14:34:37 -0800890 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -0700891 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800892 }
Colin Crossc472d572015-03-17 15:06:21 -0700893
Jiyong Park1613e552020-09-14 19:43:17 +0900894 c.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, os android.OsType) bool {
Elliott Hughes79ae3412020-04-17 15:49:49 -0700895 // Windows builds always prefer 32-bit
Jiyong Park1613e552020-09-14 19:43:17 +0900896 return os == android.Windows
Colin Crossa9d8bee2018-10-02 13:59:46 -0700897 })
Colin Cross36242852017-06-23 15:06:31 -0700898 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +0900899 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900900 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +0900901 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +0900902
Colin Cross36242852017-06-23 15:06:31 -0700903 return c
Colin Crossc472d572015-03-17 15:06:21 -0700904}
905
Colin Crossb916a382016-07-29 17:28:03 -0700906// Returns true for dependency roots (binaries)
907// TODO(ccross): also handle dlopenable libraries
908func (c *Module) isDependencyRoot() bool {
909 if root, ok := c.linker.(interface {
910 isDependencyRoot() bool
911 }); ok {
912 return root.isDependencyRoot()
913 }
914 return false
915}
916
Justin Yun5f7f7e82019-11-18 19:52:14 +0900917// Returns true if the module is using VNDK libraries instead of the libraries in /system/lib or /system/lib64.
918// "product" and "vendor" variant modules return true for this function.
919// When BOARD_VNDK_VERSION is set, vendor variants of "vendor_available: true", "vendor: true",
920// "soc_specific: true" and more vendor installed modules are included here.
Justin Yun63e9ec72020-10-29 16:49:43 +0900921// When PRODUCT_PRODUCT_VNDK_VERSION is set, product variants of "product_available: true" or
Justin Yun5f7f7e82019-11-18 19:52:14 +0900922// "product_specific: true" modules are included here.
Ivan Lozano52767be2019-10-18 14:49:46 -0700923func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +0900924 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700925}
926
Colin Crossc511bc52020-04-07 16:50:32 +0000927func (c *Module) canUseSdk() bool {
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700928 return c.Os() == android.Android && !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +0000929}
930
931func (c *Module) UseSdk() bool {
932 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -0700933 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +0000934 }
935 return false
936}
937
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800938func (c *Module) isCoverageVariant() bool {
939 return c.coverage.Properties.IsCoverageVariant
940}
941
Peter Collingbournead84f972019-12-17 16:46:18 -0800942func (c *Module) IsNdk() bool {
Colin Crossf0913fb2020-07-29 12:59:39 -0700943 return inList(c.BaseModuleName(), ndkKnownLibs)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800944}
945
Inseob Kim9516ee92019-05-09 10:56:13 +0900946func (c *Module) isLlndk(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800947 // Returns true for both LLNDK (public) and LLNDK-private libs.
Jooyung Han0302a842019-10-30 18:43:49 +0900948 return isLlndkLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800949}
950
Inseob Kim9516ee92019-05-09 10:56:13 +0900951func (c *Module) isLlndkPublic(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800952 // Returns true only for LLNDK (public) libs.
Jooyung Han0302a842019-10-30 18:43:49 +0900953 name := c.BaseModuleName()
954 return isLlndkLibrary(name, config) && !isVndkPrivateLibrary(name, config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800955}
956
Inseob Kim9516ee92019-05-09 10:56:13 +0900957func (c *Module) isVndkPrivate(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800958 // Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Jooyung Han0302a842019-10-30 18:43:49 +0900959 return isVndkPrivateLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800960}
961
Ivan Lozano52767be2019-10-18 14:49:46 -0700962func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +0800963 if vndkdep := c.vndkdep; vndkdep != nil {
964 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +0900965 }
966 return false
967}
968
Yi Kong7e53c572018-02-14 18:16:12 +0800969func (c *Module) isPgoCompile() bool {
970 if pgo := c.pgo; pgo != nil {
971 return pgo.Properties.PgoCompile
972 }
973 return false
974}
975
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800976func (c *Module) isNDKStubLibrary() bool {
977 if _, ok := c.compiler.(*stubDecorator); ok {
978 return true
979 }
980 return false
981}
982
Logan Chienf3511742017-10-31 18:04:35 +0800983func (c *Module) isVndkSp() bool {
984 if vndkdep := c.vndkdep; vndkdep != nil {
985 return vndkdep.isVndkSp()
986 }
987 return false
988}
989
990func (c *Module) isVndkExt() bool {
991 if vndkdep := c.vndkdep; vndkdep != nil {
992 return vndkdep.isVndkExt()
993 }
994 return false
995}
996
Ivan Lozano52767be2019-10-18 14:49:46 -0700997func (c *Module) MustUseVendorVariant() bool {
Jooyung Han097087b2019-10-22 19:32:18 +0900998 return c.isVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -0800999}
1000
Logan Chienf3511742017-10-31 18:04:35 +08001001func (c *Module) getVndkExtendsModuleName() string {
1002 if vndkdep := c.vndkdep; vndkdep != nil {
1003 return vndkdep.getVndkExtendsModuleName()
1004 }
1005 return ""
1006}
1007
Jiyong Park25fc6a92018-11-18 18:02:45 +09001008func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001009 if lib := c.library; lib != nil {
1010 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001011 }
1012 return false
1013}
1014
1015func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001016 if lib := c.library; lib != nil {
1017 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001018 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001019 return false
1020}
1021
Colin Cross0477b422020-10-13 18:43:54 -07001022// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1023// the implementation. If it is an implementation library it returns its own name.
1024func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1025 name := ctx.OtherModuleName(c)
1026 if versioned, ok := c.linker.(versionedInterface); ok {
1027 name = versioned.implementationModuleName(name)
1028 }
1029 return name
1030}
1031
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001032func (c *Module) bootstrap() bool {
1033 return Bool(c.Properties.Bootstrap)
1034}
1035
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001036func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001037 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1038 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1039 return false
1040 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001041 return c.linker != nil && c.linker.nativeCoverage()
1042}
1043
Inseob Kim8471cda2019-11-15 09:59:12 +09001044func (c *Module) isSnapshotPrebuilt() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09001045 if p, ok := c.linker.(interface{ isSnapshotPrebuilt() bool }); ok {
1046 return p.isSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001047 }
1048 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001049}
1050
Bill Peckham945441c2020-08-31 16:07:58 -07001051func (c *Module) ExcludeFromVendorSnapshot() bool {
1052 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1053}
1054
Jose Galmesf7294582020-11-13 12:07:36 -08001055func (c *Module) ExcludeFromRecoverySnapshot() bool {
1056 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1057}
1058
Jiyong Parkf1194352019-02-25 11:05:47 +09001059func isBionic(name string) bool {
1060 switch name {
Martin Stjernholm203489b2019-11-11 15:33:27 +00001061 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001062 return true
1063 }
1064 return false
1065}
1066
Martin Stjernholm279de572019-09-10 23:18:20 +01001067func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001068 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001069 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001070 }
1071 return isBionic(name)
1072}
1073
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001074func (c *Module) XrefCcFiles() android.Paths {
1075 return c.kytheFiles
1076}
1077
Colin Crossca860ac2016-01-04 14:34:37 -08001078type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001079 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001080 moduleContextImpl
1081}
1082
Colin Cross37047f12016-12-13 17:06:13 -08001083type depsContext struct {
1084 android.BottomUpMutatorContext
1085 moduleContextImpl
1086}
1087
Colin Crossca860ac2016-01-04 14:34:37 -08001088type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001089 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001090 moduleContextImpl
1091}
1092
1093type moduleContextImpl struct {
1094 mod *Module
1095 ctx BaseModuleContext
1096}
1097
Colin Crossb98c8b02016-07-29 13:44:28 -07001098func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001099 return ctx.mod.toolchain(ctx.ctx)
1100}
1101
1102func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001103 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001104}
1105
1106func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001107 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001108}
1109
Jiyong Park1d1119f2019-07-29 21:27:18 +09001110func (ctx *moduleContextImpl) header() bool {
1111 return ctx.mod.header()
1112}
1113
Inseob Kim7f283f42020-06-01 21:53:49 +09001114func (ctx *moduleContextImpl) binary() bool {
1115 return ctx.mod.binary()
1116}
1117
Inseob Kim1042d292020-06-01 23:23:05 +09001118func (ctx *moduleContextImpl) object() bool {
1119 return ctx.mod.object()
1120}
1121
Jooyung Hanccce2f22020-03-07 03:45:53 +09001122func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001123 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001124}
1125
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001126func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001127 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001128}
1129
1130func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001131 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001132 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001133 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001134 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001135 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001136 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001137 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001138 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001139 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001140 }
1141 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001142}
1143
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001144func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001145 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001146}
Justin Yun8effde42017-06-23 19:24:43 +09001147
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001148func (ctx *moduleContextImpl) isNdk() bool {
Peter Collingbournead84f972019-12-17 16:46:18 -08001149 return ctx.mod.IsNdk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001150}
1151
Inseob Kim9516ee92019-05-09 10:56:13 +09001152func (ctx *moduleContextImpl) isLlndk(config android.Config) bool {
1153 return ctx.mod.isLlndk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001154}
1155
Inseob Kim9516ee92019-05-09 10:56:13 +09001156func (ctx *moduleContextImpl) isLlndkPublic(config android.Config) bool {
1157 return ctx.mod.isLlndkPublic(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001158}
1159
Inseob Kim9516ee92019-05-09 10:56:13 +09001160func (ctx *moduleContextImpl) isVndkPrivate(config android.Config) bool {
1161 return ctx.mod.isVndkPrivate(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001162}
1163
Logan Chienf3511742017-10-31 18:04:35 +08001164func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001165 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001166}
1167
Yi Kong7e53c572018-02-14 18:16:12 +08001168func (ctx *moduleContextImpl) isPgoCompile() bool {
1169 return ctx.mod.isPgoCompile()
1170}
1171
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001172func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1173 return ctx.mod.isNDKStubLibrary()
1174}
1175
Justin Yun8effde42017-06-23 19:24:43 +09001176func (ctx *moduleContextImpl) isVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001177 return ctx.mod.isVndkSp()
1178}
1179
1180func (ctx *moduleContextImpl) isVndkExt() bool {
1181 return ctx.mod.isVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001182}
1183
Vic Yangefd249e2018-11-12 20:19:56 -08001184func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001185 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001186}
1187
Logan Chien2f2b8902018-07-10 15:01:19 +08001188// Check whether ABI dumps should be created for this module.
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001189func (ctx *moduleContextImpl) shouldCreateSourceAbiDump() bool {
Logan Chien2f2b8902018-07-10 15:01:19 +08001190 if ctx.ctx.Config().IsEnvTrue("SKIP_ABI_CHECKS") {
1191 return false
Jayant Chowdharyea0a2e12018-03-01 19:12:16 -08001192 }
Doug Hornc32c6b02019-01-17 14:44:05 -08001193
Hsin-Yi Chenf81bb652020-04-07 21:42:19 +08001194 // Coverage builds have extra symbols.
1195 if ctx.mod.isCoverageVariant() {
1196 return false
1197 }
1198
Doug Hornc32c6b02019-01-17 14:44:05 -08001199 if ctx.ctx.Fuchsia() {
1200 return false
1201 }
1202
Logan Chien2f2b8902018-07-10 15:01:19 +08001203 if sanitize := ctx.mod.sanitize; sanitize != nil {
1204 if !sanitize.isVariantOnProductionDevice() {
1205 return false
1206 }
1207 }
1208 if !ctx.ctx.Device() {
1209 // Host modules do not need ABI dumps.
1210 return false
1211 }
Colin Cross31076b32020-10-23 17:22:06 -07001212 if ctx.isNDKStubLibrary() {
Hsin-Yi Chenf6a95462019-06-25 14:46:52 +08001213 // Stubs do not need ABI dumps.
1214 return false
1215 }
Colin Cross31076b32020-10-23 17:22:06 -07001216 if lib := ctx.mod.library; lib != nil && lib.buildStubs() {
1217 // Stubs do not need ABI dumps.
1218 return false
1219 }
1220
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001221 return true
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001222}
1223
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001224func (ctx *moduleContextImpl) selectedStl() string {
1225 if stl := ctx.mod.stl; stl != nil {
1226 return stl.Properties.SelectedStl
1227 }
1228 return ""
1229}
1230
Ivan Lozanobd721262018-11-27 14:33:03 -08001231func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1232 return ctx.mod.linker.useClangLld(actx)
1233}
1234
Colin Crossce75d2c2016-10-06 16:12:58 -07001235func (ctx *moduleContextImpl) baseModuleName() string {
1236 return ctx.mod.ModuleBase.BaseModuleName()
1237}
1238
Logan Chienf3511742017-10-31 18:04:35 +08001239func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1240 return ctx.mod.getVndkExtendsModuleName()
1241}
1242
Logan Chiene274fc92019-12-03 11:18:32 -08001243func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001244 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001245}
1246
Colin Crosse07f2312020-08-13 11:24:56 -07001247func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001248 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001249}
1250
Dan Albertc8060532020-07-22 22:32:17 -07001251func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001252 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001253}
1254
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001255func (ctx *moduleContextImpl) bootstrap() bool {
1256 return ctx.mod.bootstrap()
1257}
1258
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001259func (ctx *moduleContextImpl) nativeCoverage() bool {
1260 return ctx.mod.nativeCoverage()
1261}
1262
Colin Cross56a83212020-09-15 18:30:11 -07001263func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1264 return ctx.mod.DirectlyInAnyApex()
1265}
1266
Colin Cross635c3b02016-05-18 15:37:25 -07001267func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001268 return &Module{
1269 hod: hod,
1270 multilib: multilib,
1271 }
1272}
1273
Colin Cross635c3b02016-05-18 15:37:25 -07001274func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001275 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001276 module.features = []feature{
1277 &tidyFeature{},
1278 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001279 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001280 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001281 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001282 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001283 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001284 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001285 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001286 return module
1287}
1288
Colin Crossce75d2c2016-10-06 16:12:58 -07001289func (c *Module) Prebuilt() *android.Prebuilt {
1290 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1291 return p.prebuilt()
1292 }
1293 return nil
1294}
1295
1296func (c *Module) Name() string {
1297 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001298 if p, ok := c.linker.(interface {
1299 Name(string) string
1300 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001301 name = p.Name(name)
1302 }
1303 return name
1304}
1305
Alex Light3d673592019-01-18 14:37:31 -08001306func (c *Module) Symlinks() []string {
1307 if p, ok := c.installer.(interface {
1308 symlinkList() []string
1309 }); ok {
1310 return p.symlinkList()
1311 }
1312 return nil
1313}
1314
Roland Levillainf89cd092019-07-29 16:22:59 +01001315func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1316 test, ok := c.linker.(testPerSrc)
1317 return ok && test.isAllTestsVariation()
1318}
1319
Chris Parsons216e10a2020-07-09 17:12:52 -04001320func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001321 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001322 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001323 }); ok {
1324 return p.dataPaths()
1325 }
1326 return nil
1327}
1328
Justin Yun5f7f7e82019-11-18 19:52:14 +09001329func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1330 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1331 // "current", it will append the VNDK version to the name suffix.
1332 var vndkVersion string
1333 var nameSuffix string
1334 if c.inProduct() {
1335 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1336 nameSuffix = productSuffix
1337 } else {
1338 vndkVersion = ctx.DeviceConfig().VndkVersion()
1339 nameSuffix = vendorSuffix
1340 }
1341 if vndkVersion == "current" {
1342 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1343 }
1344 if c.Properties.VndkVersion != vndkVersion {
1345 // add version suffix only if the module is using different vndk version than the
1346 // version in product or vendor partition.
1347 nameSuffix += "." + c.Properties.VndkVersion
1348 }
1349 return nameSuffix
1350}
1351
Colin Cross635c3b02016-05-18 15:37:25 -07001352func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Roland Levillainf2fad972019-06-28 15:41:19 +01001353 // Handle the case of a test module split by `test_per_src` mutator.
Roland Levillainf89cd092019-07-29 16:22:59 +01001354 //
1355 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1356 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1357 // module and return early, as this module does not produce an output file per se.
1358 if c.IsTestPerSrcAllTestsVariation() {
1359 c.outputFile = android.OptionalPath{}
1360 return
Roland Levillainf2fad972019-06-28 15:41:19 +01001361 }
1362
Colin Cross56a83212020-09-15 18:30:11 -07001363 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1364 if !apexInfo.IsForPlatform() {
1365 c.hideApexVariantFromMake = true
1366 }
1367
Jooyung Han38002912019-05-16 04:01:54 +09001368 c.makeLinkType = c.getMakeLinkType(actx)
Inseob Kim9516ee92019-05-09 10:56:13 +09001369
Inseob Kim64c43952019-08-26 16:52:35 +09001370 c.Properties.SubName = ""
1371
1372 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1373 c.Properties.SubName += nativeBridgeSuffix
1374 }
1375
Justin Yun5f7f7e82019-11-18 19:52:14 +09001376 _, llndk := c.linker.(*llndkStubDecorator)
1377 _, llndkHeader := c.linker.(*llndkHeadersDecorator)
Justin Yun63e9ec72020-10-29 16:49:43 +09001378 if llndk || llndkHeader || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001379 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1380 // added for product variant only when we have vendor and product variants with core
1381 // variant. The suffix is not added for vendor-only or product-only module.
1382 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
1383 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001384 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1385 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
1386 c.Properties.SubName += vendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001387 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1388 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001389 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
1390 c.Properties.SubName += vendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001391 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001392 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001393 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001394 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001395 if c.SplitPerApiLevel() {
1396 c.Properties.SubName += "." + c.SdkVersion()
1397 }
Inseob Kim64c43952019-08-26 16:52:35 +09001398 }
1399
Colin Crossca860ac2016-01-04 14:34:37 -08001400 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001401 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001402 moduleContextImpl: moduleContextImpl{
1403 mod: c,
1404 },
1405 }
1406 ctx.ctx = ctx
1407
Colin Crossf18e1102017-11-16 14:33:08 -08001408 deps := c.depsToPaths(ctx)
1409 if ctx.Failed() {
1410 return
1411 }
1412
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001413 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1414 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1415 }
1416
Colin Crossca860ac2016-01-04 14:34:37 -08001417 flags := Flags{
1418 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001419 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001420 }
Colin Crossca860ac2016-01-04 14:34:37 -08001421 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001422 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001423 }
1424 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001425 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001426 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001427 if c.stl != nil {
1428 flags = c.stl.flags(ctx, flags)
1429 }
Colin Cross16b23492016-01-06 14:41:07 -08001430 if c.sanitize != nil {
1431 flags = c.sanitize.flags(ctx, flags)
1432 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001433 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001434 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001435 }
Stephen Craneba090d12017-05-09 15:44:35 -07001436 if c.lto != nil {
1437 flags = c.lto.flags(ctx, flags)
1438 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001439 if c.pgo != nil {
1440 flags = c.pgo.flags(ctx, flags)
1441 }
Colin Crossca860ac2016-01-04 14:34:37 -08001442 for _, feature := range c.features {
1443 flags = feature.flags(ctx, flags)
1444 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001445 if ctx.Failed() {
1446 return
1447 }
1448
Colin Cross4af21ed2019-11-04 09:37:55 -08001449 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1450 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1451 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001452
Colin Cross4af21ed2019-11-04 09:37:55 -08001453 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001454
1455 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001456 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001457 }
1458 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001459 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001460 }
1461
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001462 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001463 // We need access to all the flags seen by a source file.
1464 if c.sabi != nil {
1465 flags = c.sabi.flags(ctx, flags)
1466 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001467
Colin Cross4af21ed2019-11-04 09:37:55 -08001468 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001469
Colin Crossca860ac2016-01-04 14:34:37 -08001470 // Optimization to reduce size of build.ninja
1471 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001472 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1473 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1474 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1475 flags.Local.CFlags = []string{"$cflags"}
1476 flags.Local.CppFlags = []string{"$cppflags"}
1477 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001478
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001479 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001480 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001481 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001482 if ctx.Failed() {
1483 return
1484 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001485 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001486 }
1487
Colin Crossca860ac2016-01-04 14:34:37 -08001488 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001489 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001490 if ctx.Failed() {
1491 return
1492 }
Colin Cross635c3b02016-05-18 15:37:25 -07001493 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001494
1495 // If a lib is directly included in any of the APEXes, unhide the stubs
1496 // variant having the latest version gets visible to make. In addition,
1497 // the non-stubs variant is renamed to <libname>.bootstrap. This is to
1498 // force anything in the make world to link against the stubs library.
1499 // (unless it is explicitly referenced via .bootstrap suffix or the
1500 // module is marked with 'bootstrap: true').
Colin Cross56a83212020-09-15 18:30:11 -07001501 if c.HasStubsVariants() && c.AnyVariantDirectlyInAnyApex() && !c.InRamdisk() &&
Ivan Lozano52767be2019-10-18 14:49:46 -07001502 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001503 c.IsStubs() && !c.InVendorRamdisk() {
Jiyong Parkb0788572018-12-20 22:10:17 +09001504 c.Properties.HideFromMake = false // unhide
1505 // Note: this is still non-installable
1506 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001507
1508 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current.
1509 if i, ok := c.linker.(snapshotLibraryInterface); ok && ctx.DeviceConfig().VndkVersion() == "current" {
Colin Cross56a83212020-09-15 18:30:11 -07001510 if isSnapshotAware(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001511 i.collectHeadersForSnapshot(ctx)
1512 }
1513 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001514 }
Colin Cross5049f022015-03-18 13:28:46 -07001515
Colin Cross56a83212020-09-15 18:30:11 -07001516 if c.installable(apexInfo) {
Colin Crossce75d2c2016-10-06 16:12:58 -07001517 c.installer.install(ctx, c.outputFile.Path())
1518 if ctx.Failed() {
1519 return
Colin Crossca860ac2016-01-04 14:34:37 -08001520 }
Paul Duffin0cb37b92020-03-04 14:52:46 +00001521 } else if !proptools.BoolDefault(c.Properties.Installable, true) {
1522 // If the module has been specifically configure to not be installed then
1523 // skip the installation as otherwise it will break when running inside make
1524 // as the output path to install will not be specified. Not all uninstallable
1525 // modules can skip installation as some are needed for resolving make side
1526 // dependencies.
1527 c.SkipInstall()
Dan Albertc403f7c2015-03-18 14:01:18 -07001528 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001529}
1530
Colin Cross0ea8ba82019-06-06 14:33:29 -07001531func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001532 if c.cachedToolchain == nil {
Colin Crossb98c8b02016-07-29 13:44:28 -07001533 c.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
Colin Cross3f40fa42015-01-30 17:27:36 -08001534 }
Colin Crossca860ac2016-01-04 14:34:37 -08001535 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001536}
1537
Colin Crossca860ac2016-01-04 14:34:37 -08001538func (c *Module) begin(ctx BaseModuleContext) {
1539 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001540 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001541 }
Colin Crossca860ac2016-01-04 14:34:37 -08001542 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001543 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001544 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001545 if c.stl != nil {
1546 c.stl.begin(ctx)
1547 }
Colin Cross16b23492016-01-06 14:41:07 -08001548 if c.sanitize != nil {
1549 c.sanitize.begin(ctx)
1550 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001551 if c.coverage != nil {
1552 c.coverage.begin(ctx)
1553 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001554 if c.sabi != nil {
1555 c.sabi.begin(ctx)
1556 }
Justin Yun8effde42017-06-23 19:24:43 +09001557 if c.vndkdep != nil {
1558 c.vndkdep.begin(ctx)
1559 }
Stephen Craneba090d12017-05-09 15:44:35 -07001560 if c.lto != nil {
1561 c.lto.begin(ctx)
1562 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001563 if c.pgo != nil {
1564 c.pgo.begin(ctx)
1565 }
Colin Crossca860ac2016-01-04 14:34:37 -08001566 for _, feature := range c.features {
1567 feature.begin(ctx)
1568 }
Dan Albert92fe7402020-07-15 13:33:30 -07001569 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001570 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001571 if err != nil {
1572 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001573 c.Properties.Sdk_version = nil
1574 } else {
1575 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001576 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001577 }
Colin Crossca860ac2016-01-04 14:34:37 -08001578}
1579
Colin Cross37047f12016-12-13 17:06:13 -08001580func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001581 deps := Deps{}
1582
1583 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001584 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001585 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001586 // Add the PGO dependency (the clang_rt.profile runtime library), which
1587 // sometimes depends on symbols from libgcc, before libgcc gets added
1588 // in linkerDeps().
Pirama Arumuga Nainar49b53d52017-10-04 16:47:29 -07001589 if c.pgo != nil {
1590 deps = c.pgo.deps(ctx, deps)
1591 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001592 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001593 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001594 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001595 if c.stl != nil {
1596 deps = c.stl.deps(ctx, deps)
1597 }
Colin Cross16b23492016-01-06 14:41:07 -08001598 if c.sanitize != nil {
1599 deps = c.sanitize.deps(ctx, deps)
1600 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001601 if c.coverage != nil {
1602 deps = c.coverage.deps(ctx, deps)
1603 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001604 if c.sabi != nil {
1605 deps = c.sabi.deps(ctx, deps)
1606 }
Justin Yun8effde42017-06-23 19:24:43 +09001607 if c.vndkdep != nil {
1608 deps = c.vndkdep.deps(ctx, deps)
1609 }
Stephen Craneba090d12017-05-09 15:44:35 -07001610 if c.lto != nil {
1611 deps = c.lto.deps(ctx, deps)
1612 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001613 for _, feature := range c.features {
1614 deps = feature.deps(ctx, deps)
1615 }
1616
Colin Crossb6715442017-10-24 11:13:31 -07001617 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1618 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1619 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1620 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1621 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1622 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001623 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001624
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001625 for _, lib := range deps.ReexportSharedLibHeaders {
1626 if !inList(lib, deps.SharedLibs) {
1627 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1628 }
1629 }
1630
1631 for _, lib := range deps.ReexportStaticLibHeaders {
1632 if !inList(lib, deps.StaticLibs) {
1633 ctx.PropertyErrorf("export_static_lib_headers", "Static library not in static_libs: '%s'", lib)
1634 }
1635 }
1636
Colin Cross5950f382016-12-13 12:50:57 -08001637 for _, lib := range deps.ReexportHeaderLibHeaders {
1638 if !inList(lib, deps.HeaderLibs) {
1639 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1640 }
1641 }
1642
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001643 for _, gen := range deps.ReexportGeneratedHeaders {
1644 if !inList(gen, deps.GeneratedHeaders) {
1645 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1646 }
1647 }
1648
Colin Crossc99deeb2016-04-11 15:06:20 -07001649 return deps
1650}
1651
Dan Albert7e9d2952016-08-04 13:02:36 -07001652func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001653 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001654 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001655 moduleContextImpl: moduleContextImpl{
1656 mod: c,
1657 },
1658 }
1659 ctx.ctx = ctx
1660
Colin Crossca860ac2016-01-04 14:34:37 -08001661 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001662}
1663
Jiyong Park7ed9de32018-10-15 22:25:07 +09001664// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001665func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001666 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1667 version := name[sharp+1:]
1668 libname := name[:sharp]
1669 return libname, version
1670 }
1671 return name, ""
1672}
1673
Dan Albert92fe7402020-07-15 13:33:30 -07001674func GetCrtVariations(ctx android.BottomUpMutatorContext,
1675 m LinkableInterface) []blueprint.Variation {
1676 if ctx.Os() != android.Android {
1677 return nil
1678 }
1679 if m.UseSdk() {
1680 return []blueprint.Variation{
1681 {Mutator: "sdk", Variation: "sdk"},
Colin Crossbbc941b2020-09-30 12:27:01 -07001682 {Mutator: "version", Variation: m.SdkVersion()},
Dan Albert92fe7402020-07-15 13:33:30 -07001683 }
1684 }
1685 return []blueprint.Variation{
1686 {Mutator: "sdk", Variation: ""},
1687 }
1688}
1689
Colin Crosse7257d22020-09-24 09:56:18 -07001690func (c *Module) addSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext,
1691 variations []blueprint.Variation, depTag libraryDependencyTag, name, version string, far bool) {
1692
1693 variations = append([]blueprint.Variation(nil), variations...)
1694
Colin Cross3146c5c2020-09-30 15:34:40 -07001695 if version != "" && CanBeOrLinkAgainstVersionVariants(c) {
Colin Crosse7257d22020-09-24 09:56:18 -07001696 // Version is explicitly specified. i.e. libFoo#30
1697 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
1698 depTag.explicitlyVersioned = true
1699 }
Colin Crosse7257d22020-09-24 09:56:18 -07001700
Colin Cross0de8a1e2020-09-18 14:15:30 -07001701 if far {
1702 ctx.AddFarVariationDependencies(variations, depTag, name)
1703 } else {
1704 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07001705 }
1706}
1707
Colin Cross1e676be2016-10-12 14:38:15 -07001708func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09001709 if !c.Enabled() {
1710 return
1711 }
1712
Colin Cross37047f12016-12-13 17:06:13 -08001713 ctx := &depsContext{
1714 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07001715 moduleContextImpl: moduleContextImpl{
1716 mod: c,
1717 },
1718 }
1719 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08001720
Colin Crossc99deeb2016-04-11 15:06:20 -07001721 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001722
Yo Chiang219968c2020-09-22 18:45:04 +08001723 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
1724
Dan Albert914449f2016-06-17 16:45:24 -07001725 variantNdkLibs := []string{}
1726 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07001727 if ctx.Os() == android.Android {
Inseob Kimeec88e12020-01-22 11:11:29 +09001728 // rewriteLibs takes a list of names of shared libraries and scans it for three types
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001729 // of names:
Dan Albert914449f2016-06-17 16:45:24 -07001730 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001731 // 1. Name of an NDK library that refers to a prebuilt module.
1732 // For each of these, it adds the name of the prebuilt module (which will be in
1733 // prebuilts/ndk) to the list of nonvariant libs.
1734 // 2. Name of an NDK library that refers to an ndk_library module.
1735 // For each of these, it adds the name of the ndk_library module to the list of
1736 // variant libs.
1737 // 3. Anything else (so anything that isn't an NDK library).
1738 // It adds these to the nonvariantLibs list.
Dan Albert914449f2016-06-17 16:45:24 -07001739 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001740 // The caller can then know to add the variantLibs dependencies differently from the
1741 // nonvariantLibs
Inseob Kim9516ee92019-05-09 10:56:13 +09001742
Inseob Kim9516ee92019-05-09 10:56:13 +09001743 vendorPublicLibraries := vendorPublicLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001744 vendorSnapshotSharedLibs := vendorSnapshotSharedLibs(actx.Config())
1745
1746 rewriteVendorLibs := func(lib string) string {
1747 if isLlndkLibrary(lib, ctx.Config()) {
1748 return lib + llndkLibrarySuffix
1749 }
1750
1751 // only modules with BOARD_VNDK_VERSION uses snapshot.
1752 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1753 return lib
1754 }
1755
1756 if snapshot, ok := vendorSnapshotSharedLibs.get(lib, actx.Arch().ArchType); ok {
1757 return snapshot
1758 }
1759
1760 return lib
1761 }
1762
1763 rewriteLibs := func(list []string) (nonvariantLibs []string, variantLibs []string) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001764 variantLibs = []string{}
1765 nonvariantLibs = []string{}
Dan Albert914449f2016-06-17 16:45:24 -07001766 for _, entry := range list {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001767 // strip #version suffix out
Jiyong Park73c54ee2019-10-22 20:31:18 +09001768 name, _ := StubsLibNameAndVersion(entry)
Dan Albertde5aade2020-06-30 12:32:51 -07001769 if ctx.useSdk() && inList(name, ndkKnownLibs) {
1770 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Inseob Kimeec88e12020-01-22 11:11:29 +09001771 } else if ctx.useVndk() {
1772 nonvariantLibs = append(nonvariantLibs, rewriteVendorLibs(entry))
Inseob Kim9516ee92019-05-09 10:56:13 +09001773 } else if (ctx.Platform() || ctx.ProductSpecific()) && inList(name, *vendorPublicLibraries) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001774 vendorPublicLib := name + vendorPublicLibrarySuffix
Jiyong Park374510b2018-03-19 18:23:01 +09001775 if actx.OtherModuleExists(vendorPublicLib) {
1776 nonvariantLibs = append(nonvariantLibs, vendorPublicLib)
1777 } else {
1778 // This can happen if vendor_public_library module is defined in a
1779 // namespace that isn't visible to the current module. In that case,
1780 // link to the original library.
Jiyong Park7ed9de32018-10-15 22:25:07 +09001781 nonvariantLibs = append(nonvariantLibs, name)
Jiyong Park374510b2018-03-19 18:23:01 +09001782 }
Dan Albert914449f2016-06-17 16:45:24 -07001783 } else {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001784 // put name#version back
Dan Willemsen7cbf5f82017-03-28 00:08:30 -07001785 nonvariantLibs = append(nonvariantLibs, entry)
Dan Willemsen72d39932016-07-08 23:23:48 -07001786 }
1787 }
Dan Albert914449f2016-06-17 16:45:24 -07001788 return nonvariantLibs, variantLibs
Dan Willemsen72d39932016-07-08 23:23:48 -07001789 }
1790
Inseob Kimeec88e12020-01-22 11:11:29 +09001791 deps.SharedLibs, variantNdkLibs = rewriteLibs(deps.SharedLibs)
1792 deps.LateSharedLibs, variantLateNdkLibs = rewriteLibs(deps.LateSharedLibs)
1793 deps.ReexportSharedLibHeaders, _ = rewriteLibs(deps.ReexportSharedLibHeaders)
1794 if ctx.useVndk() {
1795 for idx, lib := range deps.RuntimeLibs {
1796 deps.RuntimeLibs[idx] = rewriteVendorLibs(lib)
1797 }
1798 }
Dan Willemsen72d39932016-07-08 23:23:48 -07001799 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001800
Jiyong Park7e636d02019-01-28 16:16:54 +09001801 buildStubs := false
Colin Crossc88c2722020-09-28 17:32:47 -07001802 if versioned, ok := c.linker.(versionedInterface); ok {
1803 if versioned.buildStubs() {
1804 buildStubs = true
Colin Crossd48fe732020-09-23 20:37:24 -07001805 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001806 }
1807
Inseob Kimeec88e12020-01-22 11:11:29 +09001808 rewriteSnapshotLibs := func(lib string, snapshotMap *snapshotMap) string {
1809 // only modules with BOARD_VNDK_VERSION uses snapshot.
1810 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1811 return lib
1812 }
1813
1814 if snapshot, ok := snapshotMap.get(lib, actx.Arch().ArchType); ok {
1815 return snapshot
1816 }
1817
1818 return lib
1819 }
1820
1821 vendorSnapshotHeaderLibs := vendorSnapshotHeaderLibs(actx.Config())
Colin Cross32ec36c2016-12-15 07:39:51 -08001822 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001823 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08001824 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001825 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08001826 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001827
1828 lib = rewriteSnapshotLibs(lib, vendorSnapshotHeaderLibs)
1829
Jiyong Park7e636d02019-01-28 16:16:54 +09001830 if buildStubs {
Colin Cross7228ecd2019-11-18 16:00:16 -08001831 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001832 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09001833 } else {
1834 actx.AddVariationDependencies(nil, depTag, lib)
1835 }
1836 }
1837
1838 if buildStubs {
1839 // Stubs lib does not have dependency to other static/shared libraries.
1840 // Don't proceed.
1841 return
Colin Cross32ec36c2016-12-15 07:39:51 -08001842 }
Colin Cross5950f382016-12-13 12:50:57 -08001843
Inseob Kimc0907f12019-02-08 21:00:45 +09001844 syspropImplLibraries := syspropImplLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001845 vendorSnapshotStaticLibs := vendorSnapshotStaticLibs(actx.Config())
Inseob Kimc0907f12019-02-08 21:00:45 +09001846
Jiyong Park5d1598f2019-02-25 22:14:17 +09001847 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001848 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09001849 if impl, ok := syspropImplLibraries[lib]; ok {
1850 lib = impl
1851 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001852
1853 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1854
Jiyong Park5d1598f2019-02-25 22:14:17 +09001855 actx.AddVariationDependencies([]blueprint.Variation{
1856 {Mutator: "link", Variation: "static"},
1857 }, depTag, lib)
1858 }
1859
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001860 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001861 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001862 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001863 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001864 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001865
1866 if impl, ok := syspropImplLibraries[lib]; ok {
1867 lib = impl
1868 }
1869
Inseob Kimeec88e12020-01-22 11:11:29 +09001870 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1871
Dan Willemsen59339a22018-07-22 21:18:45 -07001872 actx.AddVariationDependencies([]blueprint.Variation{
1873 {Mutator: "link", Variation: "static"},
1874 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001875 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001876
Jooyung Han75568392020-03-20 04:29:24 +09001877 // staticUnwinderDep is treated as staticDep for Q apexes
1878 // so that native libraries/binaries are linked with static unwinder
1879 // because Q libc doesn't have unwinder APIs
1880 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07001881 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001882 actx.AddVariationDependencies([]blueprint.Variation{
1883 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001884 }, depTag, rewriteSnapshotLibs(staticUnwinder(actx), vendorSnapshotStaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001885 }
1886
Inseob Kimeec88e12020-01-22 11:11:29 +09001887 for _, lib := range deps.LateStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001888 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Inseob Kimeec88e12020-01-22 11:11:29 +09001889 actx.AddVariationDependencies([]blueprint.Variation{
1890 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001891 }, depTag, rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs))
Inseob Kimeec88e12020-01-22 11:11:29 +09001892 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001893
Jiyong Park7ed9de32018-10-15 22:25:07 +09001894 // shared lib names without the #version suffix
1895 var sharedLibNames []string
1896
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001897 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001898 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001899 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001900 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001901 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001902
1903 if impl, ok := syspropImplLibraries[lib]; ok {
1904 lib = impl
1905 }
1906
Jiyong Park73c54ee2019-10-22 20:31:18 +09001907 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09001908 sharedLibNames = append(sharedLibNames, name)
1909
Colin Crosse7257d22020-09-24 09:56:18 -07001910 variations := []blueprint.Variation{
1911 {Mutator: "link", Variation: "shared"},
1912 }
1913 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001914 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001915
Jiyong Park7ed9de32018-10-15 22:25:07 +09001916 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09001917 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001918 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
1919 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
1920 // linking against both the stubs lib and the non-stubs lib at the same time.
1921 continue
1922 }
Colin Cross6e511a92020-07-27 21:26:48 -07001923 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07001924 variations := []blueprint.Variation{
1925 {Mutator: "link", Variation: "shared"},
1926 }
1927 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001928 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001929
Dan Willemsen59339a22018-07-22 21:18:45 -07001930 actx.AddVariationDependencies([]blueprint.Variation{
1931 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04001932 }, dataLibDepTag, deps.DataLibs...)
1933
1934 actx.AddVariationDependencies([]blueprint.Variation{
1935 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07001936 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08001937
Colin Cross68861832016-07-08 10:41:41 -07001938 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001939
1940 for _, gen := range deps.GeneratedHeaders {
1941 depTag := genHeaderDepTag
1942 if inList(gen, deps.ReexportGeneratedHeaders) {
1943 depTag = genHeaderExportDepTag
1944 }
1945 actx.AddDependency(c, depTag, gen)
1946 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07001947
Inseob Kim1042d292020-06-01 23:23:05 +09001948 vendorSnapshotObjects := vendorSnapshotObjects(actx.Config())
1949
Dan Albert92fe7402020-07-15 13:33:30 -07001950 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07001951 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc99deeb2016-04-11 15:06:20 -07001952 if deps.CrtBegin != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07001953 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
1954 rewriteSnapshotLibs(deps.CrtBegin, vendorSnapshotObjects))
Colin Crossca860ac2016-01-04 14:34:37 -08001955 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001956 if deps.CrtEnd != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07001957 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
1958 rewriteSnapshotLibs(deps.CrtEnd, vendorSnapshotObjects))
Colin Cross21b9a242015-03-24 14:15:58 -07001959 }
Dan Willemsena0790e32018-10-12 00:24:23 -07001960 if deps.LinkerFlagsFile != "" {
1961 actx.AddDependency(c, linkerFlagsDepTag, deps.LinkerFlagsFile)
1962 }
1963 if deps.DynamicLinker != "" {
1964 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07001965 }
Dan Albert914449f2016-06-17 16:45:24 -07001966
1967 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07001968
1969 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07001970 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07001971 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07001972 {Mutator: "link", Variation: "shared"},
1973 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07001974
1975 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07001976 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07001977 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07001978 {Mutator: "link", Variation: "shared"},
1979 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08001980
1981 if vndkdep := c.vndkdep; vndkdep != nil {
1982 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08001983 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08001984 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07001985 {Mutator: "link", Variation: "shared"},
1986 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08001987 }
1988 }
Colin Cross6362e272015-10-29 15:25:03 -07001989}
Colin Cross21b9a242015-03-24 14:15:58 -07001990
Colin Crosse40b4ea2018-10-02 22:25:58 -07001991func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07001992 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
1993 c.beginMutator(ctx)
1994 }
1995}
1996
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001997// Whether a module can link to another module, taking into
1998// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09001999func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002000 tag blueprint.DependencyTag) {
2001
2002 switch t := tag.(type) {
2003 case dependencyTag:
2004 if t != vndkExtDepTag {
2005 return
2006 }
2007 case libraryDependencyTag:
2008 default:
2009 return
2010 }
2011
Ivan Lozano52767be2019-10-18 14:49:46 -07002012 if from.Module().Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002013 // Host code is not restricted
2014 return
2015 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002016
2017 // VNDK is cc.Module supported only for now.
2018 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002019 // Though allowed dependency is limited by the image mutator,
2020 // each vendor and product module needs to check link-type
2021 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002022 if ccTo, ok := to.(*Module); ok {
2023 if ccFrom.vndkdep != nil {
2024 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2025 }
2026 } else {
2027 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002028 }
2029 return
2030 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002031 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002032 // Platform code can link to anything
2033 return
2034 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002035 if from.InRamdisk() {
2036 // Ramdisk code is not NDK
2037 return
2038 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002039 if from.InVendorRamdisk() {
2040 // Vendor ramdisk code is not NDK
2041 return
2042 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002043 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002044 // Recovery code is not NDK
2045 return
2046 }
Colin Cross31076b32020-10-23 17:22:06 -07002047 if c, ok := to.(*Module); ok {
2048 if c.ToolchainLibrary() {
2049 // These are always allowed
2050 return
2051 }
2052 if c.NdkPrebuiltStl() {
2053 // These are allowed, but they don't set sdk_version
2054 return
2055 }
2056 if c.StubDecorator() {
2057 // These aren't real libraries, but are the stub shared libraries that are included in
2058 // the NDK.
2059 return
2060 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002061 }
Logan Chien834b9a62019-01-14 15:39:03 +08002062
Ivan Lozano52767be2019-10-18 14:49:46 -07002063 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002064 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2065 // to link to libc++ (non-NDK and without sdk_version).
2066 return
2067 }
2068
Ivan Lozano52767be2019-10-18 14:49:46 -07002069 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002070 // NDK code linking to platform code is never okay.
2071 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002072 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002073 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002074 }
2075
2076 // At this point we know we have two NDK libraries, but we need to
2077 // check that we're not linking against anything built against a higher
2078 // API level, as it is only valid to link against older or equivalent
2079 // APIs.
2080
Inseob Kim01a28722018-04-11 09:48:45 +09002081 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002082 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002083 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002084 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002085 // Current can't be linked against by anything else.
2086 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002087 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002088 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002089 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002090 if err != nil {
2091 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002092 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002093 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002094 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002095 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002096 if err != nil {
2097 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002098 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002099 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002100 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002101
Inseob Kim01a28722018-04-11 09:48:45 +09002102 if toApi > fromApi {
2103 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002104 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002105 }
2106 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002107 }
Dan Albert202fe492017-12-15 13:56:59 -08002108
2109 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002110 fromStl := from.SelectedStl()
2111 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002112 if fromStl == "" || toStl == "" {
2113 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002114 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002115 // We can be permissive with the system "STL" since it is only the C++
2116 // ABI layer, but in the future we should make sure that everyone is
2117 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002118 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002119 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002120 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2121 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002122 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002123}
2124
Jooyung Han479ca172020-10-19 18:51:07 +09002125func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2126 if c, ok := ctx.Module().(*Module); ok {
2127 ctx.VisitDirectDeps(func(dep android.Module) {
2128 depTag := ctx.OtherModuleDependencyTag(dep)
2129 ccDep, ok := dep.(LinkableInterface)
2130 if ok {
2131 checkLinkType(ctx, c, ccDep, depTag)
2132 }
2133 })
2134 }
2135}
2136
Jiyong Park5fb8c102018-04-09 12:03:06 +09002137// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002138// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2139// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002140// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002141func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2142 check := func(child, parent android.Module) bool {
2143 to, ok := child.(*Module)
2144 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002145 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002146 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002147
Jooyung Hana70f0672019-01-18 15:20:43 +09002148 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2149 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002150 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002151
Justin Yun63e9ec72020-10-29 16:49:43 +09002152 // Even if target lib has no vendor variant, keep checking dependency
2153 // graph in case it depends on vendor_available or product_available
2154 // but not double_loadable transtively.
2155 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002156 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002157 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002158
Jooyung Han0302a842019-10-30 18:43:49 +09002159 if to.isVndkSp() || to.isLlndk(ctx.Config()) || Bool(to.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002160 return false
2161 }
2162
2163 var stringPath []string
2164 for _, m := range ctx.GetWalkPath() {
2165 stringPath = append(stringPath, m.Name())
2166 }
2167 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2168 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
2169 "(dependency: %s)", ctx.OtherModuleName(to), strings.Join(stringPath, " -> "))
2170 return false
2171 }
2172 if module, ok := ctx.Module().(*Module); ok {
2173 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jooyung Han0302a842019-10-30 18:43:49 +09002174 if module.isLlndk(ctx.Config()) || Bool(module.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002175 ctx.WalkDeps(check)
2176 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002177 }
2178 }
2179}
2180
Colin Cross0de8a1e2020-09-18 14:15:30 -07002181// Returns the highest version which is <= maxSdkVersion.
2182// For example, with maxSdkVersion is 10 and versionList is [9,11]
2183// it returns 9 as string. The list of stubs must be in order from
2184// oldest to newest.
2185func (c *Module) chooseSdkVersion(ctx android.PathContext, stubsInfo []SharedLibraryStubsInfo,
2186 maxSdkVersion android.ApiLevel) (SharedLibraryStubsInfo, error) {
2187
2188 for i := range stubsInfo {
2189 stubInfo := stubsInfo[len(stubsInfo)-i-1]
2190 var ver android.ApiLevel
2191 if stubInfo.Version == "" {
2192 ver = android.FutureApiLevel
2193 } else {
2194 var err error
2195 ver, err = android.ApiLevelFromUser(ctx, stubInfo.Version)
2196 if err != nil {
2197 return SharedLibraryStubsInfo{}, err
2198 }
2199 }
2200 if ver.LessThanOrEqualTo(maxSdkVersion) {
2201 return stubInfo, nil
2202 }
2203 }
2204 var versionList []string
2205 for _, stubInfo := range stubsInfo {
2206 versionList = append(versionList, stubInfo.Version)
2207 }
2208 return SharedLibraryStubsInfo{}, fmt.Errorf("not found a version(<=%s) in versionList: %v", maxSdkVersion.String(), versionList)
2209}
2210
Colin Crossc99deeb2016-04-11 15:06:20 -07002211// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002212func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002213 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002214
Colin Cross0de8a1e2020-09-18 14:15:30 -07002215 var directStaticDeps []StaticLibraryInfo
2216 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002217
Colin Cross0de8a1e2020-09-18 14:15:30 -07002218 reexportExporter := func(exporter FlagExporterInfo) {
2219 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2220 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2221 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2222 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2223 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002224 }
2225
Jooyung Hande34d232020-07-23 13:04:15 +09002226 // For the dependency from platform to apex, use the latest stubs
2227 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002228 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2229 if !apexInfo.IsForPlatform() {
2230 c.apexSdkVersion = apexInfo.MinSdkVersion(ctx)
Jooyung Hande34d232020-07-23 13:04:15 +09002231 }
2232
2233 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2234 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2235 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2236 // (b/144430859)
2237 c.apexSdkVersion = android.FutureApiLevel
2238 }
2239
Colin Crossd11fcda2017-10-23 17:59:01 -07002240 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002241 depName := ctx.OtherModuleName(dep)
2242 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002243
Ivan Lozano52767be2019-10-18 14:49:46 -07002244 ccDep, ok := dep.(LinkableInterface)
2245 if !ok {
2246
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002247 // handling for a few module types that aren't cc Module but that are also supported
2248 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002249 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002250 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002251 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2252 genRule.GeneratedSourceFiles()...)
2253 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002254 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002255 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002256 // Support exported headers from a generated_sources dependency
2257 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002258 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002259 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002260 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002261 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002262 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002263 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002264 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002265 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002266 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2267 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002268 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002269 // 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 +09002270 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002271
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002272 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002273 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002274 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002275 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002276 case linkerFlagsDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002277 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002278 files := genRule.GeneratedSourceFiles()
2279 if len(files) == 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002280 depPaths.LinkerFlagsFile = android.OptionalPathForPath(files[0])
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002281 } else if len(files) > 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002282 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 -07002283 }
2284 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002285 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002286 }
Colin Crossca860ac2016-01-04 14:34:37 -08002287 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002288 return
2289 }
2290
Colin Crossfe17f6f2019-03-28 19:30:56 -07002291 if depTag == android.ProtoPluginDepTag {
2292 return
2293 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002294 if depTag == llndkImplDep {
2295 return
2296 }
Colin Crossfe17f6f2019-03-28 19:30:56 -07002297
Colin Crossd11fcda2017-10-23 17:59:01 -07002298 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002299 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2300 return
2301 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002302 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002303 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2304 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002305 return
2306 }
2307
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002308 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002309 // Skip reused objects for stub libraries, they use their own stub object file instead.
2310 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2311 // version mutator, so the stubs variant is created from the shared variant that
2312 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002313 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002314 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2315 objs := staticAnalogue.ReuseObjects
2316 depPaths.Objs = depPaths.Objs.Append(objs)
2317 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2318 reexportExporter(depExporterInfo)
2319 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002320 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002321 }
2322
Colin Cross6e511a92020-07-27 21:26:48 -07002323 linkFile := ccDep.OutputFile()
2324
2325 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2326 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002327 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002328 return
2329 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002330
Colin Cross0de8a1e2020-09-18 14:15:30 -07002331 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002332
Colin Cross6e511a92020-07-27 21:26:48 -07002333 var ptr *android.Paths
2334 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002335
Colin Cross6e511a92020-07-27 21:26:48 -07002336 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002337
Colin Cross6e511a92020-07-27 21:26:48 -07002338 switch {
2339 case libDepTag.header():
2340 // nothing
2341 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002342 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2343 if !ctx.Config().AllowMissingDependencies() {
2344 ctx.ModuleErrorf("module %q is not a shared library", depName)
2345 } else {
2346 ctx.AddMissingDependencies([]string{depName})
2347 }
2348 return
2349 }
2350 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2351 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryImplementationStubsInfoProvider).(SharedLibraryImplementationStubsInfo)
2352
2353 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedLibraryStubsInfos) > 0 {
2354 useStubs := false
Colin Cross31076b32020-10-23 17:22:06 -07002355
2356 if lib := moduleLibraryInterface(dep); lib.buildStubs() && c.UseVndk() { // LLNDK
Colin Cross0de8a1e2020-09-18 14:15:30 -07002357 if !apexInfo.IsForPlatform() {
2358 // For platform libraries, use current version of LLNDK
2359 // If this is for use_vendor apex we will apply the same rules
2360 // of apex sdk enforcement below to choose right version.
2361 useStubs = true
2362 }
2363 } else if apexInfo.IsForPlatform() {
2364 // If not building for APEX, use stubs only when it is from
2365 // an APEX (and not from platform)
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002366 // However, for host, ramdisk, vendor_ramdisk, recovery or bootstrap modules,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002367 // always link to non-stub variant
2368 useStubs = dep.(android.ApexModule).AnyVariantDirectlyInAnyApex() && !c.bootstrap()
2369 // Another exception: if this module is bundled with an APEX, then
2370 // it is linked with the non-stub variant of a module in the APEX
2371 // as if this is part of the APEX.
2372 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2373 for _, apexContents := range testFor.ApexContents {
2374 if apexContents.DirectlyInApex(depName) {
2375 useStubs = false
2376 break
2377 }
2378 }
2379 } else {
2380 // If building for APEX, use stubs when the parent is in any APEX that
2381 // the child is not in.
2382 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2383 }
2384
2385 // when to use (unspecified) stubs, check min_sdk_version and choose the right one
2386 if useStubs {
2387 sharedLibraryStubsInfo, err :=
2388 c.chooseSdkVersion(ctx, sharedLibraryStubsInfo.SharedLibraryStubsInfos, c.apexSdkVersion)
2389 if err != nil {
2390 ctx.OtherModuleErrorf(dep, err.Error())
2391 return
2392 }
2393 sharedLibraryInfo = sharedLibraryStubsInfo.SharedLibraryInfo
2394 depExporterInfo = sharedLibraryStubsInfo.FlagExporterInfo
2395 }
2396 }
2397
2398 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2399 depFile = sharedLibraryInfo.TableOfContents
2400
Colin Cross6e511a92020-07-27 21:26:48 -07002401 ptr = &depPaths.SharedLibs
2402 switch libDepTag.Order {
2403 case earlyLibraryDependency:
2404 ptr = &depPaths.EarlySharedLibs
2405 depPtr = &depPaths.EarlySharedLibsDeps
2406 case normalLibraryDependency:
2407 ptr = &depPaths.SharedLibs
2408 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002409 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002410 case lateLibraryDependency:
2411 ptr = &depPaths.LateSharedLibs
2412 depPtr = &depPaths.LateSharedLibsDeps
2413 default:
2414 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002415 }
Colin Cross6e511a92020-07-27 21:26:48 -07002416 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002417 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2418 if !ctx.Config().AllowMissingDependencies() {
2419 ctx.ModuleErrorf("module %q is not a static library", depName)
2420 } else {
2421 ctx.AddMissingDependencies([]string{depName})
2422 }
2423 return
2424 }
2425 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2426 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002427 if libDepTag.wholeStatic {
2428 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002429 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2430 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002431 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002432 // This case normally catches prebuilt static
2433 // libraries, but it can also occur when
2434 // AllowMissingDependencies is on and the
2435 // dependencies has no sources of its own
2436 // but has a whole_static_libs dependency
2437 // on a missing library. We want to depend
2438 // on the .a file so that there is something
2439 // in the dependency tree that contains the
2440 // error rule for the missing transitive
2441 // dependency.
2442 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002443 }
Colin Cross6e511a92020-07-27 21:26:48 -07002444 } else {
2445 switch libDepTag.Order {
2446 case earlyLibraryDependency:
2447 panic(fmt.Errorf("early static libs not suppported"))
2448 case normalLibraryDependency:
2449 // static dependencies will be handled separately so they can be ordered
2450 // using transitive dependencies.
2451 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002452 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002453 case lateLibraryDependency:
2454 ptr = &depPaths.LateStaticLibs
2455 default:
2456 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002457 }
2458 }
2459 }
2460
Colin Cross6e511a92020-07-27 21:26:48 -07002461 if libDepTag.static() && !libDepTag.wholeStatic {
2462 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2463 ctx.ModuleErrorf("module %q not a static library", depName)
2464 return
2465 }
Logan Chien43d34c32017-12-20 01:17:32 +08002466
Colin Cross6e511a92020-07-27 21:26:48 -07002467 // When combining coverage files for shared libraries and executables, coverage files
2468 // in static libraries act as if they were whole static libraries. The same goes for
2469 // source based Abi dump files.
2470 if c, ok := ccDep.(*Module); ok {
2471 staticLib := c.linker.(libraryInterface)
2472 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2473 staticLib.objs().coverageFiles...)
2474 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2475 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002476 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002477 // Handle non-CC modules here
2478 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002479 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002480 }
2481 }
2482
Colin Cross6e511a92020-07-27 21:26:48 -07002483 if ptr != nil {
2484 if !linkFile.Valid() {
2485 if !ctx.Config().AllowMissingDependencies() {
2486 ctx.ModuleErrorf("module %q missing output file", depName)
2487 } else {
2488 ctx.AddMissingDependencies([]string{depName})
2489 }
2490 return
2491 }
2492 *ptr = append(*ptr, linkFile.Path())
2493 }
2494
2495 if depPtr != nil {
2496 dep := depFile
2497 if !dep.Valid() {
2498 dep = linkFile
2499 }
2500 *depPtr = append(*depPtr, dep.Path())
2501 }
2502
Colin Cross0de8a1e2020-09-18 14:15:30 -07002503 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2504 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2505 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2506 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2507
2508 if libDepTag.reexportFlags {
2509 reexportExporter(depExporterInfo)
2510 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2511 // Re-exported shared library headers must be included as well since they can help us with type information
2512 // about template instantiations (instantiated from their headers).
2513 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2514 // scripts.
2515 c.sabi.Properties.ReexportedIncludes = append(
2516 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2517 }
2518
Colin Cross6e511a92020-07-27 21:26:48 -07002519 makeLibName := c.makeLibName(ctx, ccDep, depName) + libDepTag.makeSuffix
2520 switch {
2521 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002522 c.Properties.AndroidMkHeaderLibs = append(
2523 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002524 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002525 if lib := moduleLibraryInterface(dep); lib != nil {
2526 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002527 // Add the dependency to the APEX(es) providing the library so that
2528 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002529 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
2530 for _, an := range depApexInfo.InApexes {
Colin Cross6e511a92020-07-27 21:26:48 -07002531 c.Properties.ApexesProvidingSharedLibs = append(
2532 c.Properties.ApexesProvidingSharedLibs, an)
2533 }
2534 }
2535 }
2536
2537 // Note: the order of libs in this list is not important because
2538 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002539 c.Properties.AndroidMkSharedLibs = append(
2540 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002541 // Record baseLibName for snapshots.
2542 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, baseLibName(depName))
2543 case libDepTag.static():
2544 if libDepTag.wholeStatic {
2545 c.Properties.AndroidMkWholeStaticLibs = append(
2546 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2547 } else {
2548 c.Properties.AndroidMkStaticLibs = append(
2549 c.Properties.AndroidMkStaticLibs, makeLibName)
2550 }
2551 }
2552 } else {
2553 switch depTag {
2554 case runtimeDepTag:
2555 c.Properties.AndroidMkRuntimeLibs = append(
2556 c.Properties.AndroidMkRuntimeLibs, c.makeLibName(ctx, ccDep, depName)+libDepTag.makeSuffix)
2557 // Record baseLibName for snapshots.
2558 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, baseLibName(depName))
2559 case objDepTag:
2560 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2561 case CrtBeginDepTag:
2562 depPaths.CrtBegin = linkFile
2563 case CrtEndDepTag:
2564 depPaths.CrtEnd = linkFile
2565 case dynamicLinkerDepTag:
2566 depPaths.DynamicLinker = linkFile
2567 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002568 }
Colin Crossca860ac2016-01-04 14:34:37 -08002569 })
2570
Jeff Gaston294356f2017-09-27 17:05:30 -07002571 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002572 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2573 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2574 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002575
Colin Crossdd84e052017-05-17 13:44:16 -07002576 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002577 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002578 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2579 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002580 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002581 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2582 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002583 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002584 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002585 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002586
2587 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002588 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002589 }
Colin Crossdd84e052017-05-17 13:44:16 -07002590
Colin Crossca860ac2016-01-04 14:34:37 -08002591 return depPaths
2592}
2593
Colin Cross0de8a1e2020-09-18 14:15:30 -07002594// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2595// to match the topological order of the dependency tree, including any static analogues of
2596// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2597// of the transitive dependencies.
2598func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2599 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2600 var staticPaths android.Paths
2601 for _, staticDep := range staticDeps {
2602 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2603 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2604 }
2605 for _, sharedDep := range sharedDeps {
2606 if sharedDep.StaticAnalogue != nil {
2607 transitiveStaticLibsBuilder.Transitive(sharedDep.StaticAnalogue.TransitiveStaticLibrariesForOrdering)
2608 }
2609 }
2610 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2611
2612 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2613
2614 // reorder the dependencies based on transitive dependencies
2615 staticPaths = android.FirstUniquePaths(staticPaths)
2616 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2617
2618 if len(orderedStaticPaths) != len(staticPaths) {
2619 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2620 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2621 }
2622
2623 return orderedStaticPaths, transitiveStaticLibs
2624}
2625
Colin Cross6e511a92020-07-27 21:26:48 -07002626// baseLibName trims known prefixes and suffixes
2627func baseLibName(depName string) string {
2628 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
2629 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
2630 libName = strings.TrimPrefix(libName, "prebuilt_")
2631 return libName
2632}
2633
2634func (c *Module) makeLibName(ctx android.ModuleContext, ccDep LinkableInterface, depName string) string {
2635 vendorSuffixModules := vendorSuffixModules(ctx.Config())
2636 vendorPublicLibraries := vendorPublicLibraries(ctx.Config())
2637
2638 libName := baseLibName(depName)
2639 isLLndk := isLlndkLibrary(libName, ctx.Config())
2640 isVendorPublicLib := inList(libName, *vendorPublicLibraries)
2641 bothVendorAndCoreVariantsExist := ccDep.HasVendorVariant() || isLLndk
2642
2643 if c, ok := ccDep.(*Module); ok {
2644 // Use base module name for snapshots when exporting to Makefile.
2645 if c.isSnapshotPrebuilt() {
2646 baseName := c.BaseModuleName()
2647
2648 if c.IsVndk() {
2649 return baseName + ".vendor"
2650 }
2651
2652 if vendorSuffixModules[baseName] {
2653 return baseName + ".vendor"
2654 } else {
2655 return baseName
2656 }
2657 }
2658 }
2659
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002660 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
2661 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07002662 // The vendor module is a no-vendor-variant VNDK library. Depend on the
2663 // core module instead.
2664 return libName
2665 } else if c.UseVndk() && bothVendorAndCoreVariantsExist {
2666 // The vendor module in Make will have been renamed to not conflict with the core
2667 // module, so update the dependency name here accordingly.
2668 return libName + c.getNameSuffixWithVndkVersion(ctx)
2669 } else if (ctx.Platform() || ctx.ProductSpecific()) && isVendorPublicLib {
2670 return libName + vendorPublicLibrarySuffix
2671 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
2672 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002673 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
2674 return libName + vendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002675 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
2676 return libName + recoverySuffix
2677 } else if ccDep.Module().Target().NativeBridge == android.NativeBridgeEnabled {
2678 return libName + nativeBridgeSuffix
2679 } else {
2680 return libName
2681 }
2682}
2683
Colin Crossca860ac2016-01-04 14:34:37 -08002684func (c *Module) InstallInData() bool {
2685 if c.installer == nil {
2686 return false
2687 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002688 return c.installer.inData()
2689}
2690
2691func (c *Module) InstallInSanitizerDir() bool {
2692 if c.installer == nil {
2693 return false
2694 }
2695 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07002696 return true
2697 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002698 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08002699}
2700
Yifan Hong1b3348d2020-01-21 15:53:22 -08002701func (c *Module) InstallInRamdisk() bool {
2702 return c.InRamdisk()
2703}
2704
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002705func (c *Module) InstallInVendorRamdisk() bool {
2706 return c.InVendorRamdisk()
2707}
2708
Jiyong Parkf9332f12018-02-01 00:54:12 +09002709func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07002710 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09002711}
2712
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002713func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002714 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002715 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002716 return
2717 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002718 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002719}
2720
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07002721func (c *Module) HostToolPath() android.OptionalPath {
2722 if c.installer == nil {
2723 return android.OptionalPath{}
2724 }
2725 return c.installer.hostToolPath()
2726}
2727
Nan Zhangd4e641b2017-07-12 12:55:28 -07002728func (c *Module) IntermPathForModuleOut() android.OptionalPath {
2729 return c.outputFile
2730}
2731
Colin Cross41955e82019-05-29 14:40:35 -07002732func (c *Module) OutputFiles(tag string) (android.Paths, error) {
2733 switch tag {
2734 case "":
2735 if c.outputFile.Valid() {
2736 return android.Paths{c.outputFile.Path()}, nil
2737 }
2738 return android.Paths{}, nil
2739 default:
2740 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002741 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002742}
2743
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00002744func (c *Module) static() bool {
2745 if static, ok := c.linker.(interface {
2746 static() bool
2747 }); ok {
2748 return static.static()
2749 }
2750 return false
2751}
2752
Jiyong Park379de2f2018-12-19 02:47:14 +09002753func (c *Module) staticBinary() bool {
2754 if static, ok := c.linker.(interface {
2755 staticBinary() bool
2756 }); ok {
2757 return static.staticBinary()
2758 }
2759 return false
2760}
2761
Jiyong Park1d1119f2019-07-29 21:27:18 +09002762func (c *Module) header() bool {
2763 if h, ok := c.linker.(interface {
2764 header() bool
2765 }); ok {
2766 return h.header()
2767 }
2768 return false
2769}
2770
Inseob Kim7f283f42020-06-01 21:53:49 +09002771func (c *Module) binary() bool {
2772 if b, ok := c.linker.(interface {
2773 binary() bool
2774 }); ok {
2775 return b.binary()
2776 }
2777 return false
2778}
2779
Inseob Kim1042d292020-06-01 23:23:05 +09002780func (c *Module) object() bool {
2781 if o, ok := c.linker.(interface {
2782 object() bool
2783 }); ok {
2784 return o.object()
2785 }
2786 return false
2787}
2788
Jooyung Han38002912019-05-16 04:01:54 +09002789func (c *Module) getMakeLinkType(actx android.ModuleContext) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07002790 if c.UseVndk() {
Jooyung Han38002912019-05-16 04:01:54 +09002791 if lib, ok := c.linker.(*llndkStubDecorator); ok {
2792 if Bool(lib.Properties.Vendor_available) {
Colin Crossb60190a2018-09-04 16:28:17 -07002793 return "native:vndk"
2794 }
Jooyung Han38002912019-05-16 04:01:54 +09002795 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07002796 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002797 if c.IsVndk() && !c.isVndkExt() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002798 // Product_available, if defined, must have the same value with Vendor_available.
Jooyung Han38002912019-05-16 04:01:54 +09002799 if Bool(c.VendorProperties.Vendor_available) {
2800 return "native:vndk"
2801 }
2802 return "native:vndk_private"
2803 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09002804 if c.inProduct() {
2805 return "native:product"
2806 }
Jooyung Han38002912019-05-16 04:01:54 +09002807 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08002808 } else if c.InRamdisk() {
2809 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002810 } else if c.InVendorRamdisk() {
2811 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07002812 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07002813 return "native:recovery"
2814 } else if c.Target().Os == android.Android && String(c.Properties.Sdk_version) != "" {
2815 return "native:ndk:none:none"
2816 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
2817 //family, link := getNdkStlFamilyAndLinkType(c)
2818 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07002819 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08002820 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07002821 } else {
2822 return "native:platform"
2823 }
2824}
2825
Jiyong Park9d452992018-10-03 00:38:19 +09002826// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01002827// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09002828func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07002829 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09002830 // Stub libs and prebuilt libs in a versioned SDK are not
2831 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07002832 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01002833 } else if _, ok := c.linker.(testPerSrc); ok {
2834 return true
Jiyong Park9d452992018-10-03 00:38:19 +09002835 }
2836 return false
2837}
2838
Jiyong Parka90ca002019-10-07 15:47:24 +09002839func (c *Module) AvailableFor(what string) bool {
2840 if linker, ok := c.linker.(interface {
2841 availableFor(string) bool
2842 }); ok {
2843 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
2844 } else {
2845 return c.ApexModuleBase.AvailableFor(what)
2846 }
2847}
2848
Jiyong Park62304bb2020-04-13 16:19:48 +09002849func (c *Module) TestFor() []string {
2850 if test, ok := c.linker.(interface {
2851 testFor() []string
2852 }); ok {
2853 return test.testFor()
2854 } else {
2855 return c.ApexModuleBase.TestFor()
2856 }
2857}
2858
Colin Crossaede88c2020-08-11 12:17:01 -07002859func (c *Module) UniqueApexVariations() bool {
2860 if u, ok := c.compiler.(interface {
2861 uniqueApexVariations() bool
2862 }); ok {
2863 return u.uniqueApexVariations()
2864 } else {
2865 return false
2866 }
2867}
2868
Paul Duffin0cb37b92020-03-04 14:52:46 +00002869// Return true if the module is ever installable.
2870func (c *Module) EverInstallable() bool {
2871 return c.installer != nil &&
2872 // Check to see whether the module is actually ever installable.
2873 c.installer.everInstallable()
2874}
2875
Colin Cross56a83212020-09-15 18:30:11 -07002876func (c *Module) installable(apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00002877 ret := c.EverInstallable() &&
2878 // Check to see whether the module has been configured to not be installed.
2879 proptools.BoolDefault(c.Properties.Installable, true) &&
2880 !c.Properties.PreventInstall && c.outputFile.Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002881
2882 // The platform variant doesn't need further condition. Apex variants however might not
2883 // be installable because it will likely to be included in the APEX and won't appear
2884 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07002885 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002886 return ret
2887 }
2888
2889 // Special case for modules that are configured to be installed to /data, which includes
2890 // test modules. For these modules, both APEX and non-APEX variants are considered as
2891 // installable. This is because even the APEX variants won't be included in the APEX, but
2892 // will anyway be installed to /data/*.
2893 // See b/146995717
2894 if c.InstallInData() {
2895 return ret
2896 }
2897
2898 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09002899}
2900
Logan Chien41eabe62019-04-10 13:33:58 +08002901func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
2902 if c.linker != nil {
2903 if library, ok := c.linker.(*libraryDecorator); ok {
2904 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
2905 }
2906 }
2907}
2908
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002909func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07002910 depTag := ctx.OtherModuleDependencyTag(dep)
2911 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
2912
2913 if cc, ok := dep.(*Module); ok {
2914 if cc.HasStubsVariants() {
2915 if isLibDepTag && libDepTag.shared() {
2916 // dynamic dep to a stubs lib crosses APEX boundary
2917 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002918 }
Colin Cross6e511a92020-07-27 21:26:48 -07002919 if IsRuntimeDepTag(depTag) {
2920 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002921 return false
2922 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002923 }
Colin Crossaac32222020-07-29 12:51:56 -07002924 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07002925 // shared_lib dependency from a static lib is considered as crossing
2926 // the APEX boundary because the dependency doesn't actually is
2927 // linked; the dependency is used only during the compilation phase.
2928 return false
2929 }
2930 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002931 if depTag == stubImplDepTag || depTag == llndkImplDep {
2932 // We don't track beyond LLNDK or from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09002933 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002934 }
2935 return true
2936}
2937
Dan Albertc8060532020-07-22 22:32:17 -07002938func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2939 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09002940 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
2941 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
2942 return nil
2943 }
2944 // b/154569636: set min_sdk_version correctly for toolchain_libraries
2945 if c.ToolchainLibrary() {
2946 return nil
2947 }
2948 // We don't check for prebuilt modules
2949 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
2950 return nil
2951 }
2952 minSdkVersion := c.MinSdkVersion()
2953 if minSdkVersion == "apex_inherit" {
2954 return nil
2955 }
2956 if minSdkVersion == "" {
2957 // JNI libs within APK-in-APEX fall into here
2958 // Those are okay to set sdk_version instead
2959 // We don't have to check if this is a SDK variant because
2960 // non-SDK variant resets sdk_version, which works too.
2961 minSdkVersion = c.SdkVersion()
2962 }
Dan Albertc8060532020-07-22 22:32:17 -07002963 if minSdkVersion == "" {
2964 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
2965 }
2966 // Not using nativeApiLevelFromUser because the context here is not
2967 // necessarily a native context.
2968 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09002969 if err != nil {
2970 return err
2971 }
Dan Albertc8060532020-07-22 22:32:17 -07002972
2973 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09002974 return fmt.Errorf("newer SDK(%v)", ver)
2975 }
2976 return nil
2977}
2978
Colin Cross2ba19d92015-05-07 15:44:20 -07002979//
Colin Crosscfad1192015-11-02 16:43:11 -08002980// Defaults
2981//
Colin Crossca860ac2016-01-04 14:34:37 -08002982type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002983 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07002984 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09002985 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08002986}
2987
Patrice Arrudac249c712019-03-19 17:00:29 -07002988// cc_defaults provides a set of properties that can be inherited by other cc
2989// modules. A module can use the properties from a cc_defaults using
2990// `defaults: ["<:default_module_name>"]`. Properties of both modules are
2991// merged (when possible) by prepending the default module's values to the
2992// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07002993func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07002994 return DefaultsFactory()
2995}
2996
Colin Cross36242852017-06-23 15:06:31 -07002997func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08002998 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08002999
Colin Cross36242852017-06-23 15:06:31 -07003000 module.AddProperties(props...)
3001 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003002 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003003 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003004 &BaseCompilerProperties{},
3005 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003006 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003007 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003008 &StaticProperties{},
3009 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003010 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003011 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003012 &TestProperties{},
3013 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003014 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003015 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003016 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003017 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003018 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003019 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003020 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003021 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003022 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003023 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003024 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003025 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003026 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003027 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3028 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003029 )
Colin Crosscfad1192015-11-02 16:43:11 -08003030
Jooyung Hancc372c52019-09-25 15:18:44 +09003031 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003032
3033 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003034}
3035
Jiyong Park2286afd2020-06-16 21:58:53 +09003036func (c *Module) IsSdkVariant() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07003037 return c.Properties.IsSdkVariant || c.AlwaysSdk()
Jiyong Park2286afd2020-06-16 21:58:53 +09003038}
3039
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003040func kytheExtractAllFactory() android.Singleton {
3041 return &kytheExtractAllSingleton{}
3042}
3043
3044type kytheExtractAllSingleton struct {
3045}
3046
3047func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3048 var xrefTargets android.Paths
3049 ctx.VisitAllModules(func(module android.Module) {
3050 if ccModule, ok := module.(xref); ok {
3051 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3052 }
3053 })
3054 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3055 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003056 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003057 }
3058}
3059
Colin Cross06a931b2015-10-28 17:23:31 -07003060var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003061var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003062var BoolPtr = proptools.BoolPtr
3063var String = proptools.String
3064var StringPtr = proptools.StringPtr