blob: 5e4faf268347ea67df323d136e52a314672b1d87 [file] [log] [blame]
Colin Cross5049f022015-03-18 13:28:46 -07001// Copyright 2015 Google Inc. All rights reserved.
Colin Cross3f40fa42015-01-30 17:27:36 -08002//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17// This file contains the module types for compiling C/C++ for Android, and converts the properties
18// into the flags and filenames necessary to pass to the compiler. The final creation of the rules
19// is handled in builder.go
20
21import (
Colin Cross41955e82019-05-29 14:40:35 -070022 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080023 "io"
Dan Albert9e10cd42016-08-03 14:12:14 -070024 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "strings"
26
Colin Cross97ba0732015-03-23 17:50:24 -070027 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070028 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070029
Colin Cross635c3b02016-05-18 15:37:25 -070030 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070031 "android/soong/cc/config"
Colin Cross5049f022015-03-18 13:28:46 -070032 "android/soong/genrule"
Colin Cross3f40fa42015-01-30 17:27:36 -080033)
34
Colin Cross463a90e2015-06-17 14:20:06 -070035func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000036 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070037
Paul Duffin036e7002019-12-19 19:16:28 +000038 pctx.Import("android/soong/cc/config")
39}
40
41func RegisterCCBuildComponents(ctx android.RegistrationContext) {
42 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
43
44 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000045 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090046 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070047 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010048 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070049 ctx.BottomUp("version_selector", versionSelectorMutator).Parallel()
50 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070051 ctx.BottomUp("begin", BeginMutator).Parallel()
Inseob Kimac1e9862019-12-09 18:15:47 +090052 ctx.BottomUp("sysprop_cc", SyspropMutator).Parallel()
Inseob Kimeec88e12020-01-22 11:11:29 +090053 ctx.BottomUp("vendor_snapshot", VendorSnapshotMutator).Parallel()
54 ctx.BottomUp("vendor_snapshot_source", VendorSnapshotSourceMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070055 })
Colin Cross16b23492016-01-06 14:41:07 -080056
Paul Duffin036e7002019-12-19 19:16:28 +000057 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Cross1e676be2016-10-12 14:38:15 -070058 ctx.TopDown("asan_deps", sanitizerDepsMutator(asan))
59 ctx.BottomUp("asan", sanitizerMutator(asan)).Parallel()
Colin Cross16b23492016-01-06 14:41:07 -080060
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070061 ctx.TopDown("hwasan_deps", sanitizerDepsMutator(hwasan))
62 ctx.BottomUp("hwasan", sanitizerMutator(hwasan)).Parallel()
63
Mitch Phillipsbfeade62019-05-01 14:42:05 -070064 ctx.TopDown("fuzzer_deps", sanitizerDepsMutator(fuzzer))
65 ctx.BottomUp("fuzzer", sanitizerMutator(fuzzer)).Parallel()
66
Jiyong Park1d1119f2019-07-29 21:27:18 +090067 // cfi mutator shouldn't run before sanitizers that return true for
68 // incompatibleWithCfi()
Vishwath Mohanb743e9c2017-11-01 09:20:21 +000069 ctx.TopDown("cfi_deps", sanitizerDepsMutator(cfi))
70 ctx.BottomUp("cfi", sanitizerMutator(cfi)).Parallel()
71
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -080072 ctx.TopDown("scs_deps", sanitizerDepsMutator(scs))
73 ctx.BottomUp("scs", sanitizerMutator(scs)).Parallel()
74
Colin Cross1e676be2016-10-12 14:38:15 -070075 ctx.TopDown("tsan_deps", sanitizerDepsMutator(tsan))
76 ctx.BottomUp("tsan", sanitizerMutator(tsan)).Parallel()
Dan Willemsen581341d2017-02-09 16:16:31 -080077
Colin Cross0b908332019-06-19 23:00:20 -070078 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090079 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080080
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080081 ctx.BottomUp("coverage", coverageMutator).Parallel()
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -080082 ctx.TopDown("vndk_deps", sabiDepsMutator)
Stephen Craneba090d12017-05-09 15:44:35 -070083
84 ctx.TopDown("lto_deps", ltoDepsMutator)
85 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090086
Jooyung Han479ca172020-10-19 18:51:07 +090087 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090088 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070089 })
Colin Crossb98c8b02016-07-29 13:44:28 -070090
Sasha Smundak2a4549e2018-11-05 16:49:08 -080091 android.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070092}
93
Colin Crossca860ac2016-01-04 14:34:37 -080094type Deps struct {
95 SharedLibs, LateSharedLibs []string
96 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080097 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +080098 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -070099
Chris Parsons79d66a52020-06-05 17:26:16 -0400100 // Used for data dependencies adjacent to tests
101 DataLibs []string
102
Yo Chiang219968c2020-09-22 18:45:04 +0800103 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
104 SystemSharedLibs []string
105
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800106 StaticUnwinderIfLegacy bool
107
Colin Cross5950f382016-12-13 12:50:57 -0800108 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700109
Colin Cross81413472016-04-11 14:37:39 -0700110 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700111
Dan Willemsenb40aab62016-04-20 14:21:14 -0700112 GeneratedSources []string
113 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900114 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700115
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700116 ReexportGeneratedHeaders []string
117
Colin Cross97ba0732015-03-23 17:50:24 -0700118 CrtBegin, CrtEnd string
Dan Willemsena0790e32018-10-12 00:24:23 -0700119
120 // Used for host bionic
121 LinkerFlagsFile string
122 DynamicLinker string
Colin Crossc472d572015-03-17 15:06:21 -0700123}
124
Colin Crossca860ac2016-01-04 14:34:37 -0800125type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700126 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900127 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700128 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900129 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700130 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700131 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700132
Colin Cross0de8a1e2020-09-18 14:15:30 -0700133 // Transitive static library dependencies of static libraries for use in ordering.
134 TranstiveStaticLibrariesForOrdering *android.DepSet
135
Colin Cross26c34ed2016-09-30 17:10:16 -0700136 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100137 Objs Objects
138 // Paths to .o files in dependencies that provide them. Note that these lists
139 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800140 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700141 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700142
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100143 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
144 // the libs from all whole_static_lib dependencies.
145 WholeStaticLibsFromPrebuilts android.Paths
146
Colin Cross26c34ed2016-09-30 17:10:16 -0700147 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700148 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900149 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700150
Inseob Kimd110f872019-12-06 13:15:38 +0900151 Flags []string
152 IncludeDirs android.Paths
153 SystemIncludeDirs android.Paths
154 ReexportedDirs android.Paths
155 ReexportedSystemDirs android.Paths
156 ReexportedFlags []string
157 ReexportedGeneratedHeaders android.Paths
158 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700159
Colin Cross26c34ed2016-09-30 17:10:16 -0700160 // Paths to crt*.o files
Colin Cross635c3b02016-05-18 15:37:25 -0700161 CrtBegin, CrtEnd android.OptionalPath
Dan Willemsena0790e32018-10-12 00:24:23 -0700162
163 // Path to the file container flags to use with the linker
164 LinkerFlagsFile android.OptionalPath
165
166 // Path to the dynamic linker binary
167 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700168}
169
Colin Cross4af21ed2019-11-04 09:37:55 -0800170// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
171// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
172// command line so they can be overridden by the local module flags).
173type LocalOrGlobalFlags struct {
174 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700175 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800176 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700177 CFlags []string // Flags that apply to C and C++ source files
178 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
179 ConlyFlags []string // Flags that apply to C source files
180 CppFlags []string // Flags that apply to C++ source files
181 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700182 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800183}
184
185type Flags struct {
186 Local LocalOrGlobalFlags
187 Global LocalOrGlobalFlags
188
189 aidlFlags []string // Flags that apply to aidl source files
190 rsFlags []string // Flags that apply to renderscript source files
191 libFlags []string // Flags to add libraries early to the link order
192 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
193 TidyFlags []string // Flags that apply to clang-tidy
194 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700195
Colin Crossc3199482017-03-30 15:03:04 -0700196 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800197 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700198 SystemIncludeFlags []string
199
Oliver Nguyen04526782020-04-21 12:40:27 -0700200 Toolchain config.Toolchain
201 Tidy bool
202 GcovCoverage bool
203 SAbiDump bool
204 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800205
206 RequiredInstructionSet string
Colin Cross16b23492016-01-06 14:41:07 -0800207 DynamicLinker string
208
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700209 CFlagsDeps android.Paths // Files depended on by compiler flags
210 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800211
Dan Willemsen98ab3112019-08-27 21:20:40 -0700212 AssemblerWithCpp bool
213 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800214
Colin Cross19878da2019-03-28 14:45:07 -0700215 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700216 protoC bool // Whether to use C instead of C++
217 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700218
219 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200220 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700221}
222
Colin Crossca860ac2016-01-04 14:34:37 -0800223// Properties used to compile all C or C++ modules
224type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700225 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800226 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700227
Colin Crossc511bc52020-04-07 16:50:32 +0000228 // Minimum sdk version supported when compiling against the ndk. Setting this property causes
229 // two variants to be built, one for the platform and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800230 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700231
Jooyung Han379660c2020-04-21 15:24:00 +0900232 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
233 Min_sdk_version *string
234
Colin Crossc511bc52020-04-07 16:50:32 +0000235 // If true, always create an sdk variant and don't create a platform variant.
236 Sdk_variant_only *bool
237
Jiyong Parkde866cb2018-12-07 23:08:36 +0900238 AndroidMkSharedLibs []string `blueprint:"mutated"`
239 AndroidMkStaticLibs []string `blueprint:"mutated"`
240 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
241 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700242 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900243 HideFromMake bool `blueprint:"mutated"`
244 PreventInstall bool `blueprint:"mutated"`
245 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700246
Yo Chiang219968c2020-09-22 18:45:04 +0800247 // Set by DepsMutator.
248 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
249
Justin Yun5f7f7e82019-11-18 19:52:14 +0900250 ImageVariationPrefix string `blueprint:"mutated"`
251 VndkVersion string `blueprint:"mutated"`
252 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800253
254 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
255 // file
256 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900257
Yifan Hong39143a92020-10-26 12:43:12 -0700258 // Make this module available when building for ramdisk.
259 // On device without a dedicated recovery partition, the module is only
260 // available after switching root into
261 // /first_stage_ramdisk. To expose the module before switching root, install
262 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800263 Ramdisk_available *bool
264
Yifan Hong39143a92020-10-26 12:43:12 -0700265 // Make this module available when building for vendor ramdisk.
266 // On device without a dedicated recovery partition, the module is only
267 // available after switching root into
268 // /first_stage_ramdisk. To expose the module before switching root, install
269 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700270 Vendor_ramdisk_available *bool
271
Jiyong Parkf9332f12018-02-01 00:54:12 +0900272 // Make this module available when building for recovery
273 Recovery_available *bool
274
Colin Crossae6c5202019-11-20 13:35:50 -0800275 // Set by imageMutator
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700276 CoreVariantNeeded bool `blueprint:"mutated"`
277 RamdiskVariantNeeded bool `blueprint:"mutated"`
278 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
279 RecoveryVariantNeeded bool `blueprint:"mutated"`
280 ExtraVariants []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900281
282 // Allows this module to use non-APEX version of libraries. Useful
283 // for building binaries that are started before APEXes are activated.
284 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900285
286 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
287 // see soong/cc/config/vndk.go
288 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900289
290 // Used by vendor snapshot to record dependencies from snapshot modules.
291 SnapshotSharedLibs []string `blueprint:"mutated"`
292 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000293
294 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000295
296 // Set by factories of module types that can only be referenced from variants compiled against
297 // the SDK.
298 AlwaysSdk bool `blueprint:"mutated"`
299
300 // Variant is an SDK variant created by sdkMutator
301 IsSdkVariant bool `blueprint:"mutated"`
302 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
303 // variant to have a ".sdk" suffix.
304 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700305
306 // Normally Soong uses the directory structure to decide which modules
307 // should be included (framework) or excluded (non-framework) from the
308 // vendor snapshot, but this property allows a partner to exclude a
309 // module normally thought of as a framework module from the vendor
310 // snapshot.
311 Exclude_from_vendor_snapshot *bool
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700312}
313
314type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900315 // whether this module should be allowed to be directly depended by other
316 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900317 // If set to true, two variants will be built separately, one like
318 // normal, and the other limited to the set of libraries and headers
319 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700320 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900321 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700322 // so it shouldn't have any unversioned runtime dependencies, or
323 // make assumptions about the system that may not be true in the
324 // future.
325 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900326 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900327 //
328 // Default value is true when vndk: {enabled: true} or vendor: true.
329 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700330 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
331 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900332
Justin Yun63e9ec72020-10-29 16:49:43 +0900333 // whether this module should be allowed to be directly depended by other
334 // modules with `product_specific: true` or `product_available: true`.
335 // If set to true, an additional product variant will be built separately
336 // that is limited to the set of libraries and headers that are exposed to
337 // /product modules.
338 //
339 // The product variant may be used with a different (newer) /system,
340 // so it shouldn't have any unversioned runtime dependencies, or
341 // make assumptions about the system that may not be true in the
342 // future.
343 //
344 // It must be set to true by default for vndk: {enabled: true} modules.
345 //
346 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
347 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
348 Product_available *bool
349
Jiyong Park5fb8c102018-04-09 12:03:06 +0900350 // whether this module is capable of being loaded with other instance
351 // (possibly an older version) of the same module in the same process.
352 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
353 // can be double loaded in a vendor process if the library is also a
354 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
355 // explicitly marked as `double_loadable: true` by the owner, or the dependency
356 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
357 Double_loadable *bool
Colin Crossca860ac2016-01-04 14:34:37 -0800358}
359
Colin Crossca860ac2016-01-04 14:34:37 -0800360type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800361 static() bool
362 staticBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900363 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900364 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900365 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700366 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900367 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700368 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800369 sdkVersion() string
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700370 useVndk() bool
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800371 isNdk() bool
Inseob Kim9516ee92019-05-09 10:56:13 +0900372 isLlndk(config android.Config) bool
373 isLlndkPublic(config android.Config) bool
374 isVndkPrivate(config android.Config) bool
Justin Yun8effde42017-06-23 19:24:43 +0900375 isVndk() bool
376 isVndkSp() bool
Logan Chienf3511742017-10-31 18:04:35 +0800377 isVndkExt() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900378 inProduct() bool
379 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800380 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700381 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900382 inRecovery() bool
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +0800383 shouldCreateSourceAbiDump() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700384 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700385 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800386 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800387 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800388 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800389 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800390 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700391 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700392 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900393 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800394 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700395 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700396 directlyInAnyApex() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800397}
398
399type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700400 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800401 ModuleContextIntf
402}
403
404type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700405 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800406 ModuleContextIntf
407}
408
Colin Cross37047f12016-12-13 17:06:13 -0800409type DepsContext interface {
410 android.BottomUpMutatorContext
411 ModuleContextIntf
412}
413
Colin Crossca860ac2016-01-04 14:34:37 -0800414type feature interface {
415 begin(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800416 deps(ctx DepsContext, deps Deps) Deps
Colin Crossca860ac2016-01-04 14:34:37 -0800417 flags(ctx ModuleContext, flags Flags) Flags
418 props() []interface{}
419}
420
421type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700422 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800423 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800424 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700425 compilerProps() []interface{}
426
Colin Cross76fada02016-07-27 10:31:13 -0700427 appendCflags([]string)
428 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700429 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800430}
431
432type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700433 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800434 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700435 linkerFlags(ctx ModuleContext, flags Flags) Flags
436 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800437 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700438
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700439 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700440 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900441 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700442
443 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900444 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000445
446 // Get the deps that have been explicitly specified in the properties.
447 // Only updates the
448 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
449}
450
451type specifiedDeps struct {
452 sharedLibs []string
Martin Stjernholm10566a02020-03-24 01:19:52 +0000453 systemSharedLibs []string // Note nil and [] are semantically distinct.
Colin Crossca860ac2016-01-04 14:34:37 -0800454}
455
456type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700457 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700458 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000459 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800460 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700461 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700462 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900463 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100464 makeUninstallable(mod *Module)
Colin Crossca860ac2016-01-04 14:34:37 -0800465}
466
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800467type xref interface {
468 XrefCcFiles() android.Paths
469}
470
Colin Cross6e511a92020-07-27 21:26:48 -0700471type libraryDependencyKind int
472
473const (
474 headerLibraryDependency = iota
475 sharedLibraryDependency
476 staticLibraryDependency
477)
478
479func (k libraryDependencyKind) String() string {
480 switch k {
481 case headerLibraryDependency:
482 return "headerLibraryDependency"
483 case sharedLibraryDependency:
484 return "sharedLibraryDependency"
485 case staticLibraryDependency:
486 return "staticLibraryDependency"
487 default:
488 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
489 }
490}
491
492type libraryDependencyOrder int
493
494const (
495 earlyLibraryDependency = -1
496 normalLibraryDependency = 0
497 lateLibraryDependency = 1
498)
499
500func (o libraryDependencyOrder) String() string {
501 switch o {
502 case earlyLibraryDependency:
503 return "earlyLibraryDependency"
504 case normalLibraryDependency:
505 return "normalLibraryDependency"
506 case lateLibraryDependency:
507 return "lateLibraryDependency"
508 default:
509 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
510 }
511}
512
513// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
514// tags that have a set of predefined tag objects that are reused for each dependency, a
515// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
516// That means that comparing a libraryDependencyTag for equality will only be equal if all
517// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
518// then check individual metadata fields instead.
519type libraryDependencyTag struct {
520 blueprint.BaseDependencyTag
521
522 // These are exported so that fmt.Printf("%#v") can call their String methods.
523 Kind libraryDependencyKind
524 Order libraryDependencyOrder
525
526 wholeStatic bool
527
528 reexportFlags bool
529 explicitlyVersioned bool
530 dataLib bool
531 ndk bool
532
533 staticUnwinder bool
534
535 makeSuffix string
536}
537
538// header returns true if the libraryDependencyTag is tagging a header lib dependency.
539func (d libraryDependencyTag) header() bool {
540 return d.Kind == headerLibraryDependency
541}
542
543// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
544func (d libraryDependencyTag) shared() bool {
545 return d.Kind == sharedLibraryDependency
546}
547
548// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
549func (d libraryDependencyTag) static() bool {
550 return d.Kind == staticLibraryDependency
551}
552
553// dependencyTag is used for tagging miscellanous dependency types that don't fit into
554// libraryDependencyTag. Each tag object is created globally and reused for multiple
555// dependencies (although since the object contains no references, assigning a tag to a
556// variable and modifying it will not modify the original). Users can compare the tag
557// returned by ctx.OtherModuleDependencyTag against the global original
558type dependencyTag struct {
559 blueprint.BaseDependencyTag
560 name string
561}
562
Colin Crossc99deeb2016-04-11 15:06:20 -0700563var (
Colin Cross6e511a92020-07-27 21:26:48 -0700564 genSourceDepTag = dependencyTag{name: "gen source"}
565 genHeaderDepTag = dependencyTag{name: "gen header"}
566 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
567 objDepTag = dependencyTag{name: "obj"}
568 linkerFlagsDepTag = dependencyTag{name: "linker flags file"}
569 dynamicLinkerDepTag = dependencyTag{name: "dynamic linker"}
570 reuseObjTag = dependencyTag{name: "reuse objects"}
571 staticVariantTag = dependencyTag{name: "static variant"}
572 vndkExtDepTag = dependencyTag{name: "vndk extends"}
573 dataLibDepTag = dependencyTag{name: "data lib"}
574 runtimeDepTag = dependencyTag{name: "runtime lib"}
575 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700576 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700577)
578
Colin Cross56a83212020-09-15 18:30:11 -0700579type copyDirectlyInAnyApexDependencyTag dependencyTag
580
581func (copyDirectlyInAnyApexDependencyTag) CopyDirectlyInAnyApex() {}
582
583var _ android.CopyDirectlyInAnyApexTag = copyDirectlyInAnyApexDependencyTag{}
584
Roland Levillainf89cd092019-07-29 16:22:59 +0100585func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700586 ccLibDepTag, ok := depTag.(libraryDependencyTag)
587 return ok && ccLibDepTag.shared()
588}
589
590func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
591 ccLibDepTag, ok := depTag.(libraryDependencyTag)
592 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100593}
594
Zach Johnson3df4e632020-11-06 11:56:27 -0800595func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
596 ccLibDepTag, ok := depTag.(libraryDependencyTag)
597 return ok && ccLibDepTag.header()
598}
599
Roland Levillainf89cd092019-07-29 16:22:59 +0100600func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700601 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100602 return ok && ccDepTag == runtimeDepTag
603}
604
605func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700606 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100607 return ok && ccDepTag == testPerSrcDepTag
608}
609
Colin Crossca860ac2016-01-04 14:34:37 -0800610// Module contains the properties and members used by all C/C++ module types, and implements
611// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
612// to construct the output file. Behavior can be customized with a Customizer interface
613type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700614 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700615 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900616 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900617 android.SdkBase
Colin Crossc472d572015-03-17 15:06:21 -0700618
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700619 Properties BaseProperties
620 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700621
Colin Crossca860ac2016-01-04 14:34:37 -0800622 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700623 hod android.HostOrDeviceSupported
624 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700625
Paul Duffina0843f62019-12-13 19:50:38 +0000626 // Allowable SdkMemberTypes of this module type.
627 sdkMemberTypes []android.SdkMemberType
628
Colin Crossca860ac2016-01-04 14:34:37 -0800629 // delegates, initialize before calling Init
Colin Crossb4ce0ec2016-09-13 13:41:39 -0700630 features []feature
631 compiler compiler
632 linker linker
633 installer installer
634 stl *stl
635 sanitize *sanitize
Dan Willemsen581341d2017-02-09 16:16:31 -0800636 coverage *coverage
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800637 sabi *sabi
Justin Yun8effde42017-06-23 19:24:43 +0900638 vndkdep *vndkdep
Stephen Craneba090d12017-05-09 15:44:35 -0700639 lto *lto
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700640 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800641
Colin Cross31076b32020-10-23 17:22:06 -0700642 library libraryInterface
643
Colin Cross635c3b02016-05-18 15:37:25 -0700644 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800645
Colin Crossb98c8b02016-07-29 13:44:28 -0700646 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700647
648 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800649
650 // Flags used to compile this module
651 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700652
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800653 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700654 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900655
656 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800657 // Kythe (source file indexer) paths for this compilation module
658 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900659
660 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700661 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700662
663 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700664}
665
Ivan Lozano52767be2019-10-18 14:49:46 -0700666func (c *Module) Toc() android.OptionalPath {
667 if c.linker != nil {
668 if library, ok := c.linker.(libraryInterface); ok {
669 return library.toc()
670 }
671 }
672 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
673}
674
675func (c *Module) ApiLevel() string {
676 if c.linker != nil {
677 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700678 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700679 }
680 }
681 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
682}
683
684func (c *Module) Static() bool {
685 if c.linker != nil {
686 if library, ok := c.linker.(libraryInterface); ok {
687 return library.static()
688 }
689 }
690 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
691}
692
693func (c *Module) Shared() bool {
694 if c.linker != nil {
695 if library, ok := c.linker.(libraryInterface); ok {
696 return library.shared()
697 }
698 }
699 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
700}
701
702func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000703 if c.stl != nil {
704 return c.stl.Properties.SelectedStl
705 }
706 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700707}
708
709func (c *Module) ToolchainLibrary() bool {
710 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
711 return true
712 }
713 return false
714}
715
716func (c *Module) NdkPrebuiltStl() bool {
717 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
718 return true
719 }
720 return false
721}
722
723func (c *Module) StubDecorator() bool {
724 if _, ok := c.linker.(*stubDecorator); ok {
725 return true
726 }
727 return false
728}
729
730func (c *Module) SdkVersion() string {
731 return String(c.Properties.Sdk_version)
732}
733
Artur Satayev480e25b2020-04-27 18:53:18 +0100734func (c *Module) MinSdkVersion() string {
735 return String(c.Properties.Min_sdk_version)
736}
737
Dan Albert92fe7402020-07-15 13:33:30 -0700738func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700739 if !c.canUseSdk() {
740 return false
741 }
Dan Albert92fe7402020-07-15 13:33:30 -0700742 if linker, ok := c.linker.(*objectLinker); ok {
743 return linker.isCrt()
744 }
745 return false
746}
747
Colin Crossc511bc52020-04-07 16:50:32 +0000748func (c *Module) AlwaysSdk() bool {
749 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
750}
751
Ivan Lozano183a3212019-10-18 14:18:45 -0700752func (c *Module) CcLibrary() bool {
753 if c.linker != nil {
754 if _, ok := c.linker.(*libraryDecorator); ok {
755 return true
756 }
Colin Crossd48fe732020-09-23 20:37:24 -0700757 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
758 return true
759 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700760 }
761 return false
762}
763
764func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700765 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700766 return true
767 }
768 return false
769}
770
Ivan Lozano2b262972019-11-21 12:30:50 -0800771func (c *Module) NonCcVariants() bool {
772 return false
773}
774
Ivan Lozano183a3212019-10-18 14:18:45 -0700775func (c *Module) SetStatic() {
776 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700777 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700778 library.setStatic()
779 return
780 }
781 }
782 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
783}
784
785func (c *Module) SetShared() {
786 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700787 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700788 library.setShared()
789 return
790 }
791 }
792 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
793}
794
795func (c *Module) BuildStaticVariant() bool {
796 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700797 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700798 return library.buildStatic()
799 }
800 }
801 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
802}
803
804func (c *Module) BuildSharedVariant() bool {
805 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700806 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700807 return library.buildShared()
808 }
809 }
810 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
811}
812
813func (c *Module) Module() android.Module {
814 return c
815}
816
Jiyong Parkc20eee32018-09-05 22:36:17 +0900817func (c *Module) OutputFile() android.OptionalPath {
818 return c.outputFile
819}
820
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400821func (c *Module) CoverageFiles() android.Paths {
822 if c.linker != nil {
823 if library, ok := c.linker.(libraryInterface); ok {
824 return library.objs().coverageFiles
825 }
826 }
827 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
828}
829
Ivan Lozano183a3212019-10-18 14:18:45 -0700830var _ LinkableInterface = (*Module)(nil)
831
Jiyong Park719b4462019-01-13 00:39:51 +0900832func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900833 if c.linker != nil {
834 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +0900835 }
836 return nil
837}
838
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900839func (c *Module) CoverageOutputFile() android.OptionalPath {
840 if c.linker != nil {
841 return c.linker.coverageOutputFilePath()
842 }
843 return android.OptionalPath{}
844}
845
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900846func (c *Module) RelativeInstallPath() string {
847 if c.installer != nil {
848 return c.installer.relativeInstallPath()
849 }
850 return ""
851}
852
Jooyung Han344d5432019-08-23 11:17:39 +0900853func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +0900854 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +0900855}
856
Colin Cross36242852017-06-23 15:06:31 -0700857func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -0700858 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -0800859 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -0700860 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800861 }
862 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -0700863 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800864 }
865 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -0700866 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800867 }
Colin Crossa8e07cc2016-04-04 15:07:06 -0700868 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -0700869 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -0700870 }
Colin Cross16b23492016-01-06 14:41:07 -0800871 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -0700872 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -0800873 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800874 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -0700875 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -0800876 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800877 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -0700878 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800879 }
Justin Yun8effde42017-06-23 19:24:43 +0900880 if c.vndkdep != nil {
881 c.AddProperties(c.vndkdep.props()...)
882 }
Stephen Craneba090d12017-05-09 15:44:35 -0700883 if c.lto != nil {
884 c.AddProperties(c.lto.props()...)
885 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700886 if c.pgo != nil {
887 c.AddProperties(c.pgo.props()...)
888 }
Colin Crossca860ac2016-01-04 14:34:37 -0800889 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -0700890 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800891 }
Colin Crossc472d572015-03-17 15:06:21 -0700892
Jiyong Park1613e552020-09-14 19:43:17 +0900893 c.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, os android.OsType) bool {
Elliott Hughes79ae3412020-04-17 15:49:49 -0700894 // Windows builds always prefer 32-bit
Jiyong Park1613e552020-09-14 19:43:17 +0900895 return os == android.Windows
Colin Crossa9d8bee2018-10-02 13:59:46 -0700896 })
Colin Cross36242852017-06-23 15:06:31 -0700897 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +0900898 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900899 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +0900900 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +0900901
Colin Cross36242852017-06-23 15:06:31 -0700902 return c
Colin Crossc472d572015-03-17 15:06:21 -0700903}
904
Colin Crossb916a382016-07-29 17:28:03 -0700905// Returns true for dependency roots (binaries)
906// TODO(ccross): also handle dlopenable libraries
907func (c *Module) isDependencyRoot() bool {
908 if root, ok := c.linker.(interface {
909 isDependencyRoot() bool
910 }); ok {
911 return root.isDependencyRoot()
912 }
913 return false
914}
915
Justin Yun5f7f7e82019-11-18 19:52:14 +0900916// Returns true if the module is using VNDK libraries instead of the libraries in /system/lib or /system/lib64.
917// "product" and "vendor" variant modules return true for this function.
918// When BOARD_VNDK_VERSION is set, vendor variants of "vendor_available: true", "vendor: true",
919// "soc_specific: true" and more vendor installed modules are included here.
Justin Yun63e9ec72020-10-29 16:49:43 +0900920// When PRODUCT_PRODUCT_VNDK_VERSION is set, product variants of "product_available: true" or
Justin Yun5f7f7e82019-11-18 19:52:14 +0900921// "product_specific: true" modules are included here.
Ivan Lozano52767be2019-10-18 14:49:46 -0700922func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +0900923 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700924}
925
Colin Crossc511bc52020-04-07 16:50:32 +0000926func (c *Module) canUseSdk() bool {
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700927 return c.Os() == android.Android && !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +0000928}
929
930func (c *Module) UseSdk() bool {
931 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -0700932 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +0000933 }
934 return false
935}
936
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800937func (c *Module) isCoverageVariant() bool {
938 return c.coverage.Properties.IsCoverageVariant
939}
940
Peter Collingbournead84f972019-12-17 16:46:18 -0800941func (c *Module) IsNdk() bool {
Colin Crossf0913fb2020-07-29 12:59:39 -0700942 return inList(c.BaseModuleName(), ndkKnownLibs)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800943}
944
Inseob Kim9516ee92019-05-09 10:56:13 +0900945func (c *Module) isLlndk(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800946 // Returns true for both LLNDK (public) and LLNDK-private libs.
Jooyung Han0302a842019-10-30 18:43:49 +0900947 return isLlndkLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800948}
949
Inseob Kim9516ee92019-05-09 10:56:13 +0900950func (c *Module) isLlndkPublic(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800951 // Returns true only for LLNDK (public) libs.
Jooyung Han0302a842019-10-30 18:43:49 +0900952 name := c.BaseModuleName()
953 return isLlndkLibrary(name, config) && !isVndkPrivateLibrary(name, config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800954}
955
Inseob Kim9516ee92019-05-09 10:56:13 +0900956func (c *Module) isVndkPrivate(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800957 // Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Jooyung Han0302a842019-10-30 18:43:49 +0900958 return isVndkPrivateLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800959}
960
Ivan Lozano52767be2019-10-18 14:49:46 -0700961func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +0800962 if vndkdep := c.vndkdep; vndkdep != nil {
963 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +0900964 }
965 return false
966}
967
Yi Kong7e53c572018-02-14 18:16:12 +0800968func (c *Module) isPgoCompile() bool {
969 if pgo := c.pgo; pgo != nil {
970 return pgo.Properties.PgoCompile
971 }
972 return false
973}
974
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800975func (c *Module) isNDKStubLibrary() bool {
976 if _, ok := c.compiler.(*stubDecorator); ok {
977 return true
978 }
979 return false
980}
981
Logan Chienf3511742017-10-31 18:04:35 +0800982func (c *Module) isVndkSp() bool {
983 if vndkdep := c.vndkdep; vndkdep != nil {
984 return vndkdep.isVndkSp()
985 }
986 return false
987}
988
989func (c *Module) isVndkExt() bool {
990 if vndkdep := c.vndkdep; vndkdep != nil {
991 return vndkdep.isVndkExt()
992 }
993 return false
994}
995
Ivan Lozano52767be2019-10-18 14:49:46 -0700996func (c *Module) MustUseVendorVariant() bool {
Jooyung Han097087b2019-10-22 19:32:18 +0900997 return c.isVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -0800998}
999
Logan Chienf3511742017-10-31 18:04:35 +08001000func (c *Module) getVndkExtendsModuleName() string {
1001 if vndkdep := c.vndkdep; vndkdep != nil {
1002 return vndkdep.getVndkExtendsModuleName()
1003 }
1004 return ""
1005}
1006
Jiyong Park25fc6a92018-11-18 18:02:45 +09001007func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001008 if lib := c.library; lib != nil {
1009 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001010 }
1011 return false
1012}
1013
1014func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001015 if lib := c.library; lib != nil {
1016 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001017 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001018 return false
1019}
1020
Colin Cross0477b422020-10-13 18:43:54 -07001021// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1022// the implementation. If it is an implementation library it returns its own name.
1023func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1024 name := ctx.OtherModuleName(c)
1025 if versioned, ok := c.linker.(versionedInterface); ok {
1026 name = versioned.implementationModuleName(name)
1027 }
1028 return name
1029}
1030
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001031func (c *Module) bootstrap() bool {
1032 return Bool(c.Properties.Bootstrap)
1033}
1034
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001035func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001036 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1037 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1038 return false
1039 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001040 return c.linker != nil && c.linker.nativeCoverage()
1041}
1042
Inseob Kim8471cda2019-11-15 09:59:12 +09001043func (c *Module) isSnapshotPrebuilt() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09001044 if p, ok := c.linker.(interface{ isSnapshotPrebuilt() bool }); ok {
1045 return p.isSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001046 }
1047 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001048}
1049
Bill Peckham945441c2020-08-31 16:07:58 -07001050func (c *Module) ExcludeFromVendorSnapshot() bool {
1051 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1052}
1053
Jiyong Parkf1194352019-02-25 11:05:47 +09001054func isBionic(name string) bool {
1055 switch name {
Martin Stjernholm203489b2019-11-11 15:33:27 +00001056 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001057 return true
1058 }
1059 return false
1060}
1061
Martin Stjernholm279de572019-09-10 23:18:20 +01001062func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001063 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001064 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001065 }
1066 return isBionic(name)
1067}
1068
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001069func (c *Module) XrefCcFiles() android.Paths {
1070 return c.kytheFiles
1071}
1072
Colin Crossca860ac2016-01-04 14:34:37 -08001073type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001074 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001075 moduleContextImpl
1076}
1077
Colin Cross37047f12016-12-13 17:06:13 -08001078type depsContext struct {
1079 android.BottomUpMutatorContext
1080 moduleContextImpl
1081}
1082
Colin Crossca860ac2016-01-04 14:34:37 -08001083type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001084 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001085 moduleContextImpl
1086}
1087
1088type moduleContextImpl struct {
1089 mod *Module
1090 ctx BaseModuleContext
1091}
1092
Colin Crossb98c8b02016-07-29 13:44:28 -07001093func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001094 return ctx.mod.toolchain(ctx.ctx)
1095}
1096
1097func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001098 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001099}
1100
1101func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001102 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001103}
1104
Jiyong Park1d1119f2019-07-29 21:27:18 +09001105func (ctx *moduleContextImpl) header() bool {
1106 return ctx.mod.header()
1107}
1108
Inseob Kim7f283f42020-06-01 21:53:49 +09001109func (ctx *moduleContextImpl) binary() bool {
1110 return ctx.mod.binary()
1111}
1112
Inseob Kim1042d292020-06-01 23:23:05 +09001113func (ctx *moduleContextImpl) object() bool {
1114 return ctx.mod.object()
1115}
1116
Jooyung Hanccce2f22020-03-07 03:45:53 +09001117func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001118 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001119}
1120
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001121func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001122 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001123}
1124
1125func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001126 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001127 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001128 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001129 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001130 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001131 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001132 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001133 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001134 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001135 }
1136 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001137}
1138
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001139func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001140 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001141}
Justin Yun8effde42017-06-23 19:24:43 +09001142
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001143func (ctx *moduleContextImpl) isNdk() bool {
Peter Collingbournead84f972019-12-17 16:46:18 -08001144 return ctx.mod.IsNdk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001145}
1146
Inseob Kim9516ee92019-05-09 10:56:13 +09001147func (ctx *moduleContextImpl) isLlndk(config android.Config) bool {
1148 return ctx.mod.isLlndk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001149}
1150
Inseob Kim9516ee92019-05-09 10:56:13 +09001151func (ctx *moduleContextImpl) isLlndkPublic(config android.Config) bool {
1152 return ctx.mod.isLlndkPublic(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001153}
1154
Inseob Kim9516ee92019-05-09 10:56:13 +09001155func (ctx *moduleContextImpl) isVndkPrivate(config android.Config) bool {
1156 return ctx.mod.isVndkPrivate(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001157}
1158
Logan Chienf3511742017-10-31 18:04:35 +08001159func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001160 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001161}
1162
Yi Kong7e53c572018-02-14 18:16:12 +08001163func (ctx *moduleContextImpl) isPgoCompile() bool {
1164 return ctx.mod.isPgoCompile()
1165}
1166
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001167func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1168 return ctx.mod.isNDKStubLibrary()
1169}
1170
Justin Yun8effde42017-06-23 19:24:43 +09001171func (ctx *moduleContextImpl) isVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001172 return ctx.mod.isVndkSp()
1173}
1174
1175func (ctx *moduleContextImpl) isVndkExt() bool {
1176 return ctx.mod.isVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001177}
1178
Vic Yangefd249e2018-11-12 20:19:56 -08001179func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001180 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001181}
1182
Logan Chien2f2b8902018-07-10 15:01:19 +08001183// Check whether ABI dumps should be created for this module.
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001184func (ctx *moduleContextImpl) shouldCreateSourceAbiDump() bool {
Logan Chien2f2b8902018-07-10 15:01:19 +08001185 if ctx.ctx.Config().IsEnvTrue("SKIP_ABI_CHECKS") {
1186 return false
Jayant Chowdharyea0a2e12018-03-01 19:12:16 -08001187 }
Doug Hornc32c6b02019-01-17 14:44:05 -08001188
Hsin-Yi Chenf81bb652020-04-07 21:42:19 +08001189 // Coverage builds have extra symbols.
1190 if ctx.mod.isCoverageVariant() {
1191 return false
1192 }
1193
Doug Hornc32c6b02019-01-17 14:44:05 -08001194 if ctx.ctx.Fuchsia() {
1195 return false
1196 }
1197
Logan Chien2f2b8902018-07-10 15:01:19 +08001198 if sanitize := ctx.mod.sanitize; sanitize != nil {
1199 if !sanitize.isVariantOnProductionDevice() {
1200 return false
1201 }
1202 }
1203 if !ctx.ctx.Device() {
1204 // Host modules do not need ABI dumps.
1205 return false
1206 }
Colin Cross31076b32020-10-23 17:22:06 -07001207 if ctx.isNDKStubLibrary() {
Hsin-Yi Chenf6a95462019-06-25 14:46:52 +08001208 // Stubs do not need ABI dumps.
1209 return false
1210 }
Colin Cross31076b32020-10-23 17:22:06 -07001211 if lib := ctx.mod.library; lib != nil && lib.buildStubs() {
1212 // Stubs do not need ABI dumps.
1213 return false
1214 }
1215
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001216 return true
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001217}
1218
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001219func (ctx *moduleContextImpl) selectedStl() string {
1220 if stl := ctx.mod.stl; stl != nil {
1221 return stl.Properties.SelectedStl
1222 }
1223 return ""
1224}
1225
Ivan Lozanobd721262018-11-27 14:33:03 -08001226func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1227 return ctx.mod.linker.useClangLld(actx)
1228}
1229
Colin Crossce75d2c2016-10-06 16:12:58 -07001230func (ctx *moduleContextImpl) baseModuleName() string {
1231 return ctx.mod.ModuleBase.BaseModuleName()
1232}
1233
Logan Chienf3511742017-10-31 18:04:35 +08001234func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1235 return ctx.mod.getVndkExtendsModuleName()
1236}
1237
Logan Chiene274fc92019-12-03 11:18:32 -08001238func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001239 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001240}
1241
Colin Crosse07f2312020-08-13 11:24:56 -07001242func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001243 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001244}
1245
Dan Albertc8060532020-07-22 22:32:17 -07001246func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001247 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001248}
1249
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001250func (ctx *moduleContextImpl) bootstrap() bool {
1251 return ctx.mod.bootstrap()
1252}
1253
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001254func (ctx *moduleContextImpl) nativeCoverage() bool {
1255 return ctx.mod.nativeCoverage()
1256}
1257
Colin Cross56a83212020-09-15 18:30:11 -07001258func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1259 return ctx.mod.DirectlyInAnyApex()
1260}
1261
Colin Cross635c3b02016-05-18 15:37:25 -07001262func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001263 return &Module{
1264 hod: hod,
1265 multilib: multilib,
1266 }
1267}
1268
Colin Cross635c3b02016-05-18 15:37:25 -07001269func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001270 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001271 module.features = []feature{
1272 &tidyFeature{},
1273 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001274 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001275 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001276 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001277 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001278 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001279 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001280 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001281 return module
1282}
1283
Colin Crossce75d2c2016-10-06 16:12:58 -07001284func (c *Module) Prebuilt() *android.Prebuilt {
1285 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1286 return p.prebuilt()
1287 }
1288 return nil
1289}
1290
1291func (c *Module) Name() string {
1292 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001293 if p, ok := c.linker.(interface {
1294 Name(string) string
1295 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001296 name = p.Name(name)
1297 }
1298 return name
1299}
1300
Alex Light3d673592019-01-18 14:37:31 -08001301func (c *Module) Symlinks() []string {
1302 if p, ok := c.installer.(interface {
1303 symlinkList() []string
1304 }); ok {
1305 return p.symlinkList()
1306 }
1307 return nil
1308}
1309
Roland Levillainf89cd092019-07-29 16:22:59 +01001310func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1311 test, ok := c.linker.(testPerSrc)
1312 return ok && test.isAllTestsVariation()
1313}
1314
Chris Parsons216e10a2020-07-09 17:12:52 -04001315func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001316 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001317 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001318 }); ok {
1319 return p.dataPaths()
1320 }
1321 return nil
1322}
1323
Justin Yun5f7f7e82019-11-18 19:52:14 +09001324func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1325 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1326 // "current", it will append the VNDK version to the name suffix.
1327 var vndkVersion string
1328 var nameSuffix string
1329 if c.inProduct() {
1330 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1331 nameSuffix = productSuffix
1332 } else {
1333 vndkVersion = ctx.DeviceConfig().VndkVersion()
1334 nameSuffix = vendorSuffix
1335 }
1336 if vndkVersion == "current" {
1337 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1338 }
1339 if c.Properties.VndkVersion != vndkVersion {
1340 // add version suffix only if the module is using different vndk version than the
1341 // version in product or vendor partition.
1342 nameSuffix += "." + c.Properties.VndkVersion
1343 }
1344 return nameSuffix
1345}
1346
Colin Cross635c3b02016-05-18 15:37:25 -07001347func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Roland Levillainf2fad972019-06-28 15:41:19 +01001348 // Handle the case of a test module split by `test_per_src` mutator.
Roland Levillainf89cd092019-07-29 16:22:59 +01001349 //
1350 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1351 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1352 // module and return early, as this module does not produce an output file per se.
1353 if c.IsTestPerSrcAllTestsVariation() {
1354 c.outputFile = android.OptionalPath{}
1355 return
Roland Levillainf2fad972019-06-28 15:41:19 +01001356 }
1357
Colin Cross56a83212020-09-15 18:30:11 -07001358 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1359 if !apexInfo.IsForPlatform() {
1360 c.hideApexVariantFromMake = true
1361 }
1362
Jooyung Han38002912019-05-16 04:01:54 +09001363 c.makeLinkType = c.getMakeLinkType(actx)
Inseob Kim9516ee92019-05-09 10:56:13 +09001364
Inseob Kim64c43952019-08-26 16:52:35 +09001365 c.Properties.SubName = ""
1366
1367 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1368 c.Properties.SubName += nativeBridgeSuffix
1369 }
1370
Justin Yun5f7f7e82019-11-18 19:52:14 +09001371 _, llndk := c.linker.(*llndkStubDecorator)
1372 _, llndkHeader := c.linker.(*llndkHeadersDecorator)
Justin Yun63e9ec72020-10-29 16:49:43 +09001373 if llndk || llndkHeader || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001374 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1375 // added for product variant only when we have vendor and product variants with core
1376 // variant. The suffix is not added for vendor-only or product-only module.
1377 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
1378 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001379 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1380 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
1381 c.Properties.SubName += vendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001382 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1383 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001384 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
1385 c.Properties.SubName += vendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001386 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001387 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001388 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001389 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001390 if c.SplitPerApiLevel() {
1391 c.Properties.SubName += "." + c.SdkVersion()
1392 }
Inseob Kim64c43952019-08-26 16:52:35 +09001393 }
1394
Colin Crossca860ac2016-01-04 14:34:37 -08001395 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001396 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001397 moduleContextImpl: moduleContextImpl{
1398 mod: c,
1399 },
1400 }
1401 ctx.ctx = ctx
1402
Colin Crossf18e1102017-11-16 14:33:08 -08001403 deps := c.depsToPaths(ctx)
1404 if ctx.Failed() {
1405 return
1406 }
1407
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001408 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1409 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1410 }
1411
Colin Crossca860ac2016-01-04 14:34:37 -08001412 flags := Flags{
1413 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001414 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001415 }
Colin Crossca860ac2016-01-04 14:34:37 -08001416 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001417 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001418 }
1419 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001420 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001421 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001422 if c.stl != nil {
1423 flags = c.stl.flags(ctx, flags)
1424 }
Colin Cross16b23492016-01-06 14:41:07 -08001425 if c.sanitize != nil {
1426 flags = c.sanitize.flags(ctx, flags)
1427 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001428 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001429 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001430 }
Stephen Craneba090d12017-05-09 15:44:35 -07001431 if c.lto != nil {
1432 flags = c.lto.flags(ctx, flags)
1433 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001434 if c.pgo != nil {
1435 flags = c.pgo.flags(ctx, flags)
1436 }
Colin Crossca860ac2016-01-04 14:34:37 -08001437 for _, feature := range c.features {
1438 flags = feature.flags(ctx, flags)
1439 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001440 if ctx.Failed() {
1441 return
1442 }
1443
Colin Cross4af21ed2019-11-04 09:37:55 -08001444 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1445 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1446 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001447
Colin Cross4af21ed2019-11-04 09:37:55 -08001448 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001449
1450 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001451 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001452 }
1453 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001454 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001455 }
1456
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001457 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001458 // We need access to all the flags seen by a source file.
1459 if c.sabi != nil {
1460 flags = c.sabi.flags(ctx, flags)
1461 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001462
Colin Cross4af21ed2019-11-04 09:37:55 -08001463 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001464
Colin Crossca860ac2016-01-04 14:34:37 -08001465 // Optimization to reduce size of build.ninja
1466 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001467 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1468 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1469 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1470 flags.Local.CFlags = []string{"$cflags"}
1471 flags.Local.CppFlags = []string{"$cppflags"}
1472 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001473
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001474 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001475 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001476 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001477 if ctx.Failed() {
1478 return
1479 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001480 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001481 }
1482
Colin Crossca860ac2016-01-04 14:34:37 -08001483 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001484 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001485 if ctx.Failed() {
1486 return
1487 }
Colin Cross635c3b02016-05-18 15:37:25 -07001488 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001489
1490 // If a lib is directly included in any of the APEXes, unhide the stubs
1491 // variant having the latest version gets visible to make. In addition,
1492 // the non-stubs variant is renamed to <libname>.bootstrap. This is to
1493 // force anything in the make world to link against the stubs library.
1494 // (unless it is explicitly referenced via .bootstrap suffix or the
1495 // module is marked with 'bootstrap: true').
Colin Cross56a83212020-09-15 18:30:11 -07001496 if c.HasStubsVariants() && c.AnyVariantDirectlyInAnyApex() && !c.InRamdisk() &&
Ivan Lozano52767be2019-10-18 14:49:46 -07001497 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001498 c.IsStubs() && !c.InVendorRamdisk() {
Jiyong Parkb0788572018-12-20 22:10:17 +09001499 c.Properties.HideFromMake = false // unhide
1500 // Note: this is still non-installable
1501 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001502
1503 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current.
1504 if i, ok := c.linker.(snapshotLibraryInterface); ok && ctx.DeviceConfig().VndkVersion() == "current" {
Colin Cross56a83212020-09-15 18:30:11 -07001505 if isSnapshotAware(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001506 i.collectHeadersForSnapshot(ctx)
1507 }
1508 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001509 }
Colin Cross5049f022015-03-18 13:28:46 -07001510
Colin Cross56a83212020-09-15 18:30:11 -07001511 if c.installable(apexInfo) {
Colin Crossce75d2c2016-10-06 16:12:58 -07001512 c.installer.install(ctx, c.outputFile.Path())
1513 if ctx.Failed() {
1514 return
Colin Crossca860ac2016-01-04 14:34:37 -08001515 }
Paul Duffin0cb37b92020-03-04 14:52:46 +00001516 } else if !proptools.BoolDefault(c.Properties.Installable, true) {
1517 // If the module has been specifically configure to not be installed then
1518 // skip the installation as otherwise it will break when running inside make
1519 // as the output path to install will not be specified. Not all uninstallable
1520 // modules can skip installation as some are needed for resolving make side
1521 // dependencies.
1522 c.SkipInstall()
Dan Albertc403f7c2015-03-18 14:01:18 -07001523 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001524}
1525
Colin Cross0ea8ba82019-06-06 14:33:29 -07001526func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001527 if c.cachedToolchain == nil {
Colin Crossb98c8b02016-07-29 13:44:28 -07001528 c.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
Colin Cross3f40fa42015-01-30 17:27:36 -08001529 }
Colin Crossca860ac2016-01-04 14:34:37 -08001530 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001531}
1532
Colin Crossca860ac2016-01-04 14:34:37 -08001533func (c *Module) begin(ctx BaseModuleContext) {
1534 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001535 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001536 }
Colin Crossca860ac2016-01-04 14:34:37 -08001537 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001538 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001539 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001540 if c.stl != nil {
1541 c.stl.begin(ctx)
1542 }
Colin Cross16b23492016-01-06 14:41:07 -08001543 if c.sanitize != nil {
1544 c.sanitize.begin(ctx)
1545 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001546 if c.coverage != nil {
1547 c.coverage.begin(ctx)
1548 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001549 if c.sabi != nil {
1550 c.sabi.begin(ctx)
1551 }
Justin Yun8effde42017-06-23 19:24:43 +09001552 if c.vndkdep != nil {
1553 c.vndkdep.begin(ctx)
1554 }
Stephen Craneba090d12017-05-09 15:44:35 -07001555 if c.lto != nil {
1556 c.lto.begin(ctx)
1557 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001558 if c.pgo != nil {
1559 c.pgo.begin(ctx)
1560 }
Colin Crossca860ac2016-01-04 14:34:37 -08001561 for _, feature := range c.features {
1562 feature.begin(ctx)
1563 }
Dan Albert92fe7402020-07-15 13:33:30 -07001564 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001565 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001566 if err != nil {
1567 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001568 c.Properties.Sdk_version = nil
1569 } else {
1570 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001571 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001572 }
Colin Crossca860ac2016-01-04 14:34:37 -08001573}
1574
Colin Cross37047f12016-12-13 17:06:13 -08001575func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001576 deps := Deps{}
1577
1578 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001579 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001580 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001581 // Add the PGO dependency (the clang_rt.profile runtime library), which
1582 // sometimes depends on symbols from libgcc, before libgcc gets added
1583 // in linkerDeps().
Pirama Arumuga Nainar49b53d52017-10-04 16:47:29 -07001584 if c.pgo != nil {
1585 deps = c.pgo.deps(ctx, deps)
1586 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001587 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001588 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001589 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001590 if c.stl != nil {
1591 deps = c.stl.deps(ctx, deps)
1592 }
Colin Cross16b23492016-01-06 14:41:07 -08001593 if c.sanitize != nil {
1594 deps = c.sanitize.deps(ctx, deps)
1595 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001596 if c.coverage != nil {
1597 deps = c.coverage.deps(ctx, deps)
1598 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001599 if c.sabi != nil {
1600 deps = c.sabi.deps(ctx, deps)
1601 }
Justin Yun8effde42017-06-23 19:24:43 +09001602 if c.vndkdep != nil {
1603 deps = c.vndkdep.deps(ctx, deps)
1604 }
Stephen Craneba090d12017-05-09 15:44:35 -07001605 if c.lto != nil {
1606 deps = c.lto.deps(ctx, deps)
1607 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001608 for _, feature := range c.features {
1609 deps = feature.deps(ctx, deps)
1610 }
1611
Colin Crossb6715442017-10-24 11:13:31 -07001612 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1613 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1614 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1615 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1616 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1617 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001618 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001619
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001620 for _, lib := range deps.ReexportSharedLibHeaders {
1621 if !inList(lib, deps.SharedLibs) {
1622 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1623 }
1624 }
1625
1626 for _, lib := range deps.ReexportStaticLibHeaders {
1627 if !inList(lib, deps.StaticLibs) {
1628 ctx.PropertyErrorf("export_static_lib_headers", "Static library not in static_libs: '%s'", lib)
1629 }
1630 }
1631
Colin Cross5950f382016-12-13 12:50:57 -08001632 for _, lib := range deps.ReexportHeaderLibHeaders {
1633 if !inList(lib, deps.HeaderLibs) {
1634 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1635 }
1636 }
1637
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001638 for _, gen := range deps.ReexportGeneratedHeaders {
1639 if !inList(gen, deps.GeneratedHeaders) {
1640 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1641 }
1642 }
1643
Colin Crossc99deeb2016-04-11 15:06:20 -07001644 return deps
1645}
1646
Dan Albert7e9d2952016-08-04 13:02:36 -07001647func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001648 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001649 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001650 moduleContextImpl: moduleContextImpl{
1651 mod: c,
1652 },
1653 }
1654 ctx.ctx = ctx
1655
Colin Crossca860ac2016-01-04 14:34:37 -08001656 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001657}
1658
Jiyong Park7ed9de32018-10-15 22:25:07 +09001659// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001660func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001661 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1662 version := name[sharp+1:]
1663 libname := name[:sharp]
1664 return libname, version
1665 }
1666 return name, ""
1667}
1668
Dan Albert92fe7402020-07-15 13:33:30 -07001669func GetCrtVariations(ctx android.BottomUpMutatorContext,
1670 m LinkableInterface) []blueprint.Variation {
1671 if ctx.Os() != android.Android {
1672 return nil
1673 }
1674 if m.UseSdk() {
1675 return []blueprint.Variation{
1676 {Mutator: "sdk", Variation: "sdk"},
Colin Crossbbc941b2020-09-30 12:27:01 -07001677 {Mutator: "version", Variation: m.SdkVersion()},
Dan Albert92fe7402020-07-15 13:33:30 -07001678 }
1679 }
1680 return []blueprint.Variation{
1681 {Mutator: "sdk", Variation: ""},
1682 }
1683}
1684
Colin Crosse7257d22020-09-24 09:56:18 -07001685func (c *Module) addSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext,
1686 variations []blueprint.Variation, depTag libraryDependencyTag, name, version string, far bool) {
1687
1688 variations = append([]blueprint.Variation(nil), variations...)
1689
Colin Cross3146c5c2020-09-30 15:34:40 -07001690 if version != "" && CanBeOrLinkAgainstVersionVariants(c) {
Colin Crosse7257d22020-09-24 09:56:18 -07001691 // Version is explicitly specified. i.e. libFoo#30
1692 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
1693 depTag.explicitlyVersioned = true
1694 }
Colin Crosse7257d22020-09-24 09:56:18 -07001695
Colin Cross0de8a1e2020-09-18 14:15:30 -07001696 if far {
1697 ctx.AddFarVariationDependencies(variations, depTag, name)
1698 } else {
1699 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07001700 }
1701}
1702
Colin Cross1e676be2016-10-12 14:38:15 -07001703func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09001704 if !c.Enabled() {
1705 return
1706 }
1707
Colin Cross37047f12016-12-13 17:06:13 -08001708 ctx := &depsContext{
1709 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07001710 moduleContextImpl: moduleContextImpl{
1711 mod: c,
1712 },
1713 }
1714 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08001715
Colin Crossc99deeb2016-04-11 15:06:20 -07001716 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001717
Yo Chiang219968c2020-09-22 18:45:04 +08001718 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
1719
Dan Albert914449f2016-06-17 16:45:24 -07001720 variantNdkLibs := []string{}
1721 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07001722 if ctx.Os() == android.Android {
Inseob Kimeec88e12020-01-22 11:11:29 +09001723 // rewriteLibs takes a list of names of shared libraries and scans it for three types
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001724 // of names:
Dan Albert914449f2016-06-17 16:45:24 -07001725 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001726 // 1. Name of an NDK library that refers to a prebuilt module.
1727 // For each of these, it adds the name of the prebuilt module (which will be in
1728 // prebuilts/ndk) to the list of nonvariant libs.
1729 // 2. Name of an NDK library that refers to an ndk_library module.
1730 // For each of these, it adds the name of the ndk_library module to the list of
1731 // variant libs.
1732 // 3. Anything else (so anything that isn't an NDK library).
1733 // It adds these to the nonvariantLibs list.
Dan Albert914449f2016-06-17 16:45:24 -07001734 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001735 // The caller can then know to add the variantLibs dependencies differently from the
1736 // nonvariantLibs
Inseob Kim9516ee92019-05-09 10:56:13 +09001737
Inseob Kim9516ee92019-05-09 10:56:13 +09001738 vendorPublicLibraries := vendorPublicLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001739 vendorSnapshotSharedLibs := vendorSnapshotSharedLibs(actx.Config())
1740
1741 rewriteVendorLibs := func(lib string) string {
1742 if isLlndkLibrary(lib, ctx.Config()) {
1743 return lib + llndkLibrarySuffix
1744 }
1745
1746 // only modules with BOARD_VNDK_VERSION uses snapshot.
1747 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1748 return lib
1749 }
1750
1751 if snapshot, ok := vendorSnapshotSharedLibs.get(lib, actx.Arch().ArchType); ok {
1752 return snapshot
1753 }
1754
1755 return lib
1756 }
1757
1758 rewriteLibs := func(list []string) (nonvariantLibs []string, variantLibs []string) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001759 variantLibs = []string{}
1760 nonvariantLibs = []string{}
Dan Albert914449f2016-06-17 16:45:24 -07001761 for _, entry := range list {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001762 // strip #version suffix out
Jiyong Park73c54ee2019-10-22 20:31:18 +09001763 name, _ := StubsLibNameAndVersion(entry)
Dan Albertde5aade2020-06-30 12:32:51 -07001764 if ctx.useSdk() && inList(name, ndkKnownLibs) {
1765 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Inseob Kimeec88e12020-01-22 11:11:29 +09001766 } else if ctx.useVndk() {
1767 nonvariantLibs = append(nonvariantLibs, rewriteVendorLibs(entry))
Inseob Kim9516ee92019-05-09 10:56:13 +09001768 } else if (ctx.Platform() || ctx.ProductSpecific()) && inList(name, *vendorPublicLibraries) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001769 vendorPublicLib := name + vendorPublicLibrarySuffix
Jiyong Park374510b2018-03-19 18:23:01 +09001770 if actx.OtherModuleExists(vendorPublicLib) {
1771 nonvariantLibs = append(nonvariantLibs, vendorPublicLib)
1772 } else {
1773 // This can happen if vendor_public_library module is defined in a
1774 // namespace that isn't visible to the current module. In that case,
1775 // link to the original library.
Jiyong Park7ed9de32018-10-15 22:25:07 +09001776 nonvariantLibs = append(nonvariantLibs, name)
Jiyong Park374510b2018-03-19 18:23:01 +09001777 }
Dan Albert914449f2016-06-17 16:45:24 -07001778 } else {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001779 // put name#version back
Dan Willemsen7cbf5f82017-03-28 00:08:30 -07001780 nonvariantLibs = append(nonvariantLibs, entry)
Dan Willemsen72d39932016-07-08 23:23:48 -07001781 }
1782 }
Dan Albert914449f2016-06-17 16:45:24 -07001783 return nonvariantLibs, variantLibs
Dan Willemsen72d39932016-07-08 23:23:48 -07001784 }
1785
Inseob Kimeec88e12020-01-22 11:11:29 +09001786 deps.SharedLibs, variantNdkLibs = rewriteLibs(deps.SharedLibs)
1787 deps.LateSharedLibs, variantLateNdkLibs = rewriteLibs(deps.LateSharedLibs)
1788 deps.ReexportSharedLibHeaders, _ = rewriteLibs(deps.ReexportSharedLibHeaders)
1789 if ctx.useVndk() {
1790 for idx, lib := range deps.RuntimeLibs {
1791 deps.RuntimeLibs[idx] = rewriteVendorLibs(lib)
1792 }
1793 }
Dan Willemsen72d39932016-07-08 23:23:48 -07001794 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001795
Jiyong Park7e636d02019-01-28 16:16:54 +09001796 buildStubs := false
Colin Crossc88c2722020-09-28 17:32:47 -07001797 if versioned, ok := c.linker.(versionedInterface); ok {
1798 if versioned.buildStubs() {
1799 buildStubs = true
Colin Crossd48fe732020-09-23 20:37:24 -07001800 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001801 }
1802
Inseob Kimeec88e12020-01-22 11:11:29 +09001803 rewriteSnapshotLibs := func(lib string, snapshotMap *snapshotMap) string {
1804 // only modules with BOARD_VNDK_VERSION uses snapshot.
1805 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1806 return lib
1807 }
1808
1809 if snapshot, ok := snapshotMap.get(lib, actx.Arch().ArchType); ok {
1810 return snapshot
1811 }
1812
1813 return lib
1814 }
1815
1816 vendorSnapshotHeaderLibs := vendorSnapshotHeaderLibs(actx.Config())
Colin Cross32ec36c2016-12-15 07:39:51 -08001817 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001818 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08001819 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001820 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08001821 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001822
1823 lib = rewriteSnapshotLibs(lib, vendorSnapshotHeaderLibs)
1824
Jiyong Park7e636d02019-01-28 16:16:54 +09001825 if buildStubs {
Colin Cross7228ecd2019-11-18 16:00:16 -08001826 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001827 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09001828 } else {
1829 actx.AddVariationDependencies(nil, depTag, lib)
1830 }
1831 }
1832
1833 if buildStubs {
1834 // Stubs lib does not have dependency to other static/shared libraries.
1835 // Don't proceed.
1836 return
Colin Cross32ec36c2016-12-15 07:39:51 -08001837 }
Colin Cross5950f382016-12-13 12:50:57 -08001838
Inseob Kimc0907f12019-02-08 21:00:45 +09001839 syspropImplLibraries := syspropImplLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001840 vendorSnapshotStaticLibs := vendorSnapshotStaticLibs(actx.Config())
Inseob Kimc0907f12019-02-08 21:00:45 +09001841
Jiyong Park5d1598f2019-02-25 22:14:17 +09001842 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001843 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09001844 if impl, ok := syspropImplLibraries[lib]; ok {
1845 lib = impl
1846 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001847
1848 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1849
Jiyong Park5d1598f2019-02-25 22:14:17 +09001850 actx.AddVariationDependencies([]blueprint.Variation{
1851 {Mutator: "link", Variation: "static"},
1852 }, depTag, lib)
1853 }
1854
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001855 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001856 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001857 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001858 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001859 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001860
1861 if impl, ok := syspropImplLibraries[lib]; ok {
1862 lib = impl
1863 }
1864
Inseob Kimeec88e12020-01-22 11:11:29 +09001865 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1866
Dan Willemsen59339a22018-07-22 21:18:45 -07001867 actx.AddVariationDependencies([]blueprint.Variation{
1868 {Mutator: "link", Variation: "static"},
1869 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001870 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001871
Jooyung Han75568392020-03-20 04:29:24 +09001872 // staticUnwinderDep is treated as staticDep for Q apexes
1873 // so that native libraries/binaries are linked with static unwinder
1874 // because Q libc doesn't have unwinder APIs
1875 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07001876 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001877 actx.AddVariationDependencies([]blueprint.Variation{
1878 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001879 }, depTag, rewriteSnapshotLibs(staticUnwinder(actx), vendorSnapshotStaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001880 }
1881
Inseob Kimeec88e12020-01-22 11:11:29 +09001882 for _, lib := range deps.LateStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001883 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Inseob Kimeec88e12020-01-22 11:11:29 +09001884 actx.AddVariationDependencies([]blueprint.Variation{
1885 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001886 }, depTag, rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs))
Inseob Kimeec88e12020-01-22 11:11:29 +09001887 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001888
Jiyong Park7ed9de32018-10-15 22:25:07 +09001889 // shared lib names without the #version suffix
1890 var sharedLibNames []string
1891
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001892 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001893 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001894 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001895 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001896 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001897
1898 if impl, ok := syspropImplLibraries[lib]; ok {
1899 lib = impl
1900 }
1901
Jiyong Park73c54ee2019-10-22 20:31:18 +09001902 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09001903 sharedLibNames = append(sharedLibNames, name)
1904
Colin Crosse7257d22020-09-24 09:56:18 -07001905 variations := []blueprint.Variation{
1906 {Mutator: "link", Variation: "shared"},
1907 }
1908 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001909 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001910
Jiyong Park7ed9de32018-10-15 22:25:07 +09001911 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09001912 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001913 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
1914 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
1915 // linking against both the stubs lib and the non-stubs lib at the same time.
1916 continue
1917 }
Colin Cross6e511a92020-07-27 21:26:48 -07001918 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07001919 variations := []blueprint.Variation{
1920 {Mutator: "link", Variation: "shared"},
1921 }
1922 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001923 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001924
Dan Willemsen59339a22018-07-22 21:18:45 -07001925 actx.AddVariationDependencies([]blueprint.Variation{
1926 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04001927 }, dataLibDepTag, deps.DataLibs...)
1928
1929 actx.AddVariationDependencies([]blueprint.Variation{
1930 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07001931 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08001932
Colin Cross68861832016-07-08 10:41:41 -07001933 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001934
1935 for _, gen := range deps.GeneratedHeaders {
1936 depTag := genHeaderDepTag
1937 if inList(gen, deps.ReexportGeneratedHeaders) {
1938 depTag = genHeaderExportDepTag
1939 }
1940 actx.AddDependency(c, depTag, gen)
1941 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07001942
Inseob Kim1042d292020-06-01 23:23:05 +09001943 vendorSnapshotObjects := vendorSnapshotObjects(actx.Config())
1944
Dan Albert92fe7402020-07-15 13:33:30 -07001945 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07001946 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc99deeb2016-04-11 15:06:20 -07001947 if deps.CrtBegin != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07001948 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
1949 rewriteSnapshotLibs(deps.CrtBegin, vendorSnapshotObjects))
Colin Crossca860ac2016-01-04 14:34:37 -08001950 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001951 if deps.CrtEnd != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07001952 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
1953 rewriteSnapshotLibs(deps.CrtEnd, vendorSnapshotObjects))
Colin Cross21b9a242015-03-24 14:15:58 -07001954 }
Dan Willemsena0790e32018-10-12 00:24:23 -07001955 if deps.LinkerFlagsFile != "" {
1956 actx.AddDependency(c, linkerFlagsDepTag, deps.LinkerFlagsFile)
1957 }
1958 if deps.DynamicLinker != "" {
1959 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07001960 }
Dan Albert914449f2016-06-17 16:45:24 -07001961
1962 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07001963
1964 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07001965 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07001966 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07001967 {Mutator: "link", Variation: "shared"},
1968 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07001969
1970 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07001971 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07001972 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07001973 {Mutator: "link", Variation: "shared"},
1974 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08001975
1976 if vndkdep := c.vndkdep; vndkdep != nil {
1977 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08001978 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08001979 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07001980 {Mutator: "link", Variation: "shared"},
1981 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08001982 }
1983 }
Colin Cross6362e272015-10-29 15:25:03 -07001984}
Colin Cross21b9a242015-03-24 14:15:58 -07001985
Colin Crosse40b4ea2018-10-02 22:25:58 -07001986func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07001987 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
1988 c.beginMutator(ctx)
1989 }
1990}
1991
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001992// Whether a module can link to another module, taking into
1993// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09001994func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07001995 tag blueprint.DependencyTag) {
1996
1997 switch t := tag.(type) {
1998 case dependencyTag:
1999 if t != vndkExtDepTag {
2000 return
2001 }
2002 case libraryDependencyTag:
2003 default:
2004 return
2005 }
2006
Ivan Lozano52767be2019-10-18 14:49:46 -07002007 if from.Module().Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002008 // Host code is not restricted
2009 return
2010 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002011
2012 // VNDK is cc.Module supported only for now.
2013 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002014 // Though allowed dependency is limited by the image mutator,
2015 // each vendor and product module needs to check link-type
2016 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002017 if ccTo, ok := to.(*Module); ok {
2018 if ccFrom.vndkdep != nil {
2019 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2020 }
2021 } else {
2022 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002023 }
2024 return
2025 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002026 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002027 // Platform code can link to anything
2028 return
2029 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002030 if from.InRamdisk() {
2031 // Ramdisk code is not NDK
2032 return
2033 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002034 if from.InVendorRamdisk() {
2035 // Vendor ramdisk code is not NDK
2036 return
2037 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002038 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002039 // Recovery code is not NDK
2040 return
2041 }
Colin Cross31076b32020-10-23 17:22:06 -07002042 if c, ok := to.(*Module); ok {
2043 if c.ToolchainLibrary() {
2044 // These are always allowed
2045 return
2046 }
2047 if c.NdkPrebuiltStl() {
2048 // These are allowed, but they don't set sdk_version
2049 return
2050 }
2051 if c.StubDecorator() {
2052 // These aren't real libraries, but are the stub shared libraries that are included in
2053 // the NDK.
2054 return
2055 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002056 }
Logan Chien834b9a62019-01-14 15:39:03 +08002057
Ivan Lozano52767be2019-10-18 14:49:46 -07002058 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002059 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2060 // to link to libc++ (non-NDK and without sdk_version).
2061 return
2062 }
2063
Ivan Lozano52767be2019-10-18 14:49:46 -07002064 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002065 // NDK code linking to platform code is never okay.
2066 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002067 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002068 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002069 }
2070
2071 // At this point we know we have two NDK libraries, but we need to
2072 // check that we're not linking against anything built against a higher
2073 // API level, as it is only valid to link against older or equivalent
2074 // APIs.
2075
Inseob Kim01a28722018-04-11 09:48:45 +09002076 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002077 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002078 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002079 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002080 // Current can't be linked against by anything else.
2081 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002082 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002083 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002084 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002085 if err != nil {
2086 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002087 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002088 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002089 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002090 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002091 if err != nil {
2092 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002093 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002094 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002095 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002096
Inseob Kim01a28722018-04-11 09:48:45 +09002097 if toApi > fromApi {
2098 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002099 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002100 }
2101 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002102 }
Dan Albert202fe492017-12-15 13:56:59 -08002103
2104 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002105 fromStl := from.SelectedStl()
2106 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002107 if fromStl == "" || toStl == "" {
2108 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002109 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002110 // We can be permissive with the system "STL" since it is only the C++
2111 // ABI layer, but in the future we should make sure that everyone is
2112 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002113 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002114 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002115 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2116 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002117 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002118}
2119
Jooyung Han479ca172020-10-19 18:51:07 +09002120func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2121 if c, ok := ctx.Module().(*Module); ok {
2122 ctx.VisitDirectDeps(func(dep android.Module) {
2123 depTag := ctx.OtherModuleDependencyTag(dep)
2124 ccDep, ok := dep.(LinkableInterface)
2125 if ok {
2126 checkLinkType(ctx, c, ccDep, depTag)
2127 }
2128 })
2129 }
2130}
2131
Jiyong Park5fb8c102018-04-09 12:03:06 +09002132// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002133// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2134// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002135// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002136func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2137 check := func(child, parent android.Module) bool {
2138 to, ok := child.(*Module)
2139 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002140 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002141 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002142
Jooyung Hana70f0672019-01-18 15:20:43 +09002143 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2144 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002145 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002146
Justin Yun63e9ec72020-10-29 16:49:43 +09002147 // Even if target lib has no vendor variant, keep checking dependency
2148 // graph in case it depends on vendor_available or product_available
2149 // but not double_loadable transtively.
2150 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002151 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002152 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002153
Jooyung Han0302a842019-10-30 18:43:49 +09002154 if to.isVndkSp() || to.isLlndk(ctx.Config()) || Bool(to.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002155 return false
2156 }
2157
2158 var stringPath []string
2159 for _, m := range ctx.GetWalkPath() {
2160 stringPath = append(stringPath, m.Name())
2161 }
2162 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2163 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
2164 "(dependency: %s)", ctx.OtherModuleName(to), strings.Join(stringPath, " -> "))
2165 return false
2166 }
2167 if module, ok := ctx.Module().(*Module); ok {
2168 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jooyung Han0302a842019-10-30 18:43:49 +09002169 if module.isLlndk(ctx.Config()) || Bool(module.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002170 ctx.WalkDeps(check)
2171 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002172 }
2173 }
2174}
2175
Colin Cross0de8a1e2020-09-18 14:15:30 -07002176// Returns the highest version which is <= maxSdkVersion.
2177// For example, with maxSdkVersion is 10 and versionList is [9,11]
2178// it returns 9 as string. The list of stubs must be in order from
2179// oldest to newest.
2180func (c *Module) chooseSdkVersion(ctx android.PathContext, stubsInfo []SharedLibraryStubsInfo,
2181 maxSdkVersion android.ApiLevel) (SharedLibraryStubsInfo, error) {
2182
2183 for i := range stubsInfo {
2184 stubInfo := stubsInfo[len(stubsInfo)-i-1]
2185 var ver android.ApiLevel
2186 if stubInfo.Version == "" {
2187 ver = android.FutureApiLevel
2188 } else {
2189 var err error
2190 ver, err = android.ApiLevelFromUser(ctx, stubInfo.Version)
2191 if err != nil {
2192 return SharedLibraryStubsInfo{}, err
2193 }
2194 }
2195 if ver.LessThanOrEqualTo(maxSdkVersion) {
2196 return stubInfo, nil
2197 }
2198 }
2199 var versionList []string
2200 for _, stubInfo := range stubsInfo {
2201 versionList = append(versionList, stubInfo.Version)
2202 }
2203 return SharedLibraryStubsInfo{}, fmt.Errorf("not found a version(<=%s) in versionList: %v", maxSdkVersion.String(), versionList)
2204}
2205
Colin Crossc99deeb2016-04-11 15:06:20 -07002206// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002207func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002208 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002209
Colin Cross0de8a1e2020-09-18 14:15:30 -07002210 var directStaticDeps []StaticLibraryInfo
2211 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002212
Colin Cross0de8a1e2020-09-18 14:15:30 -07002213 reexportExporter := func(exporter FlagExporterInfo) {
2214 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2215 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2216 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2217 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2218 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002219 }
2220
Jooyung Hande34d232020-07-23 13:04:15 +09002221 // For the dependency from platform to apex, use the latest stubs
2222 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002223 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2224 if !apexInfo.IsForPlatform() {
2225 c.apexSdkVersion = apexInfo.MinSdkVersion(ctx)
Jooyung Hande34d232020-07-23 13:04:15 +09002226 }
2227
2228 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2229 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2230 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2231 // (b/144430859)
2232 c.apexSdkVersion = android.FutureApiLevel
2233 }
2234
Colin Crossd11fcda2017-10-23 17:59:01 -07002235 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002236 depName := ctx.OtherModuleName(dep)
2237 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002238
Ivan Lozano52767be2019-10-18 14:49:46 -07002239 ccDep, ok := dep.(LinkableInterface)
2240 if !ok {
2241
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002242 // handling for a few module types that aren't cc Module but that are also supported
2243 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002244 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002245 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002246 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2247 genRule.GeneratedSourceFiles()...)
2248 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002249 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002250 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002251 // Support exported headers from a generated_sources dependency
2252 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002253 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002254 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002255 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002256 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002257 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002258 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002259 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002260 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002261 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2262 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002263 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002264 // 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 +09002265 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002266
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002267 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002268 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002269 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002270 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002271 case linkerFlagsDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002272 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002273 files := genRule.GeneratedSourceFiles()
2274 if len(files) == 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002275 depPaths.LinkerFlagsFile = android.OptionalPathForPath(files[0])
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002276 } else if len(files) > 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002277 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 -07002278 }
2279 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002280 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002281 }
Colin Crossca860ac2016-01-04 14:34:37 -08002282 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002283 return
2284 }
2285
Colin Crossfe17f6f2019-03-28 19:30:56 -07002286 if depTag == android.ProtoPluginDepTag {
2287 return
2288 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002289 if depTag == llndkImplDep {
2290 return
2291 }
Colin Crossfe17f6f2019-03-28 19:30:56 -07002292
Colin Crossd11fcda2017-10-23 17:59:01 -07002293 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002294 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2295 return
2296 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002297 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002298 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2299 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002300 return
2301 }
2302
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002303 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002304 // Skip reused objects for stub libraries, they use their own stub object file instead.
2305 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2306 // version mutator, so the stubs variant is created from the shared variant that
2307 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002308 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002309 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2310 objs := staticAnalogue.ReuseObjects
2311 depPaths.Objs = depPaths.Objs.Append(objs)
2312 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2313 reexportExporter(depExporterInfo)
2314 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002315 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002316 }
2317
Colin Cross6e511a92020-07-27 21:26:48 -07002318 linkFile := ccDep.OutputFile()
2319
2320 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2321 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002322 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002323 return
2324 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002325
Colin Cross0de8a1e2020-09-18 14:15:30 -07002326 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002327
Colin Cross6e511a92020-07-27 21:26:48 -07002328 var ptr *android.Paths
2329 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002330
Colin Cross6e511a92020-07-27 21:26:48 -07002331 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002332
Colin Cross6e511a92020-07-27 21:26:48 -07002333 switch {
2334 case libDepTag.header():
2335 // nothing
2336 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002337 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2338 if !ctx.Config().AllowMissingDependencies() {
2339 ctx.ModuleErrorf("module %q is not a shared library", depName)
2340 } else {
2341 ctx.AddMissingDependencies([]string{depName})
2342 }
2343 return
2344 }
2345 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2346 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryImplementationStubsInfoProvider).(SharedLibraryImplementationStubsInfo)
2347
2348 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedLibraryStubsInfos) > 0 {
2349 useStubs := false
Colin Cross31076b32020-10-23 17:22:06 -07002350
2351 if lib := moduleLibraryInterface(dep); lib.buildStubs() && c.UseVndk() { // LLNDK
Colin Cross0de8a1e2020-09-18 14:15:30 -07002352 if !apexInfo.IsForPlatform() {
2353 // For platform libraries, use current version of LLNDK
2354 // If this is for use_vendor apex we will apply the same rules
2355 // of apex sdk enforcement below to choose right version.
2356 useStubs = true
2357 }
2358 } else if apexInfo.IsForPlatform() {
2359 // If not building for APEX, use stubs only when it is from
2360 // an APEX (and not from platform)
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002361 // However, for host, ramdisk, vendor_ramdisk, recovery or bootstrap modules,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002362 // always link to non-stub variant
2363 useStubs = dep.(android.ApexModule).AnyVariantDirectlyInAnyApex() && !c.bootstrap()
2364 // Another exception: if this module is bundled with an APEX, then
2365 // it is linked with the non-stub variant of a module in the APEX
2366 // as if this is part of the APEX.
2367 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2368 for _, apexContents := range testFor.ApexContents {
2369 if apexContents.DirectlyInApex(depName) {
2370 useStubs = false
2371 break
2372 }
2373 }
2374 } else {
2375 // If building for APEX, use stubs when the parent is in any APEX that
2376 // the child is not in.
2377 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2378 }
2379
2380 // when to use (unspecified) stubs, check min_sdk_version and choose the right one
2381 if useStubs {
2382 sharedLibraryStubsInfo, err :=
2383 c.chooseSdkVersion(ctx, sharedLibraryStubsInfo.SharedLibraryStubsInfos, c.apexSdkVersion)
2384 if err != nil {
2385 ctx.OtherModuleErrorf(dep, err.Error())
2386 return
2387 }
2388 sharedLibraryInfo = sharedLibraryStubsInfo.SharedLibraryInfo
2389 depExporterInfo = sharedLibraryStubsInfo.FlagExporterInfo
2390 }
2391 }
2392
2393 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2394 depFile = sharedLibraryInfo.TableOfContents
2395
Colin Cross6e511a92020-07-27 21:26:48 -07002396 ptr = &depPaths.SharedLibs
2397 switch libDepTag.Order {
2398 case earlyLibraryDependency:
2399 ptr = &depPaths.EarlySharedLibs
2400 depPtr = &depPaths.EarlySharedLibsDeps
2401 case normalLibraryDependency:
2402 ptr = &depPaths.SharedLibs
2403 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002404 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002405 case lateLibraryDependency:
2406 ptr = &depPaths.LateSharedLibs
2407 depPtr = &depPaths.LateSharedLibsDeps
2408 default:
2409 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002410 }
Colin Cross6e511a92020-07-27 21:26:48 -07002411 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002412 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2413 if !ctx.Config().AllowMissingDependencies() {
2414 ctx.ModuleErrorf("module %q is not a static library", depName)
2415 } else {
2416 ctx.AddMissingDependencies([]string{depName})
2417 }
2418 return
2419 }
2420 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2421 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002422 if libDepTag.wholeStatic {
2423 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002424 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2425 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002426 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002427 // This case normally catches prebuilt static
2428 // libraries, but it can also occur when
2429 // AllowMissingDependencies is on and the
2430 // dependencies has no sources of its own
2431 // but has a whole_static_libs dependency
2432 // on a missing library. We want to depend
2433 // on the .a file so that there is something
2434 // in the dependency tree that contains the
2435 // error rule for the missing transitive
2436 // dependency.
2437 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002438 }
Colin Cross6e511a92020-07-27 21:26:48 -07002439 } else {
2440 switch libDepTag.Order {
2441 case earlyLibraryDependency:
2442 panic(fmt.Errorf("early static libs not suppported"))
2443 case normalLibraryDependency:
2444 // static dependencies will be handled separately so they can be ordered
2445 // using transitive dependencies.
2446 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002447 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002448 case lateLibraryDependency:
2449 ptr = &depPaths.LateStaticLibs
2450 default:
2451 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002452 }
2453 }
2454 }
2455
Colin Cross6e511a92020-07-27 21:26:48 -07002456 if libDepTag.static() && !libDepTag.wholeStatic {
2457 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2458 ctx.ModuleErrorf("module %q not a static library", depName)
2459 return
2460 }
Logan Chien43d34c32017-12-20 01:17:32 +08002461
Colin Cross6e511a92020-07-27 21:26:48 -07002462 // When combining coverage files for shared libraries and executables, coverage files
2463 // in static libraries act as if they were whole static libraries. The same goes for
2464 // source based Abi dump files.
2465 if c, ok := ccDep.(*Module); ok {
2466 staticLib := c.linker.(libraryInterface)
2467 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2468 staticLib.objs().coverageFiles...)
2469 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2470 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002471 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002472 // Handle non-CC modules here
2473 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002474 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002475 }
2476 }
2477
Colin Cross6e511a92020-07-27 21:26:48 -07002478 if ptr != nil {
2479 if !linkFile.Valid() {
2480 if !ctx.Config().AllowMissingDependencies() {
2481 ctx.ModuleErrorf("module %q missing output file", depName)
2482 } else {
2483 ctx.AddMissingDependencies([]string{depName})
2484 }
2485 return
2486 }
2487 *ptr = append(*ptr, linkFile.Path())
2488 }
2489
2490 if depPtr != nil {
2491 dep := depFile
2492 if !dep.Valid() {
2493 dep = linkFile
2494 }
2495 *depPtr = append(*depPtr, dep.Path())
2496 }
2497
Colin Cross0de8a1e2020-09-18 14:15:30 -07002498 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2499 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2500 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2501 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2502
2503 if libDepTag.reexportFlags {
2504 reexportExporter(depExporterInfo)
2505 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2506 // Re-exported shared library headers must be included as well since they can help us with type information
2507 // about template instantiations (instantiated from their headers).
2508 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2509 // scripts.
2510 c.sabi.Properties.ReexportedIncludes = append(
2511 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2512 }
2513
Colin Cross6e511a92020-07-27 21:26:48 -07002514 makeLibName := c.makeLibName(ctx, ccDep, depName) + libDepTag.makeSuffix
2515 switch {
2516 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002517 c.Properties.AndroidMkHeaderLibs = append(
2518 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002519 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002520 if lib := moduleLibraryInterface(dep); lib != nil {
2521 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002522 // Add the dependency to the APEX(es) providing the library so that
2523 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002524 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
2525 for _, an := range depApexInfo.InApexes {
Colin Cross6e511a92020-07-27 21:26:48 -07002526 c.Properties.ApexesProvidingSharedLibs = append(
2527 c.Properties.ApexesProvidingSharedLibs, an)
2528 }
2529 }
2530 }
2531
2532 // Note: the order of libs in this list is not important because
2533 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002534 c.Properties.AndroidMkSharedLibs = append(
2535 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002536 // Record baseLibName for snapshots.
2537 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, baseLibName(depName))
2538 case libDepTag.static():
2539 if libDepTag.wholeStatic {
2540 c.Properties.AndroidMkWholeStaticLibs = append(
2541 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2542 } else {
2543 c.Properties.AndroidMkStaticLibs = append(
2544 c.Properties.AndroidMkStaticLibs, makeLibName)
2545 }
2546 }
2547 } else {
2548 switch depTag {
2549 case runtimeDepTag:
2550 c.Properties.AndroidMkRuntimeLibs = append(
2551 c.Properties.AndroidMkRuntimeLibs, c.makeLibName(ctx, ccDep, depName)+libDepTag.makeSuffix)
2552 // Record baseLibName for snapshots.
2553 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, baseLibName(depName))
2554 case objDepTag:
2555 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2556 case CrtBeginDepTag:
2557 depPaths.CrtBegin = linkFile
2558 case CrtEndDepTag:
2559 depPaths.CrtEnd = linkFile
2560 case dynamicLinkerDepTag:
2561 depPaths.DynamicLinker = linkFile
2562 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002563 }
Colin Crossca860ac2016-01-04 14:34:37 -08002564 })
2565
Jeff Gaston294356f2017-09-27 17:05:30 -07002566 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002567 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2568 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2569 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002570
Colin Crossdd84e052017-05-17 13:44:16 -07002571 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002572 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002573 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2574 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002575 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002576 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2577 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002578 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002579 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002580 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002581
2582 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002583 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002584 }
Colin Crossdd84e052017-05-17 13:44:16 -07002585
Colin Crossca860ac2016-01-04 14:34:37 -08002586 return depPaths
2587}
2588
Colin Cross0de8a1e2020-09-18 14:15:30 -07002589// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2590// to match the topological order of the dependency tree, including any static analogues of
2591// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2592// of the transitive dependencies.
2593func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2594 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2595 var staticPaths android.Paths
2596 for _, staticDep := range staticDeps {
2597 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2598 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2599 }
2600 for _, sharedDep := range sharedDeps {
2601 if sharedDep.StaticAnalogue != nil {
2602 transitiveStaticLibsBuilder.Transitive(sharedDep.StaticAnalogue.TransitiveStaticLibrariesForOrdering)
2603 }
2604 }
2605 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2606
2607 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2608
2609 // reorder the dependencies based on transitive dependencies
2610 staticPaths = android.FirstUniquePaths(staticPaths)
2611 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2612
2613 if len(orderedStaticPaths) != len(staticPaths) {
2614 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2615 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2616 }
2617
2618 return orderedStaticPaths, transitiveStaticLibs
2619}
2620
Colin Cross6e511a92020-07-27 21:26:48 -07002621// baseLibName trims known prefixes and suffixes
2622func baseLibName(depName string) string {
2623 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
2624 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
2625 libName = strings.TrimPrefix(libName, "prebuilt_")
2626 return libName
2627}
2628
2629func (c *Module) makeLibName(ctx android.ModuleContext, ccDep LinkableInterface, depName string) string {
2630 vendorSuffixModules := vendorSuffixModules(ctx.Config())
2631 vendorPublicLibraries := vendorPublicLibraries(ctx.Config())
2632
2633 libName := baseLibName(depName)
2634 isLLndk := isLlndkLibrary(libName, ctx.Config())
2635 isVendorPublicLib := inList(libName, *vendorPublicLibraries)
2636 bothVendorAndCoreVariantsExist := ccDep.HasVendorVariant() || isLLndk
2637
2638 if c, ok := ccDep.(*Module); ok {
2639 // Use base module name for snapshots when exporting to Makefile.
2640 if c.isSnapshotPrebuilt() {
2641 baseName := c.BaseModuleName()
2642
2643 if c.IsVndk() {
2644 return baseName + ".vendor"
2645 }
2646
2647 if vendorSuffixModules[baseName] {
2648 return baseName + ".vendor"
2649 } else {
2650 return baseName
2651 }
2652 }
2653 }
2654
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002655 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
2656 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07002657 // The vendor module is a no-vendor-variant VNDK library. Depend on the
2658 // core module instead.
2659 return libName
2660 } else if c.UseVndk() && bothVendorAndCoreVariantsExist {
2661 // The vendor module in Make will have been renamed to not conflict with the core
2662 // module, so update the dependency name here accordingly.
2663 return libName + c.getNameSuffixWithVndkVersion(ctx)
2664 } else if (ctx.Platform() || ctx.ProductSpecific()) && isVendorPublicLib {
2665 return libName + vendorPublicLibrarySuffix
2666 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
2667 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002668 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
2669 return libName + vendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002670 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
2671 return libName + recoverySuffix
2672 } else if ccDep.Module().Target().NativeBridge == android.NativeBridgeEnabled {
2673 return libName + nativeBridgeSuffix
2674 } else {
2675 return libName
2676 }
2677}
2678
Colin Crossca860ac2016-01-04 14:34:37 -08002679func (c *Module) InstallInData() bool {
2680 if c.installer == nil {
2681 return false
2682 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002683 return c.installer.inData()
2684}
2685
2686func (c *Module) InstallInSanitizerDir() bool {
2687 if c.installer == nil {
2688 return false
2689 }
2690 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07002691 return true
2692 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002693 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08002694}
2695
Yifan Hong1b3348d2020-01-21 15:53:22 -08002696func (c *Module) InstallInRamdisk() bool {
2697 return c.InRamdisk()
2698}
2699
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002700func (c *Module) InstallInVendorRamdisk() bool {
2701 return c.InVendorRamdisk()
2702}
2703
Jiyong Parkf9332f12018-02-01 00:54:12 +09002704func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07002705 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09002706}
2707
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002708func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002709 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002710 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002711 return
2712 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002713 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002714}
2715
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07002716func (c *Module) HostToolPath() android.OptionalPath {
2717 if c.installer == nil {
2718 return android.OptionalPath{}
2719 }
2720 return c.installer.hostToolPath()
2721}
2722
Nan Zhangd4e641b2017-07-12 12:55:28 -07002723func (c *Module) IntermPathForModuleOut() android.OptionalPath {
2724 return c.outputFile
2725}
2726
Colin Cross41955e82019-05-29 14:40:35 -07002727func (c *Module) OutputFiles(tag string) (android.Paths, error) {
2728 switch tag {
2729 case "":
2730 if c.outputFile.Valid() {
2731 return android.Paths{c.outputFile.Path()}, nil
2732 }
2733 return android.Paths{}, nil
2734 default:
2735 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002736 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002737}
2738
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00002739func (c *Module) static() bool {
2740 if static, ok := c.linker.(interface {
2741 static() bool
2742 }); ok {
2743 return static.static()
2744 }
2745 return false
2746}
2747
Jiyong Park379de2f2018-12-19 02:47:14 +09002748func (c *Module) staticBinary() bool {
2749 if static, ok := c.linker.(interface {
2750 staticBinary() bool
2751 }); ok {
2752 return static.staticBinary()
2753 }
2754 return false
2755}
2756
Jiyong Park1d1119f2019-07-29 21:27:18 +09002757func (c *Module) header() bool {
2758 if h, ok := c.linker.(interface {
2759 header() bool
2760 }); ok {
2761 return h.header()
2762 }
2763 return false
2764}
2765
Inseob Kim7f283f42020-06-01 21:53:49 +09002766func (c *Module) binary() bool {
2767 if b, ok := c.linker.(interface {
2768 binary() bool
2769 }); ok {
2770 return b.binary()
2771 }
2772 return false
2773}
2774
Inseob Kim1042d292020-06-01 23:23:05 +09002775func (c *Module) object() bool {
2776 if o, ok := c.linker.(interface {
2777 object() bool
2778 }); ok {
2779 return o.object()
2780 }
2781 return false
2782}
2783
Jooyung Han38002912019-05-16 04:01:54 +09002784func (c *Module) getMakeLinkType(actx android.ModuleContext) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07002785 if c.UseVndk() {
Jooyung Han38002912019-05-16 04:01:54 +09002786 if lib, ok := c.linker.(*llndkStubDecorator); ok {
2787 if Bool(lib.Properties.Vendor_available) {
Colin Crossb60190a2018-09-04 16:28:17 -07002788 return "native:vndk"
2789 }
Jooyung Han38002912019-05-16 04:01:54 +09002790 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07002791 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002792 if c.IsVndk() && !c.isVndkExt() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002793 // Product_available, if defined, must have the same value with Vendor_available.
Jooyung Han38002912019-05-16 04:01:54 +09002794 if Bool(c.VendorProperties.Vendor_available) {
2795 return "native:vndk"
2796 }
2797 return "native:vndk_private"
2798 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09002799 if c.inProduct() {
2800 return "native:product"
2801 }
Jooyung Han38002912019-05-16 04:01:54 +09002802 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08002803 } else if c.InRamdisk() {
2804 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002805 } else if c.InVendorRamdisk() {
2806 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07002807 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07002808 return "native:recovery"
2809 } else if c.Target().Os == android.Android && String(c.Properties.Sdk_version) != "" {
2810 return "native:ndk:none:none"
2811 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
2812 //family, link := getNdkStlFamilyAndLinkType(c)
2813 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07002814 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08002815 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07002816 } else {
2817 return "native:platform"
2818 }
2819}
2820
Jiyong Park9d452992018-10-03 00:38:19 +09002821// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01002822// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09002823func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07002824 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09002825 // Stub libs and prebuilt libs in a versioned SDK are not
2826 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07002827 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01002828 } else if _, ok := c.linker.(testPerSrc); ok {
2829 return true
Jiyong Park9d452992018-10-03 00:38:19 +09002830 }
2831 return false
2832}
2833
Jiyong Parka90ca002019-10-07 15:47:24 +09002834func (c *Module) AvailableFor(what string) bool {
2835 if linker, ok := c.linker.(interface {
2836 availableFor(string) bool
2837 }); ok {
2838 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
2839 } else {
2840 return c.ApexModuleBase.AvailableFor(what)
2841 }
2842}
2843
Jiyong Park62304bb2020-04-13 16:19:48 +09002844func (c *Module) TestFor() []string {
2845 if test, ok := c.linker.(interface {
2846 testFor() []string
2847 }); ok {
2848 return test.testFor()
2849 } else {
2850 return c.ApexModuleBase.TestFor()
2851 }
2852}
2853
Colin Crossaede88c2020-08-11 12:17:01 -07002854func (c *Module) UniqueApexVariations() bool {
2855 if u, ok := c.compiler.(interface {
2856 uniqueApexVariations() bool
2857 }); ok {
2858 return u.uniqueApexVariations()
2859 } else {
2860 return false
2861 }
2862}
2863
Paul Duffin0cb37b92020-03-04 14:52:46 +00002864// Return true if the module is ever installable.
2865func (c *Module) EverInstallable() bool {
2866 return c.installer != nil &&
2867 // Check to see whether the module is actually ever installable.
2868 c.installer.everInstallable()
2869}
2870
Colin Cross56a83212020-09-15 18:30:11 -07002871func (c *Module) installable(apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00002872 ret := c.EverInstallable() &&
2873 // Check to see whether the module has been configured to not be installed.
2874 proptools.BoolDefault(c.Properties.Installable, true) &&
2875 !c.Properties.PreventInstall && c.outputFile.Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002876
2877 // The platform variant doesn't need further condition. Apex variants however might not
2878 // be installable because it will likely to be included in the APEX and won't appear
2879 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07002880 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002881 return ret
2882 }
2883
2884 // Special case for modules that are configured to be installed to /data, which includes
2885 // test modules. For these modules, both APEX and non-APEX variants are considered as
2886 // installable. This is because even the APEX variants won't be included in the APEX, but
2887 // will anyway be installed to /data/*.
2888 // See b/146995717
2889 if c.InstallInData() {
2890 return ret
2891 }
2892
2893 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09002894}
2895
Logan Chien41eabe62019-04-10 13:33:58 +08002896func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
2897 if c.linker != nil {
2898 if library, ok := c.linker.(*libraryDecorator); ok {
2899 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
2900 }
2901 }
2902}
2903
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002904func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07002905 depTag := ctx.OtherModuleDependencyTag(dep)
2906 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
2907
2908 if cc, ok := dep.(*Module); ok {
2909 if cc.HasStubsVariants() {
2910 if isLibDepTag && libDepTag.shared() {
2911 // dynamic dep to a stubs lib crosses APEX boundary
2912 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002913 }
Colin Cross6e511a92020-07-27 21:26:48 -07002914 if IsRuntimeDepTag(depTag) {
2915 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002916 return false
2917 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002918 }
Colin Crossaac32222020-07-29 12:51:56 -07002919 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07002920 // shared_lib dependency from a static lib is considered as crossing
2921 // the APEX boundary because the dependency doesn't actually is
2922 // linked; the dependency is used only during the compilation phase.
2923 return false
2924 }
2925 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002926 if depTag == stubImplDepTag || depTag == llndkImplDep {
2927 // We don't track beyond LLNDK or from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09002928 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002929 }
2930 return true
2931}
2932
Dan Albertc8060532020-07-22 22:32:17 -07002933func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2934 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09002935 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
2936 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
2937 return nil
2938 }
2939 // b/154569636: set min_sdk_version correctly for toolchain_libraries
2940 if c.ToolchainLibrary() {
2941 return nil
2942 }
2943 // We don't check for prebuilt modules
2944 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
2945 return nil
2946 }
2947 minSdkVersion := c.MinSdkVersion()
2948 if minSdkVersion == "apex_inherit" {
2949 return nil
2950 }
2951 if minSdkVersion == "" {
2952 // JNI libs within APK-in-APEX fall into here
2953 // Those are okay to set sdk_version instead
2954 // We don't have to check if this is a SDK variant because
2955 // non-SDK variant resets sdk_version, which works too.
2956 minSdkVersion = c.SdkVersion()
2957 }
Dan Albertc8060532020-07-22 22:32:17 -07002958 if minSdkVersion == "" {
2959 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
2960 }
2961 // Not using nativeApiLevelFromUser because the context here is not
2962 // necessarily a native context.
2963 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09002964 if err != nil {
2965 return err
2966 }
Dan Albertc8060532020-07-22 22:32:17 -07002967
2968 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09002969 return fmt.Errorf("newer SDK(%v)", ver)
2970 }
2971 return nil
2972}
2973
Colin Cross2ba19d92015-05-07 15:44:20 -07002974//
Colin Crosscfad1192015-11-02 16:43:11 -08002975// Defaults
2976//
Colin Crossca860ac2016-01-04 14:34:37 -08002977type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002978 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07002979 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09002980 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08002981}
2982
Patrice Arrudac249c712019-03-19 17:00:29 -07002983// cc_defaults provides a set of properties that can be inherited by other cc
2984// modules. A module can use the properties from a cc_defaults using
2985// `defaults: ["<:default_module_name>"]`. Properties of both modules are
2986// merged (when possible) by prepending the default module's values to the
2987// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07002988func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07002989 return DefaultsFactory()
2990}
2991
Colin Cross36242852017-06-23 15:06:31 -07002992func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08002993 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08002994
Colin Cross36242852017-06-23 15:06:31 -07002995 module.AddProperties(props...)
2996 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08002997 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002998 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08002999 &BaseCompilerProperties{},
3000 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003001 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003002 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003003 &StaticProperties{},
3004 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003005 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003006 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003007 &TestProperties{},
3008 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003009 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003010 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003011 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003012 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003013 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003014 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003015 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003016 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003017 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003018 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003019 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003020 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003021 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003022 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3023 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003024 )
Colin Crosscfad1192015-11-02 16:43:11 -08003025
Jooyung Hancc372c52019-09-25 15:18:44 +09003026 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003027
3028 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003029}
3030
Jiyong Park2286afd2020-06-16 21:58:53 +09003031func (c *Module) IsSdkVariant() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07003032 return c.Properties.IsSdkVariant || c.AlwaysSdk()
Jiyong Park2286afd2020-06-16 21:58:53 +09003033}
3034
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003035func kytheExtractAllFactory() android.Singleton {
3036 return &kytheExtractAllSingleton{}
3037}
3038
3039type kytheExtractAllSingleton struct {
3040}
3041
3042func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3043 var xrefTargets android.Paths
3044 ctx.VisitAllModules(func(module android.Module) {
3045 if ccModule, ok := module.(xref); ok {
3046 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3047 }
3048 })
3049 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3050 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003051 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003052 }
3053}
3054
Colin Cross06a931b2015-10-28 17:23:31 -07003055var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003056var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003057var BoolPtr = proptools.BoolPtr
3058var String = proptools.String
3059var StringPtr = proptools.StringPtr