blob: 5f028b8a3240dfef0467ab1c5c5a5c1a7fa4cd07 [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
Colin Cross57898582020-10-29 18:25:19 -070091 ctx.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
Colin Cross95f1ca02020-10-29 20:47:22 -0700372 isNdk(config android.Config) 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
Colin Crosse9fe2942020-11-10 18:12:15 -0800554// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
555// binaries or other shared libraries are installed as dependencies.
556func (d libraryDependencyTag) InstallDepNeeded() bool {
557 return d.shared()
558}
559
560var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
561
562// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700563// libraryDependencyTag. Each tag object is created globally and reused for multiple
564// dependencies (although since the object contains no references, assigning a tag to a
565// variable and modifying it will not modify the original). Users can compare the tag
566// returned by ctx.OtherModuleDependencyTag against the global original
567type dependencyTag struct {
568 blueprint.BaseDependencyTag
569 name string
570}
571
Colin Crosse9fe2942020-11-10 18:12:15 -0800572// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
573// libraryDependencyTag, but where the dependency needs to be installed when the parent is
574// installed.
575type installDependencyTag struct {
576 blueprint.BaseDependencyTag
577 android.InstallAlwaysNeededDependencyTag
578 name string
579}
580
Colin Crossc99deeb2016-04-11 15:06:20 -0700581var (
Colin Cross6e511a92020-07-27 21:26:48 -0700582 genSourceDepTag = dependencyTag{name: "gen source"}
583 genHeaderDepTag = dependencyTag{name: "gen header"}
584 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
585 objDepTag = dependencyTag{name: "obj"}
586 linkerFlagsDepTag = dependencyTag{name: "linker flags file"}
587 dynamicLinkerDepTag = dependencyTag{name: "dynamic linker"}
588 reuseObjTag = dependencyTag{name: "reuse objects"}
589 staticVariantTag = dependencyTag{name: "static variant"}
590 vndkExtDepTag = dependencyTag{name: "vndk extends"}
591 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800592 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700593 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700594 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700595)
596
Colin Cross56a83212020-09-15 18:30:11 -0700597type copyDirectlyInAnyApexDependencyTag dependencyTag
598
599func (copyDirectlyInAnyApexDependencyTag) CopyDirectlyInAnyApex() {}
600
601var _ android.CopyDirectlyInAnyApexTag = copyDirectlyInAnyApexDependencyTag{}
602
Roland Levillainf89cd092019-07-29 16:22:59 +0100603func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700604 ccLibDepTag, ok := depTag.(libraryDependencyTag)
605 return ok && ccLibDepTag.shared()
606}
607
608func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
609 ccLibDepTag, ok := depTag.(libraryDependencyTag)
610 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100611}
612
Zach Johnson3df4e632020-11-06 11:56:27 -0800613func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
614 ccLibDepTag, ok := depTag.(libraryDependencyTag)
615 return ok && ccLibDepTag.header()
616}
617
Roland Levillainf89cd092019-07-29 16:22:59 +0100618func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800619 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100620}
621
622func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700623 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100624 return ok && ccDepTag == testPerSrcDepTag
625}
626
Colin Crossca860ac2016-01-04 14:34:37 -0800627// Module contains the properties and members used by all C/C++ module types, and implements
628// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
629// to construct the output file. Behavior can be customized with a Customizer interface
630type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700631 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700632 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900633 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900634 android.SdkBase
Colin Crossc472d572015-03-17 15:06:21 -0700635
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700636 Properties BaseProperties
637 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700638
Colin Crossca860ac2016-01-04 14:34:37 -0800639 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700640 hod android.HostOrDeviceSupported
641 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700642
Paul Duffina0843f62019-12-13 19:50:38 +0000643 // Allowable SdkMemberTypes of this module type.
644 sdkMemberTypes []android.SdkMemberType
645
Colin Crossca860ac2016-01-04 14:34:37 -0800646 // delegates, initialize before calling Init
Colin Crossb4ce0ec2016-09-13 13:41:39 -0700647 features []feature
648 compiler compiler
649 linker linker
650 installer installer
651 stl *stl
652 sanitize *sanitize
Dan Willemsen581341d2017-02-09 16:16:31 -0800653 coverage *coverage
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800654 sabi *sabi
Justin Yun8effde42017-06-23 19:24:43 +0900655 vndkdep *vndkdep
Stephen Craneba090d12017-05-09 15:44:35 -0700656 lto *lto
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700657 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800658
Colin Cross31076b32020-10-23 17:22:06 -0700659 library libraryInterface
660
Colin Cross635c3b02016-05-18 15:37:25 -0700661 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800662
Colin Crossb98c8b02016-07-29 13:44:28 -0700663 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700664
665 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800666
667 // Flags used to compile this module
668 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700669
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800670 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700671 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900672
673 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800674 // Kythe (source file indexer) paths for this compilation module
675 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900676
677 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700678 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700679
680 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700681}
682
Ivan Lozano52767be2019-10-18 14:49:46 -0700683func (c *Module) Toc() android.OptionalPath {
684 if c.linker != nil {
685 if library, ok := c.linker.(libraryInterface); ok {
686 return library.toc()
687 }
688 }
689 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
690}
691
692func (c *Module) ApiLevel() string {
693 if c.linker != nil {
694 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700695 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700696 }
697 }
698 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
699}
700
701func (c *Module) Static() bool {
702 if c.linker != nil {
703 if library, ok := c.linker.(libraryInterface); ok {
704 return library.static()
705 }
706 }
707 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
708}
709
710func (c *Module) Shared() bool {
711 if c.linker != nil {
712 if library, ok := c.linker.(libraryInterface); ok {
713 return library.shared()
714 }
715 }
716 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
717}
718
719func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000720 if c.stl != nil {
721 return c.stl.Properties.SelectedStl
722 }
723 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700724}
725
726func (c *Module) ToolchainLibrary() bool {
727 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
728 return true
729 }
730 return false
731}
732
733func (c *Module) NdkPrebuiltStl() bool {
734 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
735 return true
736 }
737 return false
738}
739
740func (c *Module) StubDecorator() bool {
741 if _, ok := c.linker.(*stubDecorator); ok {
742 return true
743 }
744 return false
745}
746
747func (c *Module) SdkVersion() string {
748 return String(c.Properties.Sdk_version)
749}
750
Artur Satayev480e25b2020-04-27 18:53:18 +0100751func (c *Module) MinSdkVersion() string {
752 return String(c.Properties.Min_sdk_version)
753}
754
Dan Albert92fe7402020-07-15 13:33:30 -0700755func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700756 if !c.canUseSdk() {
757 return false
758 }
Dan Albert92fe7402020-07-15 13:33:30 -0700759 if linker, ok := c.linker.(*objectLinker); ok {
760 return linker.isCrt()
761 }
762 return false
763}
764
Colin Crossc511bc52020-04-07 16:50:32 +0000765func (c *Module) AlwaysSdk() bool {
766 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
767}
768
Ivan Lozano183a3212019-10-18 14:18:45 -0700769func (c *Module) CcLibrary() bool {
770 if c.linker != nil {
771 if _, ok := c.linker.(*libraryDecorator); ok {
772 return true
773 }
Colin Crossd48fe732020-09-23 20:37:24 -0700774 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
775 return true
776 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700777 }
778 return false
779}
780
781func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700782 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700783 return true
784 }
785 return false
786}
787
Ivan Lozano2b262972019-11-21 12:30:50 -0800788func (c *Module) NonCcVariants() bool {
789 return false
790}
791
Ivan Lozano183a3212019-10-18 14:18:45 -0700792func (c *Module) SetStatic() {
793 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700794 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700795 library.setStatic()
796 return
797 }
798 }
799 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
800}
801
802func (c *Module) SetShared() {
803 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700804 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700805 library.setShared()
806 return
807 }
808 }
809 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
810}
811
812func (c *Module) BuildStaticVariant() bool {
813 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700814 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700815 return library.buildStatic()
816 }
817 }
818 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
819}
820
821func (c *Module) BuildSharedVariant() bool {
822 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700823 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700824 return library.buildShared()
825 }
826 }
827 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
828}
829
830func (c *Module) Module() android.Module {
831 return c
832}
833
Jiyong Parkc20eee32018-09-05 22:36:17 +0900834func (c *Module) OutputFile() android.OptionalPath {
835 return c.outputFile
836}
837
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400838func (c *Module) CoverageFiles() android.Paths {
839 if c.linker != nil {
840 if library, ok := c.linker.(libraryInterface); ok {
841 return library.objs().coverageFiles
842 }
843 }
844 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
845}
846
Ivan Lozano183a3212019-10-18 14:18:45 -0700847var _ LinkableInterface = (*Module)(nil)
848
Jiyong Park719b4462019-01-13 00:39:51 +0900849func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900850 if c.linker != nil {
851 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +0900852 }
853 return nil
854}
855
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900856func (c *Module) CoverageOutputFile() android.OptionalPath {
857 if c.linker != nil {
858 return c.linker.coverageOutputFilePath()
859 }
860 return android.OptionalPath{}
861}
862
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900863func (c *Module) RelativeInstallPath() string {
864 if c.installer != nil {
865 return c.installer.relativeInstallPath()
866 }
867 return ""
868}
869
Jooyung Han344d5432019-08-23 11:17:39 +0900870func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +0900871 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +0900872}
873
Colin Cross36242852017-06-23 15:06:31 -0700874func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -0700875 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -0800876 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -0700877 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800878 }
879 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -0700880 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800881 }
882 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -0700883 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800884 }
Colin Crossa8e07cc2016-04-04 15:07:06 -0700885 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -0700886 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -0700887 }
Colin Cross16b23492016-01-06 14:41:07 -0800888 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -0700889 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -0800890 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800891 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -0700892 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -0800893 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800894 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -0700895 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800896 }
Justin Yun8effde42017-06-23 19:24:43 +0900897 if c.vndkdep != nil {
898 c.AddProperties(c.vndkdep.props()...)
899 }
Stephen Craneba090d12017-05-09 15:44:35 -0700900 if c.lto != nil {
901 c.AddProperties(c.lto.props()...)
902 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700903 if c.pgo != nil {
904 c.AddProperties(c.pgo.props()...)
905 }
Colin Crossca860ac2016-01-04 14:34:37 -0800906 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -0700907 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800908 }
Colin Crossc472d572015-03-17 15:06:21 -0700909
Jiyong Park1613e552020-09-14 19:43:17 +0900910 c.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, os android.OsType) bool {
Elliott Hughes79ae3412020-04-17 15:49:49 -0700911 // Windows builds always prefer 32-bit
Jiyong Park1613e552020-09-14 19:43:17 +0900912 return os == android.Windows
Colin Crossa9d8bee2018-10-02 13:59:46 -0700913 })
Colin Cross36242852017-06-23 15:06:31 -0700914 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +0900915 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900916 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +0900917 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +0900918
Colin Cross36242852017-06-23 15:06:31 -0700919 return c
Colin Crossc472d572015-03-17 15:06:21 -0700920}
921
Colin Crossb916a382016-07-29 17:28:03 -0700922// Returns true for dependency roots (binaries)
923// TODO(ccross): also handle dlopenable libraries
924func (c *Module) isDependencyRoot() bool {
925 if root, ok := c.linker.(interface {
926 isDependencyRoot() bool
927 }); ok {
928 return root.isDependencyRoot()
929 }
930 return false
931}
932
Justin Yun5f7f7e82019-11-18 19:52:14 +0900933// Returns true if the module is using VNDK libraries instead of the libraries in /system/lib or /system/lib64.
934// "product" and "vendor" variant modules return true for this function.
935// When BOARD_VNDK_VERSION is set, vendor variants of "vendor_available: true", "vendor: true",
936// "soc_specific: true" and more vendor installed modules are included here.
Justin Yun63e9ec72020-10-29 16:49:43 +0900937// When PRODUCT_PRODUCT_VNDK_VERSION is set, product variants of "product_available: true" or
Justin Yun5f7f7e82019-11-18 19:52:14 +0900938// "product_specific: true" modules are included here.
Ivan Lozano52767be2019-10-18 14:49:46 -0700939func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +0900940 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700941}
942
Colin Crossc511bc52020-04-07 16:50:32 +0000943func (c *Module) canUseSdk() bool {
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700944 return c.Os() == android.Android && !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +0000945}
946
947func (c *Module) UseSdk() bool {
948 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -0700949 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +0000950 }
951 return false
952}
953
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800954func (c *Module) isCoverageVariant() bool {
955 return c.coverage.Properties.IsCoverageVariant
956}
957
Colin Cross95f1ca02020-10-29 20:47:22 -0700958func (c *Module) IsNdk(config android.Config) bool {
959 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800960}
961
Inseob Kim9516ee92019-05-09 10:56:13 +0900962func (c *Module) isLlndk(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800963 // Returns true for both LLNDK (public) and LLNDK-private libs.
Jooyung Han0302a842019-10-30 18:43:49 +0900964 return isLlndkLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800965}
966
Inseob Kim9516ee92019-05-09 10:56:13 +0900967func (c *Module) isLlndkPublic(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800968 // Returns true only for LLNDK (public) libs.
Jooyung Han0302a842019-10-30 18:43:49 +0900969 name := c.BaseModuleName()
970 return isLlndkLibrary(name, config) && !isVndkPrivateLibrary(name, config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800971}
972
Inseob Kim9516ee92019-05-09 10:56:13 +0900973func (c *Module) isVndkPrivate(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800974 // Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Jooyung Han0302a842019-10-30 18:43:49 +0900975 return isVndkPrivateLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800976}
977
Ivan Lozano52767be2019-10-18 14:49:46 -0700978func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +0800979 if vndkdep := c.vndkdep; vndkdep != nil {
980 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +0900981 }
982 return false
983}
984
Yi Kong7e53c572018-02-14 18:16:12 +0800985func (c *Module) isPgoCompile() bool {
986 if pgo := c.pgo; pgo != nil {
987 return pgo.Properties.PgoCompile
988 }
989 return false
990}
991
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800992func (c *Module) isNDKStubLibrary() bool {
993 if _, ok := c.compiler.(*stubDecorator); ok {
994 return true
995 }
996 return false
997}
998
Logan Chienf3511742017-10-31 18:04:35 +0800999func (c *Module) isVndkSp() bool {
1000 if vndkdep := c.vndkdep; vndkdep != nil {
1001 return vndkdep.isVndkSp()
1002 }
1003 return false
1004}
1005
1006func (c *Module) isVndkExt() bool {
1007 if vndkdep := c.vndkdep; vndkdep != nil {
1008 return vndkdep.isVndkExt()
1009 }
1010 return false
1011}
1012
Ivan Lozano52767be2019-10-18 14:49:46 -07001013func (c *Module) MustUseVendorVariant() bool {
Jooyung Han097087b2019-10-22 19:32:18 +09001014 return c.isVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001015}
1016
Logan Chienf3511742017-10-31 18:04:35 +08001017func (c *Module) getVndkExtendsModuleName() string {
1018 if vndkdep := c.vndkdep; vndkdep != nil {
1019 return vndkdep.getVndkExtendsModuleName()
1020 }
1021 return ""
1022}
1023
Jiyong Park25fc6a92018-11-18 18:02:45 +09001024func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001025 if lib := c.library; lib != nil {
1026 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001027 }
1028 return false
1029}
1030
1031func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001032 if lib := c.library; lib != nil {
1033 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001034 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001035 return false
1036}
1037
Colin Cross0477b422020-10-13 18:43:54 -07001038// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1039// the implementation. If it is an implementation library it returns its own name.
1040func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1041 name := ctx.OtherModuleName(c)
1042 if versioned, ok := c.linker.(versionedInterface); ok {
1043 name = versioned.implementationModuleName(name)
1044 }
1045 return name
1046}
1047
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001048func (c *Module) bootstrap() bool {
1049 return Bool(c.Properties.Bootstrap)
1050}
1051
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001052func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001053 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1054 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1055 return false
1056 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001057 return c.linker != nil && c.linker.nativeCoverage()
1058}
1059
Inseob Kim8471cda2019-11-15 09:59:12 +09001060func (c *Module) isSnapshotPrebuilt() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09001061 if p, ok := c.linker.(interface{ isSnapshotPrebuilt() bool }); ok {
1062 return p.isSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001063 }
1064 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001065}
1066
Bill Peckham945441c2020-08-31 16:07:58 -07001067func (c *Module) ExcludeFromVendorSnapshot() bool {
1068 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1069}
1070
Jose Galmesf7294582020-11-13 12:07:36 -08001071func (c *Module) ExcludeFromRecoverySnapshot() bool {
1072 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1073}
1074
Jiyong Parkf1194352019-02-25 11:05:47 +09001075func isBionic(name string) bool {
1076 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001077 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001078 return true
1079 }
1080 return false
1081}
1082
Martin Stjernholm279de572019-09-10 23:18:20 +01001083func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001084 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001085 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001086 }
1087 return isBionic(name)
1088}
1089
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001090func (c *Module) XrefCcFiles() android.Paths {
1091 return c.kytheFiles
1092}
1093
Colin Crossca860ac2016-01-04 14:34:37 -08001094type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001095 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001096 moduleContextImpl
1097}
1098
Colin Cross37047f12016-12-13 17:06:13 -08001099type depsContext struct {
1100 android.BottomUpMutatorContext
1101 moduleContextImpl
1102}
1103
Colin Crossca860ac2016-01-04 14:34:37 -08001104type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001105 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001106 moduleContextImpl
1107}
1108
1109type moduleContextImpl struct {
1110 mod *Module
1111 ctx BaseModuleContext
1112}
1113
Colin Crossb98c8b02016-07-29 13:44:28 -07001114func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001115 return ctx.mod.toolchain(ctx.ctx)
1116}
1117
1118func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001119 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001120}
1121
1122func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001123 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001124}
1125
Jiyong Park1d1119f2019-07-29 21:27:18 +09001126func (ctx *moduleContextImpl) header() bool {
1127 return ctx.mod.header()
1128}
1129
Inseob Kim7f283f42020-06-01 21:53:49 +09001130func (ctx *moduleContextImpl) binary() bool {
1131 return ctx.mod.binary()
1132}
1133
Inseob Kim1042d292020-06-01 23:23:05 +09001134func (ctx *moduleContextImpl) object() bool {
1135 return ctx.mod.object()
1136}
1137
Jooyung Hanccce2f22020-03-07 03:45:53 +09001138func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001139 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001140}
1141
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001142func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001143 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001144}
1145
1146func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001147 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001148 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001149 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001150 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001151 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001152 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001153 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001154 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001155 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001156 }
1157 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001158}
1159
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001160func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001161 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001162}
Justin Yun8effde42017-06-23 19:24:43 +09001163
Colin Cross95f1ca02020-10-29 20:47:22 -07001164func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1165 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001166}
1167
Inseob Kim9516ee92019-05-09 10:56:13 +09001168func (ctx *moduleContextImpl) isLlndk(config android.Config) bool {
1169 return ctx.mod.isLlndk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001170}
1171
Inseob Kim9516ee92019-05-09 10:56:13 +09001172func (ctx *moduleContextImpl) isLlndkPublic(config android.Config) bool {
1173 return ctx.mod.isLlndkPublic(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001174}
1175
Inseob Kim9516ee92019-05-09 10:56:13 +09001176func (ctx *moduleContextImpl) isVndkPrivate(config android.Config) bool {
1177 return ctx.mod.isVndkPrivate(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001178}
1179
Logan Chienf3511742017-10-31 18:04:35 +08001180func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001181 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001182}
1183
Yi Kong7e53c572018-02-14 18:16:12 +08001184func (ctx *moduleContextImpl) isPgoCompile() bool {
1185 return ctx.mod.isPgoCompile()
1186}
1187
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001188func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1189 return ctx.mod.isNDKStubLibrary()
1190}
1191
Justin Yun8effde42017-06-23 19:24:43 +09001192func (ctx *moduleContextImpl) isVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001193 return ctx.mod.isVndkSp()
1194}
1195
1196func (ctx *moduleContextImpl) isVndkExt() bool {
1197 return ctx.mod.isVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001198}
1199
Vic Yangefd249e2018-11-12 20:19:56 -08001200func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001201 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001202}
1203
Logan Chien2f2b8902018-07-10 15:01:19 +08001204// Check whether ABI dumps should be created for this module.
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001205func (ctx *moduleContextImpl) shouldCreateSourceAbiDump() bool {
Logan Chien2f2b8902018-07-10 15:01:19 +08001206 if ctx.ctx.Config().IsEnvTrue("SKIP_ABI_CHECKS") {
1207 return false
Jayant Chowdharyea0a2e12018-03-01 19:12:16 -08001208 }
Doug Hornc32c6b02019-01-17 14:44:05 -08001209
Hsin-Yi Chenf81bb652020-04-07 21:42:19 +08001210 // Coverage builds have extra symbols.
1211 if ctx.mod.isCoverageVariant() {
1212 return false
1213 }
1214
Doug Hornc32c6b02019-01-17 14:44:05 -08001215 if ctx.ctx.Fuchsia() {
1216 return false
1217 }
1218
Logan Chien2f2b8902018-07-10 15:01:19 +08001219 if sanitize := ctx.mod.sanitize; sanitize != nil {
1220 if !sanitize.isVariantOnProductionDevice() {
1221 return false
1222 }
1223 }
1224 if !ctx.ctx.Device() {
1225 // Host modules do not need ABI dumps.
1226 return false
1227 }
Colin Cross31076b32020-10-23 17:22:06 -07001228 if ctx.isNDKStubLibrary() {
Hsin-Yi Chenf6a95462019-06-25 14:46:52 +08001229 // Stubs do not need ABI dumps.
1230 return false
1231 }
Colin Cross31076b32020-10-23 17:22:06 -07001232 if lib := ctx.mod.library; lib != nil && lib.buildStubs() {
1233 // Stubs do not need ABI dumps.
1234 return false
1235 }
1236
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001237 return true
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001238}
1239
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001240func (ctx *moduleContextImpl) selectedStl() string {
1241 if stl := ctx.mod.stl; stl != nil {
1242 return stl.Properties.SelectedStl
1243 }
1244 return ""
1245}
1246
Ivan Lozanobd721262018-11-27 14:33:03 -08001247func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1248 return ctx.mod.linker.useClangLld(actx)
1249}
1250
Colin Crossce75d2c2016-10-06 16:12:58 -07001251func (ctx *moduleContextImpl) baseModuleName() string {
1252 return ctx.mod.ModuleBase.BaseModuleName()
1253}
1254
Logan Chienf3511742017-10-31 18:04:35 +08001255func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1256 return ctx.mod.getVndkExtendsModuleName()
1257}
1258
Logan Chiene274fc92019-12-03 11:18:32 -08001259func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001260 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001261}
1262
Colin Crosse07f2312020-08-13 11:24:56 -07001263func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001264 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001265}
1266
Dan Albertc8060532020-07-22 22:32:17 -07001267func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001268 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001269}
1270
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001271func (ctx *moduleContextImpl) bootstrap() bool {
1272 return ctx.mod.bootstrap()
1273}
1274
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001275func (ctx *moduleContextImpl) nativeCoverage() bool {
1276 return ctx.mod.nativeCoverage()
1277}
1278
Colin Cross56a83212020-09-15 18:30:11 -07001279func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1280 return ctx.mod.DirectlyInAnyApex()
1281}
1282
Colin Cross635c3b02016-05-18 15:37:25 -07001283func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001284 return &Module{
1285 hod: hod,
1286 multilib: multilib,
1287 }
1288}
1289
Colin Cross635c3b02016-05-18 15:37:25 -07001290func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001291 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001292 module.features = []feature{
1293 &tidyFeature{},
1294 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001295 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001296 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001297 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001298 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001299 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001300 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001301 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001302 return module
1303}
1304
Colin Crossce75d2c2016-10-06 16:12:58 -07001305func (c *Module) Prebuilt() *android.Prebuilt {
1306 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1307 return p.prebuilt()
1308 }
1309 return nil
1310}
1311
1312func (c *Module) Name() string {
1313 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001314 if p, ok := c.linker.(interface {
1315 Name(string) string
1316 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001317 name = p.Name(name)
1318 }
1319 return name
1320}
1321
Alex Light3d673592019-01-18 14:37:31 -08001322func (c *Module) Symlinks() []string {
1323 if p, ok := c.installer.(interface {
1324 symlinkList() []string
1325 }); ok {
1326 return p.symlinkList()
1327 }
1328 return nil
1329}
1330
Roland Levillainf89cd092019-07-29 16:22:59 +01001331func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1332 test, ok := c.linker.(testPerSrc)
1333 return ok && test.isAllTestsVariation()
1334}
1335
Chris Parsons216e10a2020-07-09 17:12:52 -04001336func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001337 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001338 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001339 }); ok {
1340 return p.dataPaths()
1341 }
1342 return nil
1343}
1344
Justin Yun5f7f7e82019-11-18 19:52:14 +09001345func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1346 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1347 // "current", it will append the VNDK version to the name suffix.
1348 var vndkVersion string
1349 var nameSuffix string
1350 if c.inProduct() {
1351 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1352 nameSuffix = productSuffix
1353 } else {
1354 vndkVersion = ctx.DeviceConfig().VndkVersion()
1355 nameSuffix = vendorSuffix
1356 }
1357 if vndkVersion == "current" {
1358 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1359 }
1360 if c.Properties.VndkVersion != vndkVersion {
1361 // add version suffix only if the module is using different vndk version than the
1362 // version in product or vendor partition.
1363 nameSuffix += "." + c.Properties.VndkVersion
1364 }
1365 return nameSuffix
1366}
1367
Colin Cross635c3b02016-05-18 15:37:25 -07001368func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Roland Levillainf2fad972019-06-28 15:41:19 +01001369 // Handle the case of a test module split by `test_per_src` mutator.
Roland Levillainf89cd092019-07-29 16:22:59 +01001370 //
1371 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1372 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1373 // module and return early, as this module does not produce an output file per se.
1374 if c.IsTestPerSrcAllTestsVariation() {
1375 c.outputFile = android.OptionalPath{}
1376 return
Roland Levillainf2fad972019-06-28 15:41:19 +01001377 }
1378
Colin Cross56a83212020-09-15 18:30:11 -07001379 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1380 if !apexInfo.IsForPlatform() {
1381 c.hideApexVariantFromMake = true
1382 }
1383
Jooyung Han38002912019-05-16 04:01:54 +09001384 c.makeLinkType = c.getMakeLinkType(actx)
Inseob Kim9516ee92019-05-09 10:56:13 +09001385
Inseob Kim64c43952019-08-26 16:52:35 +09001386 c.Properties.SubName = ""
1387
1388 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1389 c.Properties.SubName += nativeBridgeSuffix
1390 }
1391
Justin Yun5f7f7e82019-11-18 19:52:14 +09001392 _, llndk := c.linker.(*llndkStubDecorator)
1393 _, llndkHeader := c.linker.(*llndkHeadersDecorator)
Justin Yun63e9ec72020-10-29 16:49:43 +09001394 if llndk || llndkHeader || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001395 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1396 // added for product variant only when we have vendor and product variants with core
1397 // variant. The suffix is not added for vendor-only or product-only module.
1398 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
1399 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001400 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1401 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
1402 c.Properties.SubName += vendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001403 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1404 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001405 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
1406 c.Properties.SubName += vendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001407 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001408 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001409 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001410 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001411 if c.SplitPerApiLevel() {
1412 c.Properties.SubName += "." + c.SdkVersion()
1413 }
Inseob Kim64c43952019-08-26 16:52:35 +09001414 }
1415
Colin Crossca860ac2016-01-04 14:34:37 -08001416 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001417 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001418 moduleContextImpl: moduleContextImpl{
1419 mod: c,
1420 },
1421 }
1422 ctx.ctx = ctx
1423
Colin Crossf18e1102017-11-16 14:33:08 -08001424 deps := c.depsToPaths(ctx)
1425 if ctx.Failed() {
1426 return
1427 }
1428
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001429 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1430 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1431 }
1432
Colin Crossca860ac2016-01-04 14:34:37 -08001433 flags := Flags{
1434 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001435 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001436 }
Colin Crossca860ac2016-01-04 14:34:37 -08001437 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001438 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001439 }
1440 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001441 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001442 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001443 if c.stl != nil {
1444 flags = c.stl.flags(ctx, flags)
1445 }
Colin Cross16b23492016-01-06 14:41:07 -08001446 if c.sanitize != nil {
1447 flags = c.sanitize.flags(ctx, flags)
1448 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001449 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001450 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001451 }
Stephen Craneba090d12017-05-09 15:44:35 -07001452 if c.lto != nil {
1453 flags = c.lto.flags(ctx, flags)
1454 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001455 if c.pgo != nil {
1456 flags = c.pgo.flags(ctx, flags)
1457 }
Colin Crossca860ac2016-01-04 14:34:37 -08001458 for _, feature := range c.features {
1459 flags = feature.flags(ctx, flags)
1460 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001461 if ctx.Failed() {
1462 return
1463 }
1464
Colin Cross4af21ed2019-11-04 09:37:55 -08001465 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1466 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1467 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001468
Colin Cross4af21ed2019-11-04 09:37:55 -08001469 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001470
1471 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001472 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001473 }
1474 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001475 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001476 }
1477
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001478 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001479 // We need access to all the flags seen by a source file.
1480 if c.sabi != nil {
1481 flags = c.sabi.flags(ctx, flags)
1482 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001483
Colin Cross4af21ed2019-11-04 09:37:55 -08001484 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001485
Colin Crossca860ac2016-01-04 14:34:37 -08001486 // Optimization to reduce size of build.ninja
1487 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001488 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1489 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1490 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1491 flags.Local.CFlags = []string{"$cflags"}
1492 flags.Local.CppFlags = []string{"$cppflags"}
1493 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001494
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001495 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001496 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001497 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001498 if ctx.Failed() {
1499 return
1500 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001501 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001502 }
1503
Colin Crossca860ac2016-01-04 14:34:37 -08001504 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001505 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001506 if ctx.Failed() {
1507 return
1508 }
Colin Cross635c3b02016-05-18 15:37:25 -07001509 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001510
1511 // If a lib is directly included in any of the APEXes, unhide the stubs
1512 // variant having the latest version gets visible to make. In addition,
1513 // the non-stubs variant is renamed to <libname>.bootstrap. This is to
1514 // force anything in the make world to link against the stubs library.
1515 // (unless it is explicitly referenced via .bootstrap suffix or the
1516 // module is marked with 'bootstrap: true').
Colin Cross56a83212020-09-15 18:30:11 -07001517 if c.HasStubsVariants() && c.AnyVariantDirectlyInAnyApex() && !c.InRamdisk() &&
Ivan Lozano52767be2019-10-18 14:49:46 -07001518 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001519 c.IsStubs() && !c.InVendorRamdisk() {
Jiyong Parkb0788572018-12-20 22:10:17 +09001520 c.Properties.HideFromMake = false // unhide
1521 // Note: this is still non-installable
1522 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001523
1524 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current.
1525 if i, ok := c.linker.(snapshotLibraryInterface); ok && ctx.DeviceConfig().VndkVersion() == "current" {
Colin Cross56a83212020-09-15 18:30:11 -07001526 if isSnapshotAware(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001527 i.collectHeadersForSnapshot(ctx)
1528 }
1529 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001530 }
Colin Cross5049f022015-03-18 13:28:46 -07001531
Colin Cross56a83212020-09-15 18:30:11 -07001532 if c.installable(apexInfo) {
Colin Crossce75d2c2016-10-06 16:12:58 -07001533 c.installer.install(ctx, c.outputFile.Path())
1534 if ctx.Failed() {
1535 return
Colin Crossca860ac2016-01-04 14:34:37 -08001536 }
Paul Duffin0cb37b92020-03-04 14:52:46 +00001537 } else if !proptools.BoolDefault(c.Properties.Installable, true) {
1538 // If the module has been specifically configure to not be installed then
1539 // skip the installation as otherwise it will break when running inside make
1540 // as the output path to install will not be specified. Not all uninstallable
1541 // modules can skip installation as some are needed for resolving make side
1542 // dependencies.
1543 c.SkipInstall()
Dan Albertc403f7c2015-03-18 14:01:18 -07001544 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001545}
1546
Colin Cross0ea8ba82019-06-06 14:33:29 -07001547func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001548 if c.cachedToolchain == nil {
Colin Crossb98c8b02016-07-29 13:44:28 -07001549 c.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
Colin Cross3f40fa42015-01-30 17:27:36 -08001550 }
Colin Crossca860ac2016-01-04 14:34:37 -08001551 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001552}
1553
Colin Crossca860ac2016-01-04 14:34:37 -08001554func (c *Module) begin(ctx BaseModuleContext) {
1555 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001556 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001557 }
Colin Crossca860ac2016-01-04 14:34:37 -08001558 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001559 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001560 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001561 if c.stl != nil {
1562 c.stl.begin(ctx)
1563 }
Colin Cross16b23492016-01-06 14:41:07 -08001564 if c.sanitize != nil {
1565 c.sanitize.begin(ctx)
1566 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001567 if c.coverage != nil {
1568 c.coverage.begin(ctx)
1569 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001570 if c.sabi != nil {
1571 c.sabi.begin(ctx)
1572 }
Justin Yun8effde42017-06-23 19:24:43 +09001573 if c.vndkdep != nil {
1574 c.vndkdep.begin(ctx)
1575 }
Stephen Craneba090d12017-05-09 15:44:35 -07001576 if c.lto != nil {
1577 c.lto.begin(ctx)
1578 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001579 if c.pgo != nil {
1580 c.pgo.begin(ctx)
1581 }
Colin Crossca860ac2016-01-04 14:34:37 -08001582 for _, feature := range c.features {
1583 feature.begin(ctx)
1584 }
Dan Albert92fe7402020-07-15 13:33:30 -07001585 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001586 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001587 if err != nil {
1588 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001589 c.Properties.Sdk_version = nil
1590 } else {
1591 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001592 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001593 }
Colin Crossca860ac2016-01-04 14:34:37 -08001594}
1595
Colin Cross37047f12016-12-13 17:06:13 -08001596func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001597 deps := Deps{}
1598
1599 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001600 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001601 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001602 // Add the PGO dependency (the clang_rt.profile runtime library), which
1603 // sometimes depends on symbols from libgcc, before libgcc gets added
1604 // in linkerDeps().
Pirama Arumuga Nainar49b53d52017-10-04 16:47:29 -07001605 if c.pgo != nil {
1606 deps = c.pgo.deps(ctx, deps)
1607 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001608 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001609 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001610 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001611 if c.stl != nil {
1612 deps = c.stl.deps(ctx, deps)
1613 }
Colin Cross16b23492016-01-06 14:41:07 -08001614 if c.sanitize != nil {
1615 deps = c.sanitize.deps(ctx, deps)
1616 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001617 if c.coverage != nil {
1618 deps = c.coverage.deps(ctx, deps)
1619 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001620 if c.sabi != nil {
1621 deps = c.sabi.deps(ctx, deps)
1622 }
Justin Yun8effde42017-06-23 19:24:43 +09001623 if c.vndkdep != nil {
1624 deps = c.vndkdep.deps(ctx, deps)
1625 }
Stephen Craneba090d12017-05-09 15:44:35 -07001626 if c.lto != nil {
1627 deps = c.lto.deps(ctx, deps)
1628 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001629 for _, feature := range c.features {
1630 deps = feature.deps(ctx, deps)
1631 }
1632
Colin Crossb6715442017-10-24 11:13:31 -07001633 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1634 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1635 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1636 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1637 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1638 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001639 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001640
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001641 for _, lib := range deps.ReexportSharedLibHeaders {
1642 if !inList(lib, deps.SharedLibs) {
1643 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1644 }
1645 }
1646
1647 for _, lib := range deps.ReexportStaticLibHeaders {
1648 if !inList(lib, deps.StaticLibs) {
1649 ctx.PropertyErrorf("export_static_lib_headers", "Static library not in static_libs: '%s'", lib)
1650 }
1651 }
1652
Colin Cross5950f382016-12-13 12:50:57 -08001653 for _, lib := range deps.ReexportHeaderLibHeaders {
1654 if !inList(lib, deps.HeaderLibs) {
1655 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1656 }
1657 }
1658
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001659 for _, gen := range deps.ReexportGeneratedHeaders {
1660 if !inList(gen, deps.GeneratedHeaders) {
1661 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1662 }
1663 }
1664
Colin Crossc99deeb2016-04-11 15:06:20 -07001665 return deps
1666}
1667
Dan Albert7e9d2952016-08-04 13:02:36 -07001668func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001669 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001670 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001671 moduleContextImpl: moduleContextImpl{
1672 mod: c,
1673 },
1674 }
1675 ctx.ctx = ctx
1676
Colin Crossca860ac2016-01-04 14:34:37 -08001677 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001678}
1679
Jiyong Park7ed9de32018-10-15 22:25:07 +09001680// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001681func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001682 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1683 version := name[sharp+1:]
1684 libname := name[:sharp]
1685 return libname, version
1686 }
1687 return name, ""
1688}
1689
Dan Albert92fe7402020-07-15 13:33:30 -07001690func GetCrtVariations(ctx android.BottomUpMutatorContext,
1691 m LinkableInterface) []blueprint.Variation {
1692 if ctx.Os() != android.Android {
1693 return nil
1694 }
1695 if m.UseSdk() {
1696 return []blueprint.Variation{
1697 {Mutator: "sdk", Variation: "sdk"},
Colin Crossbbc941b2020-09-30 12:27:01 -07001698 {Mutator: "version", Variation: m.SdkVersion()},
Dan Albert92fe7402020-07-15 13:33:30 -07001699 }
1700 }
1701 return []blueprint.Variation{
1702 {Mutator: "sdk", Variation: ""},
1703 }
1704}
1705
Colin Crosse7257d22020-09-24 09:56:18 -07001706func (c *Module) addSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext,
1707 variations []blueprint.Variation, depTag libraryDependencyTag, name, version string, far bool) {
1708
1709 variations = append([]blueprint.Variation(nil), variations...)
1710
Colin Cross3146c5c2020-09-30 15:34:40 -07001711 if version != "" && CanBeOrLinkAgainstVersionVariants(c) {
Colin Crosse7257d22020-09-24 09:56:18 -07001712 // Version is explicitly specified. i.e. libFoo#30
1713 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
1714 depTag.explicitlyVersioned = true
1715 }
Colin Crosse7257d22020-09-24 09:56:18 -07001716
Colin Cross0de8a1e2020-09-18 14:15:30 -07001717 if far {
1718 ctx.AddFarVariationDependencies(variations, depTag, name)
1719 } else {
1720 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07001721 }
1722}
1723
Colin Cross1e676be2016-10-12 14:38:15 -07001724func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09001725 if !c.Enabled() {
1726 return
1727 }
1728
Colin Cross37047f12016-12-13 17:06:13 -08001729 ctx := &depsContext{
1730 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07001731 moduleContextImpl: moduleContextImpl{
1732 mod: c,
1733 },
1734 }
1735 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08001736
Colin Crossc99deeb2016-04-11 15:06:20 -07001737 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001738
Yo Chiang219968c2020-09-22 18:45:04 +08001739 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
1740
Dan Albert914449f2016-06-17 16:45:24 -07001741 variantNdkLibs := []string{}
1742 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07001743 if ctx.Os() == android.Android {
Inseob Kimeec88e12020-01-22 11:11:29 +09001744 // rewriteLibs takes a list of names of shared libraries and scans it for three types
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001745 // of names:
Dan Albert914449f2016-06-17 16:45:24 -07001746 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001747 // 1. Name of an NDK library that refers to a prebuilt module.
1748 // For each of these, it adds the name of the prebuilt module (which will be in
1749 // prebuilts/ndk) to the list of nonvariant libs.
1750 // 2. Name of an NDK library that refers to an ndk_library module.
1751 // For each of these, it adds the name of the ndk_library module to the list of
1752 // variant libs.
1753 // 3. Anything else (so anything that isn't an NDK library).
1754 // It adds these to the nonvariantLibs list.
Dan Albert914449f2016-06-17 16:45:24 -07001755 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001756 // The caller can then know to add the variantLibs dependencies differently from the
1757 // nonvariantLibs
Inseob Kim9516ee92019-05-09 10:56:13 +09001758
Inseob Kim9516ee92019-05-09 10:56:13 +09001759 vendorPublicLibraries := vendorPublicLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001760 vendorSnapshotSharedLibs := vendorSnapshotSharedLibs(actx.Config())
1761
1762 rewriteVendorLibs := func(lib string) string {
1763 if isLlndkLibrary(lib, ctx.Config()) {
1764 return lib + llndkLibrarySuffix
1765 }
1766
1767 // only modules with BOARD_VNDK_VERSION uses snapshot.
1768 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1769 return lib
1770 }
1771
1772 if snapshot, ok := vendorSnapshotSharedLibs.get(lib, actx.Arch().ArchType); ok {
1773 return snapshot
1774 }
1775
1776 return lib
1777 }
1778
1779 rewriteLibs := func(list []string) (nonvariantLibs []string, variantLibs []string) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001780 variantLibs = []string{}
1781 nonvariantLibs = []string{}
Dan Albert914449f2016-06-17 16:45:24 -07001782 for _, entry := range list {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001783 // strip #version suffix out
Jiyong Park73c54ee2019-10-22 20:31:18 +09001784 name, _ := StubsLibNameAndVersion(entry)
Colin Cross95f1ca02020-10-29 20:47:22 -07001785 if ctx.useSdk() && inList(name, *getNDKKnownLibs(ctx.Config())) {
Dan Albertde5aade2020-06-30 12:32:51 -07001786 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Inseob Kimeec88e12020-01-22 11:11:29 +09001787 } else if ctx.useVndk() {
1788 nonvariantLibs = append(nonvariantLibs, rewriteVendorLibs(entry))
Inseob Kim9516ee92019-05-09 10:56:13 +09001789 } else if (ctx.Platform() || ctx.ProductSpecific()) && inList(name, *vendorPublicLibraries) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001790 vendorPublicLib := name + vendorPublicLibrarySuffix
Jiyong Park374510b2018-03-19 18:23:01 +09001791 if actx.OtherModuleExists(vendorPublicLib) {
1792 nonvariantLibs = append(nonvariantLibs, vendorPublicLib)
1793 } else {
1794 // This can happen if vendor_public_library module is defined in a
1795 // namespace that isn't visible to the current module. In that case,
1796 // link to the original library.
Jiyong Park7ed9de32018-10-15 22:25:07 +09001797 nonvariantLibs = append(nonvariantLibs, name)
Jiyong Park374510b2018-03-19 18:23:01 +09001798 }
Dan Albert914449f2016-06-17 16:45:24 -07001799 } else {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001800 // put name#version back
Dan Willemsen7cbf5f82017-03-28 00:08:30 -07001801 nonvariantLibs = append(nonvariantLibs, entry)
Dan Willemsen72d39932016-07-08 23:23:48 -07001802 }
1803 }
Dan Albert914449f2016-06-17 16:45:24 -07001804 return nonvariantLibs, variantLibs
Dan Willemsen72d39932016-07-08 23:23:48 -07001805 }
1806
Inseob Kimeec88e12020-01-22 11:11:29 +09001807 deps.SharedLibs, variantNdkLibs = rewriteLibs(deps.SharedLibs)
1808 deps.LateSharedLibs, variantLateNdkLibs = rewriteLibs(deps.LateSharedLibs)
1809 deps.ReexportSharedLibHeaders, _ = rewriteLibs(deps.ReexportSharedLibHeaders)
1810 if ctx.useVndk() {
1811 for idx, lib := range deps.RuntimeLibs {
1812 deps.RuntimeLibs[idx] = rewriteVendorLibs(lib)
1813 }
1814 }
Dan Willemsen72d39932016-07-08 23:23:48 -07001815 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001816
Jiyong Park7e636d02019-01-28 16:16:54 +09001817 buildStubs := false
Colin Crossc88c2722020-09-28 17:32:47 -07001818 if versioned, ok := c.linker.(versionedInterface); ok {
1819 if versioned.buildStubs() {
1820 buildStubs = true
Colin Crossd48fe732020-09-23 20:37:24 -07001821 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001822 }
1823
Inseob Kimeec88e12020-01-22 11:11:29 +09001824 rewriteSnapshotLibs := func(lib string, snapshotMap *snapshotMap) string {
1825 // only modules with BOARD_VNDK_VERSION uses snapshot.
1826 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1827 return lib
1828 }
1829
1830 if snapshot, ok := snapshotMap.get(lib, actx.Arch().ArchType); ok {
1831 return snapshot
1832 }
1833
1834 return lib
1835 }
1836
1837 vendorSnapshotHeaderLibs := vendorSnapshotHeaderLibs(actx.Config())
Colin Cross32ec36c2016-12-15 07:39:51 -08001838 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001839 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08001840 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001841 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08001842 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001843
1844 lib = rewriteSnapshotLibs(lib, vendorSnapshotHeaderLibs)
1845
Jiyong Park7e636d02019-01-28 16:16:54 +09001846 if buildStubs {
Colin Cross7228ecd2019-11-18 16:00:16 -08001847 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001848 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09001849 } else {
1850 actx.AddVariationDependencies(nil, depTag, lib)
1851 }
1852 }
1853
1854 if buildStubs {
1855 // Stubs lib does not have dependency to other static/shared libraries.
1856 // Don't proceed.
1857 return
Colin Cross32ec36c2016-12-15 07:39:51 -08001858 }
Colin Cross5950f382016-12-13 12:50:57 -08001859
Inseob Kim07def122020-11-23 14:43:02 +09001860 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
1861 // C++ implementation library and one Java implementation library. When a module links against
1862 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
1863 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
1864 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09001865 syspropImplLibraries := syspropImplLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001866 vendorSnapshotStaticLibs := vendorSnapshotStaticLibs(actx.Config())
Inseob Kimc0907f12019-02-08 21:00:45 +09001867
Jiyong Park5d1598f2019-02-25 22:14:17 +09001868 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001869 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09001870 if impl, ok := syspropImplLibraries[lib]; ok {
1871 lib = impl
1872 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001873
1874 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1875
Jiyong Park5d1598f2019-02-25 22:14:17 +09001876 actx.AddVariationDependencies([]blueprint.Variation{
1877 {Mutator: "link", Variation: "static"},
1878 }, depTag, lib)
1879 }
1880
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001881 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001882 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001883 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001884 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001885 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001886
1887 if impl, ok := syspropImplLibraries[lib]; ok {
1888 lib = impl
1889 }
1890
Inseob Kimeec88e12020-01-22 11:11:29 +09001891 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1892
Dan Willemsen59339a22018-07-22 21:18:45 -07001893 actx.AddVariationDependencies([]blueprint.Variation{
1894 {Mutator: "link", Variation: "static"},
1895 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001896 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001897
Jooyung Han75568392020-03-20 04:29:24 +09001898 // staticUnwinderDep is treated as staticDep for Q apexes
1899 // so that native libraries/binaries are linked with static unwinder
1900 // because Q libc doesn't have unwinder APIs
1901 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07001902 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001903 actx.AddVariationDependencies([]blueprint.Variation{
1904 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001905 }, depTag, rewriteSnapshotLibs(staticUnwinder(actx), vendorSnapshotStaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001906 }
1907
Inseob Kimeec88e12020-01-22 11:11:29 +09001908 for _, lib := range deps.LateStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001909 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Inseob Kimeec88e12020-01-22 11:11:29 +09001910 actx.AddVariationDependencies([]blueprint.Variation{
1911 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001912 }, depTag, rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs))
Inseob Kimeec88e12020-01-22 11:11:29 +09001913 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001914
Jiyong Park7ed9de32018-10-15 22:25:07 +09001915 // shared lib names without the #version suffix
1916 var sharedLibNames []string
1917
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001918 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001919 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001920 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001921 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001922 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001923
1924 if impl, ok := syspropImplLibraries[lib]; ok {
1925 lib = impl
1926 }
1927
Jiyong Park73c54ee2019-10-22 20:31:18 +09001928 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09001929 sharedLibNames = append(sharedLibNames, name)
1930
Colin Crosse7257d22020-09-24 09:56:18 -07001931 variations := []blueprint.Variation{
1932 {Mutator: "link", Variation: "shared"},
1933 }
1934 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001935 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001936
Jiyong Park7ed9de32018-10-15 22:25:07 +09001937 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09001938 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001939 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
1940 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
1941 // linking against both the stubs lib and the non-stubs lib at the same time.
1942 continue
1943 }
Colin Cross6e511a92020-07-27 21:26:48 -07001944 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07001945 variations := []blueprint.Variation{
1946 {Mutator: "link", Variation: "shared"},
1947 }
1948 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001949 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001950
Dan Willemsen59339a22018-07-22 21:18:45 -07001951 actx.AddVariationDependencies([]blueprint.Variation{
1952 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04001953 }, dataLibDepTag, deps.DataLibs...)
1954
1955 actx.AddVariationDependencies([]blueprint.Variation{
1956 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07001957 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08001958
Colin Cross68861832016-07-08 10:41:41 -07001959 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001960
1961 for _, gen := range deps.GeneratedHeaders {
1962 depTag := genHeaderDepTag
1963 if inList(gen, deps.ReexportGeneratedHeaders) {
1964 depTag = genHeaderExportDepTag
1965 }
1966 actx.AddDependency(c, depTag, gen)
1967 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07001968
Inseob Kim1042d292020-06-01 23:23:05 +09001969 vendorSnapshotObjects := vendorSnapshotObjects(actx.Config())
1970
Dan Albert92fe7402020-07-15 13:33:30 -07001971 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07001972 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc99deeb2016-04-11 15:06:20 -07001973 if deps.CrtBegin != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07001974 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
1975 rewriteSnapshotLibs(deps.CrtBegin, vendorSnapshotObjects))
Colin Crossca860ac2016-01-04 14:34:37 -08001976 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001977 if deps.CrtEnd != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07001978 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
1979 rewriteSnapshotLibs(deps.CrtEnd, vendorSnapshotObjects))
Colin Cross21b9a242015-03-24 14:15:58 -07001980 }
Dan Willemsena0790e32018-10-12 00:24:23 -07001981 if deps.LinkerFlagsFile != "" {
1982 actx.AddDependency(c, linkerFlagsDepTag, deps.LinkerFlagsFile)
1983 }
1984 if deps.DynamicLinker != "" {
1985 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07001986 }
Dan Albert914449f2016-06-17 16:45:24 -07001987
1988 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07001989
1990 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07001991 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07001992 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07001993 {Mutator: "link", Variation: "shared"},
1994 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07001995
1996 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07001997 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07001998 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07001999 {Mutator: "link", Variation: "shared"},
2000 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002001
2002 if vndkdep := c.vndkdep; vndkdep != nil {
2003 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002004 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002005 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002006 {Mutator: "link", Variation: "shared"},
2007 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002008 }
2009 }
Colin Cross6362e272015-10-29 15:25:03 -07002010}
Colin Cross21b9a242015-03-24 14:15:58 -07002011
Colin Crosse40b4ea2018-10-02 22:25:58 -07002012func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002013 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2014 c.beginMutator(ctx)
2015 }
2016}
2017
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002018// Whether a module can link to another module, taking into
2019// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002020func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002021 tag blueprint.DependencyTag) {
2022
2023 switch t := tag.(type) {
2024 case dependencyTag:
2025 if t != vndkExtDepTag {
2026 return
2027 }
2028 case libraryDependencyTag:
2029 default:
2030 return
2031 }
2032
Ivan Lozano52767be2019-10-18 14:49:46 -07002033 if from.Module().Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002034 // Host code is not restricted
2035 return
2036 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002037
2038 // VNDK is cc.Module supported only for now.
2039 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002040 // Though allowed dependency is limited by the image mutator,
2041 // each vendor and product module needs to check link-type
2042 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002043 if ccTo, ok := to.(*Module); ok {
2044 if ccFrom.vndkdep != nil {
2045 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2046 }
2047 } else {
2048 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002049 }
2050 return
2051 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002052 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002053 // Platform code can link to anything
2054 return
2055 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002056 if from.InRamdisk() {
2057 // Ramdisk code is not NDK
2058 return
2059 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002060 if from.InVendorRamdisk() {
2061 // Vendor ramdisk code is not NDK
2062 return
2063 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002064 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002065 // Recovery code is not NDK
2066 return
2067 }
Colin Cross31076b32020-10-23 17:22:06 -07002068 if c, ok := to.(*Module); ok {
2069 if c.ToolchainLibrary() {
2070 // These are always allowed
2071 return
2072 }
2073 if c.NdkPrebuiltStl() {
2074 // These are allowed, but they don't set sdk_version
2075 return
2076 }
2077 if c.StubDecorator() {
2078 // These aren't real libraries, but are the stub shared libraries that are included in
2079 // the NDK.
2080 return
2081 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002082 }
Logan Chien834b9a62019-01-14 15:39:03 +08002083
Ivan Lozano52767be2019-10-18 14:49:46 -07002084 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002085 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2086 // to link to libc++ (non-NDK and without sdk_version).
2087 return
2088 }
2089
Ivan Lozano52767be2019-10-18 14:49:46 -07002090 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002091 // NDK code linking to platform code is never okay.
2092 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002093 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002094 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002095 }
2096
2097 // At this point we know we have two NDK libraries, but we need to
2098 // check that we're not linking against anything built against a higher
2099 // API level, as it is only valid to link against older or equivalent
2100 // APIs.
2101
Inseob Kim01a28722018-04-11 09:48:45 +09002102 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002103 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002104 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002105 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002106 // Current can't be linked against by anything else.
2107 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002108 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002109 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002110 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002111 if err != nil {
2112 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002113 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002114 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002115 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002116 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002117 if err != nil {
2118 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002119 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002120 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002121 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002122
Inseob Kim01a28722018-04-11 09:48:45 +09002123 if toApi > fromApi {
2124 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002125 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002126 }
2127 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002128 }
Dan Albert202fe492017-12-15 13:56:59 -08002129
2130 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002131 fromStl := from.SelectedStl()
2132 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002133 if fromStl == "" || toStl == "" {
2134 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002135 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002136 // We can be permissive with the system "STL" since it is only the C++
2137 // ABI layer, but in the future we should make sure that everyone is
2138 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002139 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002140 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002141 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2142 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002143 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002144}
2145
Jooyung Han479ca172020-10-19 18:51:07 +09002146func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2147 if c, ok := ctx.Module().(*Module); ok {
2148 ctx.VisitDirectDeps(func(dep android.Module) {
2149 depTag := ctx.OtherModuleDependencyTag(dep)
2150 ccDep, ok := dep.(LinkableInterface)
2151 if ok {
2152 checkLinkType(ctx, c, ccDep, depTag)
2153 }
2154 })
2155 }
2156}
2157
Jiyong Park5fb8c102018-04-09 12:03:06 +09002158// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002159// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2160// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002161// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002162func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2163 check := func(child, parent android.Module) bool {
2164 to, ok := child.(*Module)
2165 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002166 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002167 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002168
Jooyung Hana70f0672019-01-18 15:20:43 +09002169 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2170 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002171 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002172
Justin Yun63e9ec72020-10-29 16:49:43 +09002173 // Even if target lib has no vendor variant, keep checking dependency
2174 // graph in case it depends on vendor_available or product_available
2175 // but not double_loadable transtively.
2176 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002177 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002178 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002179
Jooyung Han0302a842019-10-30 18:43:49 +09002180 if to.isVndkSp() || to.isLlndk(ctx.Config()) || Bool(to.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002181 return false
2182 }
2183
2184 var stringPath []string
2185 for _, m := range ctx.GetWalkPath() {
2186 stringPath = append(stringPath, m.Name())
2187 }
2188 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2189 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
2190 "(dependency: %s)", ctx.OtherModuleName(to), strings.Join(stringPath, " -> "))
2191 return false
2192 }
2193 if module, ok := ctx.Module().(*Module); ok {
2194 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jooyung Han0302a842019-10-30 18:43:49 +09002195 if module.isLlndk(ctx.Config()) || Bool(module.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002196 ctx.WalkDeps(check)
2197 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002198 }
2199 }
2200}
2201
Colin Cross0de8a1e2020-09-18 14:15:30 -07002202// Returns the highest version which is <= maxSdkVersion.
2203// For example, with maxSdkVersion is 10 and versionList is [9,11]
2204// it returns 9 as string. The list of stubs must be in order from
2205// oldest to newest.
2206func (c *Module) chooseSdkVersion(ctx android.PathContext, stubsInfo []SharedLibraryStubsInfo,
2207 maxSdkVersion android.ApiLevel) (SharedLibraryStubsInfo, error) {
2208
2209 for i := range stubsInfo {
2210 stubInfo := stubsInfo[len(stubsInfo)-i-1]
2211 var ver android.ApiLevel
2212 if stubInfo.Version == "" {
2213 ver = android.FutureApiLevel
2214 } else {
2215 var err error
2216 ver, err = android.ApiLevelFromUser(ctx, stubInfo.Version)
2217 if err != nil {
2218 return SharedLibraryStubsInfo{}, err
2219 }
2220 }
2221 if ver.LessThanOrEqualTo(maxSdkVersion) {
2222 return stubInfo, nil
2223 }
2224 }
2225 var versionList []string
2226 for _, stubInfo := range stubsInfo {
2227 versionList = append(versionList, stubInfo.Version)
2228 }
2229 return SharedLibraryStubsInfo{}, fmt.Errorf("not found a version(<=%s) in versionList: %v", maxSdkVersion.String(), versionList)
2230}
2231
Colin Crossc99deeb2016-04-11 15:06:20 -07002232// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002233func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002234 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002235
Colin Cross0de8a1e2020-09-18 14:15:30 -07002236 var directStaticDeps []StaticLibraryInfo
2237 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002238
Colin Cross0de8a1e2020-09-18 14:15:30 -07002239 reexportExporter := func(exporter FlagExporterInfo) {
2240 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2241 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2242 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2243 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2244 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002245 }
2246
Jooyung Hande34d232020-07-23 13:04:15 +09002247 // For the dependency from platform to apex, use the latest stubs
2248 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002249 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2250 if !apexInfo.IsForPlatform() {
2251 c.apexSdkVersion = apexInfo.MinSdkVersion(ctx)
Jooyung Hande34d232020-07-23 13:04:15 +09002252 }
2253
2254 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2255 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2256 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2257 // (b/144430859)
2258 c.apexSdkVersion = android.FutureApiLevel
2259 }
2260
Colin Crossd11fcda2017-10-23 17:59:01 -07002261 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002262 depName := ctx.OtherModuleName(dep)
2263 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002264
Ivan Lozano52767be2019-10-18 14:49:46 -07002265 ccDep, ok := dep.(LinkableInterface)
2266 if !ok {
2267
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002268 // handling for a few module types that aren't cc Module but that are also supported
2269 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002270 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002271 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002272 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2273 genRule.GeneratedSourceFiles()...)
2274 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002275 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002276 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002277 // Support exported headers from a generated_sources dependency
2278 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002279 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002280 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002281 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002282 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002283 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002284 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002285 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002286 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002287 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2288 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002289 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002290 // 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 +09002291 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002292
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002293 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002294 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002295 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002296 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002297 case linkerFlagsDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002298 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002299 files := genRule.GeneratedSourceFiles()
2300 if len(files) == 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002301 depPaths.LinkerFlagsFile = android.OptionalPathForPath(files[0])
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002302 } else if len(files) > 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002303 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 -07002304 }
2305 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002306 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002307 }
Colin Crossca860ac2016-01-04 14:34:37 -08002308 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002309 return
2310 }
2311
Colin Crossfe17f6f2019-03-28 19:30:56 -07002312 if depTag == android.ProtoPluginDepTag {
2313 return
2314 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002315 if depTag == llndkImplDep {
2316 return
2317 }
Colin Crossfe17f6f2019-03-28 19:30:56 -07002318
Colin Crossd11fcda2017-10-23 17:59:01 -07002319 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002320 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2321 return
2322 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002323 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002324 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2325 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002326 return
2327 }
2328
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002329 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002330 // Skip reused objects for stub libraries, they use their own stub object file instead.
2331 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2332 // version mutator, so the stubs variant is created from the shared variant that
2333 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002334 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002335 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2336 objs := staticAnalogue.ReuseObjects
2337 depPaths.Objs = depPaths.Objs.Append(objs)
2338 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2339 reexportExporter(depExporterInfo)
2340 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002341 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002342 }
2343
Colin Cross6e511a92020-07-27 21:26:48 -07002344 linkFile := ccDep.OutputFile()
2345
2346 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2347 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002348 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002349 return
2350 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002351
Colin Cross0de8a1e2020-09-18 14:15:30 -07002352 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002353
Colin Cross6e511a92020-07-27 21:26:48 -07002354 var ptr *android.Paths
2355 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002356
Colin Cross6e511a92020-07-27 21:26:48 -07002357 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002358
Colin Cross6e511a92020-07-27 21:26:48 -07002359 switch {
2360 case libDepTag.header():
2361 // nothing
2362 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002363 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2364 if !ctx.Config().AllowMissingDependencies() {
2365 ctx.ModuleErrorf("module %q is not a shared library", depName)
2366 } else {
2367 ctx.AddMissingDependencies([]string{depName})
2368 }
2369 return
2370 }
2371 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2372 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryImplementationStubsInfoProvider).(SharedLibraryImplementationStubsInfo)
2373
2374 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedLibraryStubsInfos) > 0 {
2375 useStubs := false
Colin Cross31076b32020-10-23 17:22:06 -07002376
2377 if lib := moduleLibraryInterface(dep); lib.buildStubs() && c.UseVndk() { // LLNDK
Colin Cross0de8a1e2020-09-18 14:15:30 -07002378 if !apexInfo.IsForPlatform() {
2379 // For platform libraries, use current version of LLNDK
2380 // If this is for use_vendor apex we will apply the same rules
2381 // of apex sdk enforcement below to choose right version.
2382 useStubs = true
2383 }
2384 } else if apexInfo.IsForPlatform() {
2385 // If not building for APEX, use stubs only when it is from
2386 // an APEX (and not from platform)
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002387 // However, for host, ramdisk, vendor_ramdisk, recovery or bootstrap modules,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002388 // always link to non-stub variant
2389 useStubs = dep.(android.ApexModule).AnyVariantDirectlyInAnyApex() && !c.bootstrap()
2390 // Another exception: if this module is bundled with an APEX, then
2391 // it is linked with the non-stub variant of a module in the APEX
2392 // as if this is part of the APEX.
2393 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2394 for _, apexContents := range testFor.ApexContents {
2395 if apexContents.DirectlyInApex(depName) {
2396 useStubs = false
2397 break
2398 }
2399 }
2400 } else {
2401 // If building for APEX, use stubs when the parent is in any APEX that
2402 // the child is not in.
2403 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2404 }
2405
2406 // when to use (unspecified) stubs, check min_sdk_version and choose the right one
2407 if useStubs {
2408 sharedLibraryStubsInfo, err :=
2409 c.chooseSdkVersion(ctx, sharedLibraryStubsInfo.SharedLibraryStubsInfos, c.apexSdkVersion)
2410 if err != nil {
2411 ctx.OtherModuleErrorf(dep, err.Error())
2412 return
2413 }
2414 sharedLibraryInfo = sharedLibraryStubsInfo.SharedLibraryInfo
2415 depExporterInfo = sharedLibraryStubsInfo.FlagExporterInfo
2416 }
2417 }
2418
2419 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2420 depFile = sharedLibraryInfo.TableOfContents
2421
Colin Cross6e511a92020-07-27 21:26:48 -07002422 ptr = &depPaths.SharedLibs
2423 switch libDepTag.Order {
2424 case earlyLibraryDependency:
2425 ptr = &depPaths.EarlySharedLibs
2426 depPtr = &depPaths.EarlySharedLibsDeps
2427 case normalLibraryDependency:
2428 ptr = &depPaths.SharedLibs
2429 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002430 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002431 case lateLibraryDependency:
2432 ptr = &depPaths.LateSharedLibs
2433 depPtr = &depPaths.LateSharedLibsDeps
2434 default:
2435 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002436 }
Colin Cross6e511a92020-07-27 21:26:48 -07002437 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002438 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2439 if !ctx.Config().AllowMissingDependencies() {
2440 ctx.ModuleErrorf("module %q is not a static library", depName)
2441 } else {
2442 ctx.AddMissingDependencies([]string{depName})
2443 }
2444 return
2445 }
2446 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2447 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002448 if libDepTag.wholeStatic {
2449 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002450 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2451 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002452 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002453 // This case normally catches prebuilt static
2454 // libraries, but it can also occur when
2455 // AllowMissingDependencies is on and the
2456 // dependencies has no sources of its own
2457 // but has a whole_static_libs dependency
2458 // on a missing library. We want to depend
2459 // on the .a file so that there is something
2460 // in the dependency tree that contains the
2461 // error rule for the missing transitive
2462 // dependency.
2463 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002464 }
Colin Cross6e511a92020-07-27 21:26:48 -07002465 } else {
2466 switch libDepTag.Order {
2467 case earlyLibraryDependency:
2468 panic(fmt.Errorf("early static libs not suppported"))
2469 case normalLibraryDependency:
2470 // static dependencies will be handled separately so they can be ordered
2471 // using transitive dependencies.
2472 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002473 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002474 case lateLibraryDependency:
2475 ptr = &depPaths.LateStaticLibs
2476 default:
2477 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002478 }
2479 }
2480 }
2481
Colin Cross6e511a92020-07-27 21:26:48 -07002482 if libDepTag.static() && !libDepTag.wholeStatic {
2483 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2484 ctx.ModuleErrorf("module %q not a static library", depName)
2485 return
2486 }
Logan Chien43d34c32017-12-20 01:17:32 +08002487
Colin Cross6e511a92020-07-27 21:26:48 -07002488 // When combining coverage files for shared libraries and executables, coverage files
2489 // in static libraries act as if they were whole static libraries. The same goes for
2490 // source based Abi dump files.
2491 if c, ok := ccDep.(*Module); ok {
2492 staticLib := c.linker.(libraryInterface)
2493 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2494 staticLib.objs().coverageFiles...)
2495 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2496 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002497 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002498 // Handle non-CC modules here
2499 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002500 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002501 }
2502 }
2503
Colin Cross6e511a92020-07-27 21:26:48 -07002504 if ptr != nil {
2505 if !linkFile.Valid() {
2506 if !ctx.Config().AllowMissingDependencies() {
2507 ctx.ModuleErrorf("module %q missing output file", depName)
2508 } else {
2509 ctx.AddMissingDependencies([]string{depName})
2510 }
2511 return
2512 }
2513 *ptr = append(*ptr, linkFile.Path())
2514 }
2515
2516 if depPtr != nil {
2517 dep := depFile
2518 if !dep.Valid() {
2519 dep = linkFile
2520 }
2521 *depPtr = append(*depPtr, dep.Path())
2522 }
2523
Colin Cross0de8a1e2020-09-18 14:15:30 -07002524 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2525 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2526 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2527 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2528
2529 if libDepTag.reexportFlags {
2530 reexportExporter(depExporterInfo)
2531 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2532 // Re-exported shared library headers must be included as well since they can help us with type information
2533 // about template instantiations (instantiated from their headers).
2534 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2535 // scripts.
2536 c.sabi.Properties.ReexportedIncludes = append(
2537 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2538 }
2539
Colin Cross6e511a92020-07-27 21:26:48 -07002540 makeLibName := c.makeLibName(ctx, ccDep, depName) + libDepTag.makeSuffix
2541 switch {
2542 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002543 c.Properties.AndroidMkHeaderLibs = append(
2544 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002545 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002546 if lib := moduleLibraryInterface(dep); lib != nil {
2547 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002548 // Add the dependency to the APEX(es) providing the library so that
2549 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002550 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
2551 for _, an := range depApexInfo.InApexes {
Colin Cross6e511a92020-07-27 21:26:48 -07002552 c.Properties.ApexesProvidingSharedLibs = append(
2553 c.Properties.ApexesProvidingSharedLibs, an)
2554 }
2555 }
2556 }
2557
2558 // Note: the order of libs in this list is not important because
2559 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002560 c.Properties.AndroidMkSharedLibs = append(
2561 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002562 // Record baseLibName for snapshots.
2563 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, baseLibName(depName))
2564 case libDepTag.static():
2565 if libDepTag.wholeStatic {
2566 c.Properties.AndroidMkWholeStaticLibs = append(
2567 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2568 } else {
2569 c.Properties.AndroidMkStaticLibs = append(
2570 c.Properties.AndroidMkStaticLibs, makeLibName)
2571 }
2572 }
2573 } else {
2574 switch depTag {
2575 case runtimeDepTag:
2576 c.Properties.AndroidMkRuntimeLibs = append(
2577 c.Properties.AndroidMkRuntimeLibs, c.makeLibName(ctx, ccDep, depName)+libDepTag.makeSuffix)
2578 // Record baseLibName for snapshots.
2579 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, baseLibName(depName))
2580 case objDepTag:
2581 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2582 case CrtBeginDepTag:
2583 depPaths.CrtBegin = linkFile
2584 case CrtEndDepTag:
2585 depPaths.CrtEnd = linkFile
2586 case dynamicLinkerDepTag:
2587 depPaths.DynamicLinker = linkFile
2588 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002589 }
Colin Crossca860ac2016-01-04 14:34:37 -08002590 })
2591
Jeff Gaston294356f2017-09-27 17:05:30 -07002592 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002593 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2594 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2595 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002596
Colin Crossdd84e052017-05-17 13:44:16 -07002597 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002598 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002599 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2600 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002601 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002602 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2603 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002604 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002605 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002606 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002607
2608 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002609 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002610 }
Colin Crossdd84e052017-05-17 13:44:16 -07002611
Colin Crossca860ac2016-01-04 14:34:37 -08002612 return depPaths
2613}
2614
Colin Cross0de8a1e2020-09-18 14:15:30 -07002615// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2616// to match the topological order of the dependency tree, including any static analogues of
2617// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2618// of the transitive dependencies.
2619func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2620 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2621 var staticPaths android.Paths
2622 for _, staticDep := range staticDeps {
2623 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2624 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2625 }
2626 for _, sharedDep := range sharedDeps {
2627 if sharedDep.StaticAnalogue != nil {
2628 transitiveStaticLibsBuilder.Transitive(sharedDep.StaticAnalogue.TransitiveStaticLibrariesForOrdering)
2629 }
2630 }
2631 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2632
2633 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2634
2635 // reorder the dependencies based on transitive dependencies
2636 staticPaths = android.FirstUniquePaths(staticPaths)
2637 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2638
2639 if len(orderedStaticPaths) != len(staticPaths) {
2640 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2641 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2642 }
2643
2644 return orderedStaticPaths, transitiveStaticLibs
2645}
2646
Colin Cross6e511a92020-07-27 21:26:48 -07002647// baseLibName trims known prefixes and suffixes
2648func baseLibName(depName string) string {
2649 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
2650 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
2651 libName = strings.TrimPrefix(libName, "prebuilt_")
2652 return libName
2653}
2654
2655func (c *Module) makeLibName(ctx android.ModuleContext, ccDep LinkableInterface, depName string) string {
2656 vendorSuffixModules := vendorSuffixModules(ctx.Config())
2657 vendorPublicLibraries := vendorPublicLibraries(ctx.Config())
2658
2659 libName := baseLibName(depName)
2660 isLLndk := isLlndkLibrary(libName, ctx.Config())
2661 isVendorPublicLib := inList(libName, *vendorPublicLibraries)
2662 bothVendorAndCoreVariantsExist := ccDep.HasVendorVariant() || isLLndk
2663
2664 if c, ok := ccDep.(*Module); ok {
2665 // Use base module name for snapshots when exporting to Makefile.
2666 if c.isSnapshotPrebuilt() {
2667 baseName := c.BaseModuleName()
2668
2669 if c.IsVndk() {
2670 return baseName + ".vendor"
2671 }
2672
2673 if vendorSuffixModules[baseName] {
2674 return baseName + ".vendor"
2675 } else {
2676 return baseName
2677 }
2678 }
2679 }
2680
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002681 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
2682 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07002683 // The vendor module is a no-vendor-variant VNDK library. Depend on the
2684 // core module instead.
2685 return libName
2686 } else if c.UseVndk() && bothVendorAndCoreVariantsExist {
2687 // The vendor module in Make will have been renamed to not conflict with the core
2688 // module, so update the dependency name here accordingly.
2689 return libName + c.getNameSuffixWithVndkVersion(ctx)
2690 } else if (ctx.Platform() || ctx.ProductSpecific()) && isVendorPublicLib {
2691 return libName + vendorPublicLibrarySuffix
2692 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
2693 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002694 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
2695 return libName + vendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002696 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
2697 return libName + recoverySuffix
2698 } else if ccDep.Module().Target().NativeBridge == android.NativeBridgeEnabled {
2699 return libName + nativeBridgeSuffix
2700 } else {
2701 return libName
2702 }
2703}
2704
Colin Crossca860ac2016-01-04 14:34:37 -08002705func (c *Module) InstallInData() bool {
2706 if c.installer == nil {
2707 return false
2708 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002709 return c.installer.inData()
2710}
2711
2712func (c *Module) InstallInSanitizerDir() bool {
2713 if c.installer == nil {
2714 return false
2715 }
2716 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07002717 return true
2718 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002719 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08002720}
2721
Yifan Hong1b3348d2020-01-21 15:53:22 -08002722func (c *Module) InstallInRamdisk() bool {
2723 return c.InRamdisk()
2724}
2725
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002726func (c *Module) InstallInVendorRamdisk() bool {
2727 return c.InVendorRamdisk()
2728}
2729
Jiyong Parkf9332f12018-02-01 00:54:12 +09002730func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07002731 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09002732}
2733
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002734func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002735 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002736 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002737 return
2738 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002739 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002740}
2741
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07002742func (c *Module) HostToolPath() android.OptionalPath {
2743 if c.installer == nil {
2744 return android.OptionalPath{}
2745 }
2746 return c.installer.hostToolPath()
2747}
2748
Nan Zhangd4e641b2017-07-12 12:55:28 -07002749func (c *Module) IntermPathForModuleOut() android.OptionalPath {
2750 return c.outputFile
2751}
2752
Colin Cross41955e82019-05-29 14:40:35 -07002753func (c *Module) OutputFiles(tag string) (android.Paths, error) {
2754 switch tag {
2755 case "":
2756 if c.outputFile.Valid() {
2757 return android.Paths{c.outputFile.Path()}, nil
2758 }
2759 return android.Paths{}, nil
2760 default:
2761 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002762 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002763}
2764
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00002765func (c *Module) static() bool {
2766 if static, ok := c.linker.(interface {
2767 static() bool
2768 }); ok {
2769 return static.static()
2770 }
2771 return false
2772}
2773
Jiyong Park379de2f2018-12-19 02:47:14 +09002774func (c *Module) staticBinary() bool {
2775 if static, ok := c.linker.(interface {
2776 staticBinary() bool
2777 }); ok {
2778 return static.staticBinary()
2779 }
2780 return false
2781}
2782
Jiyong Park1d1119f2019-07-29 21:27:18 +09002783func (c *Module) header() bool {
2784 if h, ok := c.linker.(interface {
2785 header() bool
2786 }); ok {
2787 return h.header()
2788 }
2789 return false
2790}
2791
Inseob Kim7f283f42020-06-01 21:53:49 +09002792func (c *Module) binary() bool {
2793 if b, ok := c.linker.(interface {
2794 binary() bool
2795 }); ok {
2796 return b.binary()
2797 }
2798 return false
2799}
2800
Inseob Kim1042d292020-06-01 23:23:05 +09002801func (c *Module) object() bool {
2802 if o, ok := c.linker.(interface {
2803 object() bool
2804 }); ok {
2805 return o.object()
2806 }
2807 return false
2808}
2809
Jooyung Han38002912019-05-16 04:01:54 +09002810func (c *Module) getMakeLinkType(actx android.ModuleContext) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07002811 if c.UseVndk() {
Jooyung Han38002912019-05-16 04:01:54 +09002812 if lib, ok := c.linker.(*llndkStubDecorator); ok {
2813 if Bool(lib.Properties.Vendor_available) {
Colin Crossb60190a2018-09-04 16:28:17 -07002814 return "native:vndk"
2815 }
Jooyung Han38002912019-05-16 04:01:54 +09002816 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07002817 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002818 if c.IsVndk() && !c.isVndkExt() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002819 // Product_available, if defined, must have the same value with Vendor_available.
Jooyung Han38002912019-05-16 04:01:54 +09002820 if Bool(c.VendorProperties.Vendor_available) {
2821 return "native:vndk"
2822 }
2823 return "native:vndk_private"
2824 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09002825 if c.inProduct() {
2826 return "native:product"
2827 }
Jooyung Han38002912019-05-16 04:01:54 +09002828 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08002829 } else if c.InRamdisk() {
2830 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002831 } else if c.InVendorRamdisk() {
2832 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07002833 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07002834 return "native:recovery"
2835 } else if c.Target().Os == android.Android && String(c.Properties.Sdk_version) != "" {
2836 return "native:ndk:none:none"
2837 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
2838 //family, link := getNdkStlFamilyAndLinkType(c)
2839 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07002840 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08002841 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07002842 } else {
2843 return "native:platform"
2844 }
2845}
2846
Jiyong Park9d452992018-10-03 00:38:19 +09002847// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01002848// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09002849func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07002850 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09002851 // Stub libs and prebuilt libs in a versioned SDK are not
2852 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07002853 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01002854 } else if _, ok := c.linker.(testPerSrc); ok {
2855 return true
Jiyong Park9d452992018-10-03 00:38:19 +09002856 }
2857 return false
2858}
2859
Jiyong Parka90ca002019-10-07 15:47:24 +09002860func (c *Module) AvailableFor(what string) bool {
2861 if linker, ok := c.linker.(interface {
2862 availableFor(string) bool
2863 }); ok {
2864 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
2865 } else {
2866 return c.ApexModuleBase.AvailableFor(what)
2867 }
2868}
2869
Jiyong Park62304bb2020-04-13 16:19:48 +09002870func (c *Module) TestFor() []string {
2871 if test, ok := c.linker.(interface {
2872 testFor() []string
2873 }); ok {
2874 return test.testFor()
2875 } else {
2876 return c.ApexModuleBase.TestFor()
2877 }
2878}
2879
Colin Crossaede88c2020-08-11 12:17:01 -07002880func (c *Module) UniqueApexVariations() bool {
2881 if u, ok := c.compiler.(interface {
2882 uniqueApexVariations() bool
2883 }); ok {
2884 return u.uniqueApexVariations()
2885 } else {
2886 return false
2887 }
2888}
2889
Paul Duffin0cb37b92020-03-04 14:52:46 +00002890// Return true if the module is ever installable.
2891func (c *Module) EverInstallable() bool {
2892 return c.installer != nil &&
2893 // Check to see whether the module is actually ever installable.
2894 c.installer.everInstallable()
2895}
2896
Colin Cross56a83212020-09-15 18:30:11 -07002897func (c *Module) installable(apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00002898 ret := c.EverInstallable() &&
2899 // Check to see whether the module has been configured to not be installed.
2900 proptools.BoolDefault(c.Properties.Installable, true) &&
2901 !c.Properties.PreventInstall && c.outputFile.Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002902
2903 // The platform variant doesn't need further condition. Apex variants however might not
2904 // be installable because it will likely to be included in the APEX and won't appear
2905 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07002906 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002907 return ret
2908 }
2909
2910 // Special case for modules that are configured to be installed to /data, which includes
2911 // test modules. For these modules, both APEX and non-APEX variants are considered as
2912 // installable. This is because even the APEX variants won't be included in the APEX, but
2913 // will anyway be installed to /data/*.
2914 // See b/146995717
2915 if c.InstallInData() {
2916 return ret
2917 }
2918
2919 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09002920}
2921
Logan Chien41eabe62019-04-10 13:33:58 +08002922func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
2923 if c.linker != nil {
2924 if library, ok := c.linker.(*libraryDecorator); ok {
2925 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
2926 }
2927 }
2928}
2929
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002930func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07002931 depTag := ctx.OtherModuleDependencyTag(dep)
2932 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
2933
2934 if cc, ok := dep.(*Module); ok {
2935 if cc.HasStubsVariants() {
2936 if isLibDepTag && libDepTag.shared() {
2937 // dynamic dep to a stubs lib crosses APEX boundary
2938 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002939 }
Colin Cross6e511a92020-07-27 21:26:48 -07002940 if IsRuntimeDepTag(depTag) {
2941 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002942 return false
2943 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002944 }
Colin Crossaac32222020-07-29 12:51:56 -07002945 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07002946 // shared_lib dependency from a static lib is considered as crossing
2947 // the APEX boundary because the dependency doesn't actually is
2948 // linked; the dependency is used only during the compilation phase.
2949 return false
2950 }
2951 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002952 if depTag == stubImplDepTag || depTag == llndkImplDep {
2953 // We don't track beyond LLNDK or from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09002954 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002955 }
2956 return true
2957}
2958
Dan Albertc8060532020-07-22 22:32:17 -07002959func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2960 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09002961 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
2962 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
2963 return nil
2964 }
2965 // b/154569636: set min_sdk_version correctly for toolchain_libraries
2966 if c.ToolchainLibrary() {
2967 return nil
2968 }
2969 // We don't check for prebuilt modules
2970 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
2971 return nil
2972 }
2973 minSdkVersion := c.MinSdkVersion()
2974 if minSdkVersion == "apex_inherit" {
2975 return nil
2976 }
2977 if minSdkVersion == "" {
2978 // JNI libs within APK-in-APEX fall into here
2979 // Those are okay to set sdk_version instead
2980 // We don't have to check if this is a SDK variant because
2981 // non-SDK variant resets sdk_version, which works too.
2982 minSdkVersion = c.SdkVersion()
2983 }
Dan Albertc8060532020-07-22 22:32:17 -07002984 if minSdkVersion == "" {
2985 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
2986 }
2987 // Not using nativeApiLevelFromUser because the context here is not
2988 // necessarily a native context.
2989 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09002990 if err != nil {
2991 return err
2992 }
Dan Albertc8060532020-07-22 22:32:17 -07002993
2994 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09002995 return fmt.Errorf("newer SDK(%v)", ver)
2996 }
2997 return nil
2998}
2999
Colin Cross2ba19d92015-05-07 15:44:20 -07003000//
Colin Crosscfad1192015-11-02 16:43:11 -08003001// Defaults
3002//
Colin Crossca860ac2016-01-04 14:34:37 -08003003type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003004 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003005 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003006 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003007}
3008
Patrice Arrudac249c712019-03-19 17:00:29 -07003009// cc_defaults provides a set of properties that can be inherited by other cc
3010// modules. A module can use the properties from a cc_defaults using
3011// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3012// merged (when possible) by prepending the default module's values to the
3013// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003014func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003015 return DefaultsFactory()
3016}
3017
Colin Cross36242852017-06-23 15:06:31 -07003018func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003019 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003020
Colin Cross36242852017-06-23 15:06:31 -07003021 module.AddProperties(props...)
3022 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003023 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003024 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003025 &BaseCompilerProperties{},
3026 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003027 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003028 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003029 &StaticProperties{},
3030 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003031 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003032 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003033 &TestProperties{},
3034 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003035 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003036 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003037 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003038 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003039 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003040 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003041 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003042 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003043 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003044 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003045 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003046 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003047 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003048 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3049 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003050 )
Colin Crosscfad1192015-11-02 16:43:11 -08003051
Jooyung Hancc372c52019-09-25 15:18:44 +09003052 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003053
3054 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003055}
3056
Jiyong Park2286afd2020-06-16 21:58:53 +09003057func (c *Module) IsSdkVariant() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07003058 return c.Properties.IsSdkVariant || c.AlwaysSdk()
Jiyong Park2286afd2020-06-16 21:58:53 +09003059}
3060
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003061func kytheExtractAllFactory() android.Singleton {
3062 return &kytheExtractAllSingleton{}
3063}
3064
3065type kytheExtractAllSingleton struct {
3066}
3067
3068func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3069 var xrefTargets android.Paths
3070 ctx.VisitAllModules(func(module android.Module) {
3071 if ccModule, ok := module.(xref); ok {
3072 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3073 }
3074 })
3075 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3076 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003077 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003078 }
3079}
3080
Colin Cross06a931b2015-10-28 17:23:31 -07003081var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003082var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003083var BoolPtr = proptools.BoolPtr
3084var String = proptools.String
3085var StringPtr = proptools.StringPtr