blob: 8560042ca163351d2ee79e4bc845504c01d29a68 [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()
Jooyung Hanb90e4912019-12-09 18:21:48 +090048 ctx.BottomUp("ndk_api", NdkApiMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010049 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070050 ctx.BottomUp("version_selector", versionSelectorMutator).Parallel()
51 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070052 ctx.BottomUp("begin", BeginMutator).Parallel()
Inseob Kimac1e9862019-12-09 18:15:47 +090053 ctx.BottomUp("sysprop_cc", SyspropMutator).Parallel()
Inseob Kimeec88e12020-01-22 11:11:29 +090054 ctx.BottomUp("vendor_snapshot", VendorSnapshotMutator).Parallel()
55 ctx.BottomUp("vendor_snapshot_source", VendorSnapshotSourceMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070056 })
Colin Cross16b23492016-01-06 14:41:07 -080057
Paul Duffin036e7002019-12-19 19:16:28 +000058 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Cross1e676be2016-10-12 14:38:15 -070059 ctx.TopDown("asan_deps", sanitizerDepsMutator(asan))
60 ctx.BottomUp("asan", sanitizerMutator(asan)).Parallel()
Colin Cross16b23492016-01-06 14:41:07 -080061
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070062 ctx.TopDown("hwasan_deps", sanitizerDepsMutator(hwasan))
63 ctx.BottomUp("hwasan", sanitizerMutator(hwasan)).Parallel()
64
Mitch Phillipsbfeade62019-05-01 14:42:05 -070065 ctx.TopDown("fuzzer_deps", sanitizerDepsMutator(fuzzer))
66 ctx.BottomUp("fuzzer", sanitizerMutator(fuzzer)).Parallel()
67
Jiyong Park1d1119f2019-07-29 21:27:18 +090068 // cfi mutator shouldn't run before sanitizers that return true for
69 // incompatibleWithCfi()
Vishwath Mohanb743e9c2017-11-01 09:20:21 +000070 ctx.TopDown("cfi_deps", sanitizerDepsMutator(cfi))
71 ctx.BottomUp("cfi", sanitizerMutator(cfi)).Parallel()
72
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -080073 ctx.TopDown("scs_deps", sanitizerDepsMutator(scs))
74 ctx.BottomUp("scs", sanitizerMutator(scs)).Parallel()
75
Colin Cross1e676be2016-10-12 14:38:15 -070076 ctx.TopDown("tsan_deps", sanitizerDepsMutator(tsan))
77 ctx.BottomUp("tsan", sanitizerMutator(tsan)).Parallel()
Dan Willemsen581341d2017-02-09 16:16:31 -080078
Colin Cross0b908332019-06-19 23:00:20 -070079 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090080 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080081
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080082 ctx.BottomUp("coverage", coverageMutator).Parallel()
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -080083 ctx.TopDown("vndk_deps", sabiDepsMutator)
Stephen Craneba090d12017-05-09 15:44:35 -070084
85 ctx.TopDown("lto_deps", ltoDepsMutator)
86 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090087
88 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 Hong1b3348d2020-01-21 15:53:22 -0800258 // Make this module available when building for ramdisk
259 Ramdisk_available *bool
260
Jiyong Parkf9332f12018-02-01 00:54:12 +0900261 // Make this module available when building for recovery
262 Recovery_available *bool
263
Colin Crossae6c5202019-11-20 13:35:50 -0800264 // Set by imageMutator
Colin Cross7228ecd2019-11-18 16:00:16 -0800265 CoreVariantNeeded bool `blueprint:"mutated"`
Yifan Hong1b3348d2020-01-21 15:53:22 -0800266 RamdiskVariantNeeded bool `blueprint:"mutated"`
Colin Cross7228ecd2019-11-18 16:00:16 -0800267 RecoveryVariantNeeded bool `blueprint:"mutated"`
Justin Yun5f7f7e82019-11-18 19:52:14 +0900268 ExtraVariants []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900269
270 // Allows this module to use non-APEX version of libraries. Useful
271 // for building binaries that are started before APEXes are activated.
272 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900273
274 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
275 // see soong/cc/config/vndk.go
276 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900277
278 // Used by vendor snapshot to record dependencies from snapshot modules.
279 SnapshotSharedLibs []string `blueprint:"mutated"`
280 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000281
282 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000283
284 // Set by factories of module types that can only be referenced from variants compiled against
285 // the SDK.
286 AlwaysSdk bool `blueprint:"mutated"`
287
288 // Variant is an SDK variant created by sdkMutator
289 IsSdkVariant bool `blueprint:"mutated"`
290 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
291 // variant to have a ".sdk" suffix.
292 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700293
294 // Normally Soong uses the directory structure to decide which modules
295 // should be included (framework) or excluded (non-framework) from the
296 // vendor snapshot, but this property allows a partner to exclude a
297 // module normally thought of as a framework module from the vendor
298 // snapshot.
299 Exclude_from_vendor_snapshot *bool
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700300}
301
302type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900303 // whether this module should be allowed to be directly depended by other
304 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun5f7f7e82019-11-18 19:52:14 +0900305 // In addition, this module should be allowed to be directly depended by
306 // product modules with `product_specific: true`.
307 // If set to true, three variants will be built separately, one like
308 // normal, another limited to the set of libraries and headers
309 // that are exposed to /vendor modules, and the other to /product modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700310 //
Justin Yun5f7f7e82019-11-18 19:52:14 +0900311 // The vendor and product variants may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700312 // so it shouldn't have any unversioned runtime dependencies, or
313 // make assumptions about the system that may not be true in the
314 // future.
315 //
Justin Yun5f7f7e82019-11-18 19:52:14 +0900316 // If set to false, this module becomes inaccessible from /vendor or /product
317 // modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900318 //
319 // Default value is true when vndk: {enabled: true} or vendor: true.
320 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700321 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
Justin Yun5f7f7e82019-11-18 19:52:14 +0900322 // If PRODUCT_PRODUCT_VNDK_VERSION isn't set, product variant will not be used.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700323 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900324
325 // whether this module is capable of being loaded with other instance
326 // (possibly an older version) of the same module in the same process.
327 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
328 // can be double loaded in a vendor process if the library is also a
329 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
330 // explicitly marked as `double_loadable: true` by the owner, or the dependency
331 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
332 Double_loadable *bool
Colin Crossca860ac2016-01-04 14:34:37 -0800333}
334
Colin Crossca860ac2016-01-04 14:34:37 -0800335type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800336 static() bool
337 staticBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900338 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900339 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900340 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700341 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900342 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700343 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800344 sdkVersion() string
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700345 useVndk() bool
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800346 isNdk() bool
Inseob Kim9516ee92019-05-09 10:56:13 +0900347 isLlndk(config android.Config) bool
348 isLlndkPublic(config android.Config) bool
349 isVndkPrivate(config android.Config) bool
Justin Yun8effde42017-06-23 19:24:43 +0900350 isVndk() bool
351 isVndkSp() bool
Logan Chienf3511742017-10-31 18:04:35 +0800352 isVndkExt() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900353 inProduct() bool
354 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800355 inRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900356 inRecovery() bool
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +0800357 shouldCreateSourceAbiDump() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700358 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700359 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800360 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800361 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800362 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800363 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800364 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700365 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700366 apexSdkVersion() android.ApiLevel
Jiyong Parkb0788572018-12-20 22:10:17 +0900367 hasStubsVariants() bool
368 isStubs() bool
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900369 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800370 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700371 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700372 directlyInAnyApex() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800373}
374
375type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700376 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800377 ModuleContextIntf
378}
379
380type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700381 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800382 ModuleContextIntf
383}
384
Colin Cross37047f12016-12-13 17:06:13 -0800385type DepsContext interface {
386 android.BottomUpMutatorContext
387 ModuleContextIntf
388}
389
Colin Crossca860ac2016-01-04 14:34:37 -0800390type feature interface {
391 begin(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800392 deps(ctx DepsContext, deps Deps) Deps
Colin Crossca860ac2016-01-04 14:34:37 -0800393 flags(ctx ModuleContext, flags Flags) Flags
394 props() []interface{}
395}
396
397type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700398 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800399 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800400 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700401 compilerProps() []interface{}
402
Colin Cross76fada02016-07-27 10:31:13 -0700403 appendCflags([]string)
404 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700405 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800406}
407
408type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700409 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800410 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700411 linkerFlags(ctx ModuleContext, flags Flags) Flags
412 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800413 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700414
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700415 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700416 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900417 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700418
419 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900420 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000421
422 // Get the deps that have been explicitly specified in the properties.
423 // Only updates the
424 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
425}
426
427type specifiedDeps struct {
428 sharedLibs []string
Martin Stjernholm10566a02020-03-24 01:19:52 +0000429 systemSharedLibs []string // Note nil and [] are semantically distinct.
Colin Crossca860ac2016-01-04 14:34:37 -0800430}
431
432type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700433 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700434 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000435 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800436 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700437 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700438 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900439 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100440 makeUninstallable(mod *Module)
Colin Crossca860ac2016-01-04 14:34:37 -0800441}
442
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800443type xref interface {
444 XrefCcFiles() android.Paths
445}
446
Colin Cross6e511a92020-07-27 21:26:48 -0700447type libraryDependencyKind int
448
449const (
450 headerLibraryDependency = iota
451 sharedLibraryDependency
452 staticLibraryDependency
453)
454
455func (k libraryDependencyKind) String() string {
456 switch k {
457 case headerLibraryDependency:
458 return "headerLibraryDependency"
459 case sharedLibraryDependency:
460 return "sharedLibraryDependency"
461 case staticLibraryDependency:
462 return "staticLibraryDependency"
463 default:
464 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
465 }
466}
467
468type libraryDependencyOrder int
469
470const (
471 earlyLibraryDependency = -1
472 normalLibraryDependency = 0
473 lateLibraryDependency = 1
474)
475
476func (o libraryDependencyOrder) String() string {
477 switch o {
478 case earlyLibraryDependency:
479 return "earlyLibraryDependency"
480 case normalLibraryDependency:
481 return "normalLibraryDependency"
482 case lateLibraryDependency:
483 return "lateLibraryDependency"
484 default:
485 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
486 }
487}
488
489// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
490// tags that have a set of predefined tag objects that are reused for each dependency, a
491// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
492// That means that comparing a libraryDependencyTag for equality will only be equal if all
493// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
494// then check individual metadata fields instead.
495type libraryDependencyTag struct {
496 blueprint.BaseDependencyTag
497
498 // These are exported so that fmt.Printf("%#v") can call their String methods.
499 Kind libraryDependencyKind
500 Order libraryDependencyOrder
501
502 wholeStatic bool
503
504 reexportFlags bool
505 explicitlyVersioned bool
506 dataLib bool
507 ndk bool
508
509 staticUnwinder bool
510
511 makeSuffix string
512}
513
514// header returns true if the libraryDependencyTag is tagging a header lib dependency.
515func (d libraryDependencyTag) header() bool {
516 return d.Kind == headerLibraryDependency
517}
518
519// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
520func (d libraryDependencyTag) shared() bool {
521 return d.Kind == sharedLibraryDependency
522}
523
524// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
525func (d libraryDependencyTag) static() bool {
526 return d.Kind == staticLibraryDependency
527}
528
529// dependencyTag is used for tagging miscellanous dependency types that don't fit into
530// libraryDependencyTag. Each tag object is created globally and reused for multiple
531// dependencies (although since the object contains no references, assigning a tag to a
532// variable and modifying it will not modify the original). Users can compare the tag
533// returned by ctx.OtherModuleDependencyTag against the global original
534type dependencyTag struct {
535 blueprint.BaseDependencyTag
536 name string
537}
538
Colin Crossc99deeb2016-04-11 15:06:20 -0700539var (
Colin Cross6e511a92020-07-27 21:26:48 -0700540 genSourceDepTag = dependencyTag{name: "gen source"}
541 genHeaderDepTag = dependencyTag{name: "gen header"}
542 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
543 objDepTag = dependencyTag{name: "obj"}
544 linkerFlagsDepTag = dependencyTag{name: "linker flags file"}
545 dynamicLinkerDepTag = dependencyTag{name: "dynamic linker"}
546 reuseObjTag = dependencyTag{name: "reuse objects"}
547 staticVariantTag = dependencyTag{name: "static variant"}
548 vndkExtDepTag = dependencyTag{name: "vndk extends"}
549 dataLibDepTag = dependencyTag{name: "data lib"}
550 runtimeDepTag = dependencyTag{name: "runtime lib"}
551 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700552 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700553)
554
Colin Cross56a83212020-09-15 18:30:11 -0700555type copyDirectlyInAnyApexDependencyTag dependencyTag
556
557func (copyDirectlyInAnyApexDependencyTag) CopyDirectlyInAnyApex() {}
558
559var _ android.CopyDirectlyInAnyApexTag = copyDirectlyInAnyApexDependencyTag{}
560
Roland Levillainf89cd092019-07-29 16:22:59 +0100561func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700562 ccLibDepTag, ok := depTag.(libraryDependencyTag)
563 return ok && ccLibDepTag.shared()
564}
565
566func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
567 ccLibDepTag, ok := depTag.(libraryDependencyTag)
568 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100569}
570
571func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700572 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100573 return ok && ccDepTag == runtimeDepTag
574}
575
576func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700577 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100578 return ok && ccDepTag == testPerSrcDepTag
579}
580
Colin Crossca860ac2016-01-04 14:34:37 -0800581// Module contains the properties and members used by all C/C++ module types, and implements
582// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
583// to construct the output file. Behavior can be customized with a Customizer interface
584type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700585 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700586 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900587 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900588 android.SdkBase
Colin Crossc472d572015-03-17 15:06:21 -0700589
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700590 Properties BaseProperties
591 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700592
Colin Crossca860ac2016-01-04 14:34:37 -0800593 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700594 hod android.HostOrDeviceSupported
595 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700596
Paul Duffina0843f62019-12-13 19:50:38 +0000597 // Allowable SdkMemberTypes of this module type.
598 sdkMemberTypes []android.SdkMemberType
599
Colin Crossca860ac2016-01-04 14:34:37 -0800600 // delegates, initialize before calling Init
Colin Crossb4ce0ec2016-09-13 13:41:39 -0700601 features []feature
602 compiler compiler
603 linker linker
604 installer installer
605 stl *stl
606 sanitize *sanitize
Dan Willemsen581341d2017-02-09 16:16:31 -0800607 coverage *coverage
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800608 sabi *sabi
Justin Yun8effde42017-06-23 19:24:43 +0900609 vndkdep *vndkdep
Stephen Craneba090d12017-05-09 15:44:35 -0700610 lto *lto
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700611 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800612
Colin Cross635c3b02016-05-18 15:37:25 -0700613 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800614
Colin Crossb98c8b02016-07-29 13:44:28 -0700615 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700616
617 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800618
619 // Flags used to compile this module
620 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700621
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800622 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700623 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900624
625 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800626 // Kythe (source file indexer) paths for this compilation module
627 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900628
629 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700630 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700631
632 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700633}
634
Ivan Lozano52767be2019-10-18 14:49:46 -0700635func (c *Module) Toc() android.OptionalPath {
636 if c.linker != nil {
637 if library, ok := c.linker.(libraryInterface); ok {
638 return library.toc()
639 }
640 }
641 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
642}
643
644func (c *Module) ApiLevel() string {
645 if c.linker != nil {
646 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700647 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700648 }
649 }
650 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
651}
652
653func (c *Module) Static() bool {
654 if c.linker != nil {
655 if library, ok := c.linker.(libraryInterface); ok {
656 return library.static()
657 }
658 }
659 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
660}
661
662func (c *Module) Shared() bool {
663 if c.linker != nil {
664 if library, ok := c.linker.(libraryInterface); ok {
665 return library.shared()
666 }
667 }
668 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
669}
670
671func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000672 if c.stl != nil {
673 return c.stl.Properties.SelectedStl
674 }
675 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700676}
677
678func (c *Module) ToolchainLibrary() bool {
679 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
680 return true
681 }
682 return false
683}
684
685func (c *Module) NdkPrebuiltStl() bool {
686 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
687 return true
688 }
689 return false
690}
691
692func (c *Module) StubDecorator() bool {
693 if _, ok := c.linker.(*stubDecorator); ok {
694 return true
695 }
696 return false
697}
698
699func (c *Module) SdkVersion() string {
700 return String(c.Properties.Sdk_version)
701}
702
Artur Satayev480e25b2020-04-27 18:53:18 +0100703func (c *Module) MinSdkVersion() string {
704 return String(c.Properties.Min_sdk_version)
705}
706
Dan Albert92fe7402020-07-15 13:33:30 -0700707func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700708 if !c.canUseSdk() {
709 return false
710 }
Dan Albert92fe7402020-07-15 13:33:30 -0700711 if linker, ok := c.linker.(*objectLinker); ok {
712 return linker.isCrt()
713 }
714 return false
715}
716
Colin Crossc511bc52020-04-07 16:50:32 +0000717func (c *Module) AlwaysSdk() bool {
718 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
719}
720
Ivan Lozano183a3212019-10-18 14:18:45 -0700721func (c *Module) StubsVersions() []string {
722 if c.linker != nil {
723 if library, ok := c.linker.(*libraryDecorator); ok {
724 return library.Properties.Stubs.Versions
725 }
Colin Crossd48fe732020-09-23 20:37:24 -0700726 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
727 return library.Properties.Stubs.Versions
728 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700729 }
730 panic(fmt.Errorf("StubsVersions called on non-library module: %q", c.BaseModuleName()))
731}
732
733func (c *Module) CcLibrary() bool {
734 if c.linker != nil {
735 if _, ok := c.linker.(*libraryDecorator); ok {
736 return true
737 }
Colin Crossd48fe732020-09-23 20:37:24 -0700738 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
739 return true
740 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700741 }
742 return false
743}
744
745func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700746 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700747 return true
748 }
749 return false
750}
751
Ivan Lozano2b262972019-11-21 12:30:50 -0800752func (c *Module) NonCcVariants() bool {
753 return false
754}
755
Ivan Lozano183a3212019-10-18 14:18:45 -0700756func (c *Module) SetBuildStubs() {
757 if c.linker != nil {
758 if library, ok := c.linker.(*libraryDecorator); ok {
759 library.MutatedProperties.BuildStubs = true
Ivan Lozano52767be2019-10-18 14:49:46 -0700760 c.Properties.HideFromMake = true
761 c.sanitize = nil
762 c.stl = nil
763 c.Properties.PreventInstall = true
Ivan Lozano183a3212019-10-18 14:18:45 -0700764 return
765 }
Colin Crossd48fe732020-09-23 20:37:24 -0700766 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
767 library.MutatedProperties.BuildStubs = true
768 c.Properties.HideFromMake = true
769 c.sanitize = nil
770 c.stl = nil
771 c.Properties.PreventInstall = true
772 return
773 }
Jooyung Han61b66e92020-03-21 14:21:46 +0000774 if _, ok := c.linker.(*llndkStubDecorator); ok {
775 c.Properties.HideFromMake = true
776 return
777 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700778 }
779 panic(fmt.Errorf("SetBuildStubs called on non-library module: %q", c.BaseModuleName()))
780}
781
Ivan Lozano52767be2019-10-18 14:49:46 -0700782func (c *Module) BuildStubs() bool {
783 if c.linker != nil {
784 if library, ok := c.linker.(*libraryDecorator); ok {
785 return library.buildStubs()
786 }
Colin Crossd48fe732020-09-23 20:37:24 -0700787 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
788 return library.buildStubs()
789 }
Ivan Lozano52767be2019-10-18 14:49:46 -0700790 }
791 panic(fmt.Errorf("BuildStubs called on non-library module: %q", c.BaseModuleName()))
792}
793
Colin Crossd1f898e2020-08-18 18:35:15 -0700794func (c *Module) SetAllStubsVersions(versions []string) {
795 if library, ok := c.linker.(*libraryDecorator); ok {
796 library.MutatedProperties.AllStubsVersions = versions
797 return
798 }
Colin Crossd48fe732020-09-23 20:37:24 -0700799 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
800 library.MutatedProperties.AllStubsVersions = versions
801 return
802 }
Colin Crossd1f898e2020-08-18 18:35:15 -0700803 if llndk, ok := c.linker.(*llndkStubDecorator); ok {
804 llndk.libraryDecorator.MutatedProperties.AllStubsVersions = versions
805 return
806 }
807}
808
809func (c *Module) AllStubsVersions() []string {
810 if library, ok := c.linker.(*libraryDecorator); ok {
811 return library.MutatedProperties.AllStubsVersions
812 }
Colin Crossd48fe732020-09-23 20:37:24 -0700813 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
814 return library.MutatedProperties.AllStubsVersions
815 }
Colin Crossd1f898e2020-08-18 18:35:15 -0700816 if llndk, ok := c.linker.(*llndkStubDecorator); ok {
817 return llndk.libraryDecorator.MutatedProperties.AllStubsVersions
818 }
819 return nil
820}
821
822func (c *Module) SetStubsVersion(version string) {
Ivan Lozano183a3212019-10-18 14:18:45 -0700823 if c.linker != nil {
824 if library, ok := c.linker.(*libraryDecorator); ok {
825 library.MutatedProperties.StubsVersion = version
826 return
827 }
Colin Crossd48fe732020-09-23 20:37:24 -0700828 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
829 library.MutatedProperties.StubsVersion = version
830 return
831 }
Jooyung Han61b66e92020-03-21 14:21:46 +0000832 if llndk, ok := c.linker.(*llndkStubDecorator); ok {
833 llndk.libraryDecorator.MutatedProperties.StubsVersion = version
834 return
835 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700836 }
Colin Crossd1f898e2020-08-18 18:35:15 -0700837 panic(fmt.Errorf("SetStubsVersion called on non-library module: %q", c.BaseModuleName()))
Ivan Lozano183a3212019-10-18 14:18:45 -0700838}
839
Jooyung Han03b51852020-02-26 22:45:42 +0900840func (c *Module) StubsVersion() string {
841 if c.linker != nil {
842 if library, ok := c.linker.(*libraryDecorator); ok {
843 return library.MutatedProperties.StubsVersion
844 }
Colin Crossd48fe732020-09-23 20:37:24 -0700845 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
846 return library.MutatedProperties.StubsVersion
847 }
Jooyung Han61b66e92020-03-21 14:21:46 +0000848 if llndk, ok := c.linker.(*llndkStubDecorator); ok {
849 return llndk.libraryDecorator.MutatedProperties.StubsVersion
850 }
Jooyung Han03b51852020-02-26 22:45:42 +0900851 }
852 panic(fmt.Errorf("StubsVersion called on non-library module: %q", c.BaseModuleName()))
853}
854
Ivan Lozano183a3212019-10-18 14:18:45 -0700855func (c *Module) SetStatic() {
856 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700857 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700858 library.setStatic()
859 return
860 }
861 }
862 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
863}
864
865func (c *Module) SetShared() {
866 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700867 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700868 library.setShared()
869 return
870 }
871 }
872 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
873}
874
875func (c *Module) BuildStaticVariant() bool {
876 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700877 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700878 return library.buildStatic()
879 }
880 }
881 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
882}
883
884func (c *Module) BuildSharedVariant() bool {
885 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700886 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700887 return library.buildShared()
888 }
889 }
890 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
891}
892
893func (c *Module) Module() android.Module {
894 return c
895}
896
Jiyong Parkc20eee32018-09-05 22:36:17 +0900897func (c *Module) OutputFile() android.OptionalPath {
898 return c.outputFile
899}
900
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400901func (c *Module) CoverageFiles() android.Paths {
902 if c.linker != nil {
903 if library, ok := c.linker.(libraryInterface); ok {
904 return library.objs().coverageFiles
905 }
906 }
907 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
908}
909
Ivan Lozano183a3212019-10-18 14:18:45 -0700910var _ LinkableInterface = (*Module)(nil)
911
Jiyong Park719b4462019-01-13 00:39:51 +0900912func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900913 if c.linker != nil {
914 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +0900915 }
916 return nil
917}
918
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900919func (c *Module) CoverageOutputFile() android.OptionalPath {
920 if c.linker != nil {
921 return c.linker.coverageOutputFilePath()
922 }
923 return android.OptionalPath{}
924}
925
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900926func (c *Module) RelativeInstallPath() string {
927 if c.installer != nil {
928 return c.installer.relativeInstallPath()
929 }
930 return ""
931}
932
Jooyung Han344d5432019-08-23 11:17:39 +0900933func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +0900934 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +0900935}
936
Colin Cross36242852017-06-23 15:06:31 -0700937func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -0700938 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -0800939 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -0700940 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800941 }
942 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -0700943 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800944 }
945 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -0700946 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800947 }
Colin Crossa8e07cc2016-04-04 15:07:06 -0700948 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -0700949 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -0700950 }
Colin Cross16b23492016-01-06 14:41:07 -0800951 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -0700952 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -0800953 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800954 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -0700955 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -0800956 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800957 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -0700958 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800959 }
Justin Yun8effde42017-06-23 19:24:43 +0900960 if c.vndkdep != nil {
961 c.AddProperties(c.vndkdep.props()...)
962 }
Stephen Craneba090d12017-05-09 15:44:35 -0700963 if c.lto != nil {
964 c.AddProperties(c.lto.props()...)
965 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700966 if c.pgo != nil {
967 c.AddProperties(c.pgo.props()...)
968 }
Colin Crossca860ac2016-01-04 14:34:37 -0800969 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -0700970 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800971 }
Colin Crossc472d572015-03-17 15:06:21 -0700972
Jiyong Park1613e552020-09-14 19:43:17 +0900973 c.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, os android.OsType) bool {
Elliott Hughes79ae3412020-04-17 15:49:49 -0700974 // Windows builds always prefer 32-bit
Jiyong Park1613e552020-09-14 19:43:17 +0900975 return os == android.Windows
Colin Crossa9d8bee2018-10-02 13:59:46 -0700976 })
Colin Cross36242852017-06-23 15:06:31 -0700977 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +0900978 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900979 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +0900980 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +0900981
Colin Cross36242852017-06-23 15:06:31 -0700982 return c
Colin Crossc472d572015-03-17 15:06:21 -0700983}
984
Colin Crossb916a382016-07-29 17:28:03 -0700985// Returns true for dependency roots (binaries)
986// TODO(ccross): also handle dlopenable libraries
987func (c *Module) isDependencyRoot() bool {
988 if root, ok := c.linker.(interface {
989 isDependencyRoot() bool
990 }); ok {
991 return root.isDependencyRoot()
992 }
993 return false
994}
995
Justin Yun5f7f7e82019-11-18 19:52:14 +0900996// Returns true if the module is using VNDK libraries instead of the libraries in /system/lib or /system/lib64.
997// "product" and "vendor" variant modules return true for this function.
998// When BOARD_VNDK_VERSION is set, vendor variants of "vendor_available: true", "vendor: true",
999// "soc_specific: true" and more vendor installed modules are included here.
1000// When PRODUCT_PRODUCT_VNDK_VERSION is set, product variants of "vendor_available: true" or
1001// "product_specific: true" modules are included here.
Ivan Lozano52767be2019-10-18 14:49:46 -07001002func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001003 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001004}
1005
Colin Crossc511bc52020-04-07 16:50:32 +00001006func (c *Module) canUseSdk() bool {
1007 return c.Os() == android.Android && !c.UseVndk() && !c.InRamdisk() && !c.InRecovery()
1008}
1009
1010func (c *Module) UseSdk() bool {
1011 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001012 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001013 }
1014 return false
1015}
1016
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001017func (c *Module) isCoverageVariant() bool {
1018 return c.coverage.Properties.IsCoverageVariant
1019}
1020
Peter Collingbournead84f972019-12-17 16:46:18 -08001021func (c *Module) IsNdk() bool {
Colin Crossf0913fb2020-07-29 12:59:39 -07001022 return inList(c.BaseModuleName(), ndkKnownLibs)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001023}
1024
Inseob Kim9516ee92019-05-09 10:56:13 +09001025func (c *Module) isLlndk(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001026 // Returns true for both LLNDK (public) and LLNDK-private libs.
Jooyung Han0302a842019-10-30 18:43:49 +09001027 return isLlndkLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001028}
1029
Inseob Kim9516ee92019-05-09 10:56:13 +09001030func (c *Module) isLlndkPublic(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001031 // Returns true only for LLNDK (public) libs.
Jooyung Han0302a842019-10-30 18:43:49 +09001032 name := c.BaseModuleName()
1033 return isLlndkLibrary(name, config) && !isVndkPrivateLibrary(name, config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001034}
1035
Inseob Kim9516ee92019-05-09 10:56:13 +09001036func (c *Module) isVndkPrivate(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001037 // Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Jooyung Han0302a842019-10-30 18:43:49 +09001038 return isVndkPrivateLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001039}
1040
Ivan Lozano52767be2019-10-18 14:49:46 -07001041func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001042 if vndkdep := c.vndkdep; vndkdep != nil {
1043 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001044 }
1045 return false
1046}
1047
Yi Kong7e53c572018-02-14 18:16:12 +08001048func (c *Module) isPgoCompile() bool {
1049 if pgo := c.pgo; pgo != nil {
1050 return pgo.Properties.PgoCompile
1051 }
1052 return false
1053}
1054
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001055func (c *Module) isNDKStubLibrary() bool {
1056 if _, ok := c.compiler.(*stubDecorator); ok {
1057 return true
1058 }
1059 return false
1060}
1061
Logan Chienf3511742017-10-31 18:04:35 +08001062func (c *Module) isVndkSp() bool {
1063 if vndkdep := c.vndkdep; vndkdep != nil {
1064 return vndkdep.isVndkSp()
1065 }
1066 return false
1067}
1068
1069func (c *Module) isVndkExt() bool {
1070 if vndkdep := c.vndkdep; vndkdep != nil {
1071 return vndkdep.isVndkExt()
1072 }
1073 return false
1074}
1075
Ivan Lozano52767be2019-10-18 14:49:46 -07001076func (c *Module) MustUseVendorVariant() bool {
Jooyung Han097087b2019-10-22 19:32:18 +09001077 return c.isVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001078}
1079
Logan Chienf3511742017-10-31 18:04:35 +08001080func (c *Module) getVndkExtendsModuleName() string {
1081 if vndkdep := c.vndkdep; vndkdep != nil {
1082 return vndkdep.getVndkExtendsModuleName()
1083 }
1084 return ""
1085}
1086
Jiyong Park25fc6a92018-11-18 18:02:45 +09001087func (c *Module) IsStubs() bool {
1088 if library, ok := c.linker.(*libraryDecorator); ok {
1089 return library.buildStubs()
Colin Crossd48fe732020-09-23 20:37:24 -07001090 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
1091 return library.buildStubs()
Jiyong Park379de2f2018-12-19 02:47:14 +09001092 } else if _, ok := c.linker.(*llndkStubDecorator); ok {
1093 return true
Jiyong Park25fc6a92018-11-18 18:02:45 +09001094 }
1095 return false
1096}
1097
1098func (c *Module) HasStubsVariants() bool {
1099 if library, ok := c.linker.(*libraryDecorator); ok {
1100 return len(library.Properties.Stubs.Versions) > 0
1101 }
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001102 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
1103 return len(library.Properties.Stubs.Versions) > 0
1104 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001105 return false
1106}
1107
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001108func (c *Module) bootstrap() bool {
1109 return Bool(c.Properties.Bootstrap)
1110}
1111
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001112func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001113 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1114 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1115 return false
1116 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001117 return c.linker != nil && c.linker.nativeCoverage()
1118}
1119
Inseob Kim8471cda2019-11-15 09:59:12 +09001120func (c *Module) isSnapshotPrebuilt() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09001121 if p, ok := c.linker.(interface{ isSnapshotPrebuilt() bool }); ok {
1122 return p.isSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001123 }
1124 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001125}
1126
Bill Peckham945441c2020-08-31 16:07:58 -07001127func (c *Module) ExcludeFromVendorSnapshot() bool {
1128 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1129}
1130
Jiyong Parkf1194352019-02-25 11:05:47 +09001131func isBionic(name string) bool {
1132 switch name {
Martin Stjernholm203489b2019-11-11 15:33:27 +00001133 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001134 return true
1135 }
1136 return false
1137}
1138
Martin Stjernholm279de572019-09-10 23:18:20 +01001139func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001140 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001141 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001142 }
1143 return isBionic(name)
1144}
1145
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001146func (c *Module) XrefCcFiles() android.Paths {
1147 return c.kytheFiles
1148}
1149
Colin Crossca860ac2016-01-04 14:34:37 -08001150type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001151 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001152 moduleContextImpl
1153}
1154
Colin Cross37047f12016-12-13 17:06:13 -08001155type depsContext struct {
1156 android.BottomUpMutatorContext
1157 moduleContextImpl
1158}
1159
Colin Crossca860ac2016-01-04 14:34:37 -08001160type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001161 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001162 moduleContextImpl
1163}
1164
1165type moduleContextImpl struct {
1166 mod *Module
1167 ctx BaseModuleContext
1168}
1169
Colin Crossb98c8b02016-07-29 13:44:28 -07001170func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001171 return ctx.mod.toolchain(ctx.ctx)
1172}
1173
1174func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001175 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001176}
1177
1178func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001179 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001180}
1181
Jiyong Park1d1119f2019-07-29 21:27:18 +09001182func (ctx *moduleContextImpl) header() bool {
1183 return ctx.mod.header()
1184}
1185
Inseob Kim7f283f42020-06-01 21:53:49 +09001186func (ctx *moduleContextImpl) binary() bool {
1187 return ctx.mod.binary()
1188}
1189
Inseob Kim1042d292020-06-01 23:23:05 +09001190func (ctx *moduleContextImpl) object() bool {
1191 return ctx.mod.object()
1192}
1193
Jooyung Hanccce2f22020-03-07 03:45:53 +09001194func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001195 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001196}
1197
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001198func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001199 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001200}
1201
1202func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001203 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001204 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001205 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001206 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001207 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001208 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001209 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001210 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001211 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001212 }
1213 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001214}
1215
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001216func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001217 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001218}
Justin Yun8effde42017-06-23 19:24:43 +09001219
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001220func (ctx *moduleContextImpl) isNdk() bool {
Peter Collingbournead84f972019-12-17 16:46:18 -08001221 return ctx.mod.IsNdk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001222}
1223
Inseob Kim9516ee92019-05-09 10:56:13 +09001224func (ctx *moduleContextImpl) isLlndk(config android.Config) bool {
1225 return ctx.mod.isLlndk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001226}
1227
Inseob Kim9516ee92019-05-09 10:56:13 +09001228func (ctx *moduleContextImpl) isLlndkPublic(config android.Config) bool {
1229 return ctx.mod.isLlndkPublic(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001230}
1231
Inseob Kim9516ee92019-05-09 10:56:13 +09001232func (ctx *moduleContextImpl) isVndkPrivate(config android.Config) bool {
1233 return ctx.mod.isVndkPrivate(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001234}
1235
Logan Chienf3511742017-10-31 18:04:35 +08001236func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001237 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001238}
1239
Yi Kong7e53c572018-02-14 18:16:12 +08001240func (ctx *moduleContextImpl) isPgoCompile() bool {
1241 return ctx.mod.isPgoCompile()
1242}
1243
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001244func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1245 return ctx.mod.isNDKStubLibrary()
1246}
1247
Justin Yun8effde42017-06-23 19:24:43 +09001248func (ctx *moduleContextImpl) isVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001249 return ctx.mod.isVndkSp()
1250}
1251
1252func (ctx *moduleContextImpl) isVndkExt() bool {
1253 return ctx.mod.isVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001254}
1255
Vic Yangefd249e2018-11-12 20:19:56 -08001256func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001257 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001258}
1259
Logan Chien2f2b8902018-07-10 15:01:19 +08001260// Check whether ABI dumps should be created for this module.
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001261func (ctx *moduleContextImpl) shouldCreateSourceAbiDump() bool {
Logan Chien2f2b8902018-07-10 15:01:19 +08001262 if ctx.ctx.Config().IsEnvTrue("SKIP_ABI_CHECKS") {
1263 return false
Jayant Chowdharyea0a2e12018-03-01 19:12:16 -08001264 }
Doug Hornc32c6b02019-01-17 14:44:05 -08001265
Hsin-Yi Chenf81bb652020-04-07 21:42:19 +08001266 // Coverage builds have extra symbols.
1267 if ctx.mod.isCoverageVariant() {
1268 return false
1269 }
1270
Doug Hornc32c6b02019-01-17 14:44:05 -08001271 if ctx.ctx.Fuchsia() {
1272 return false
1273 }
1274
Logan Chien2f2b8902018-07-10 15:01:19 +08001275 if sanitize := ctx.mod.sanitize; sanitize != nil {
1276 if !sanitize.isVariantOnProductionDevice() {
1277 return false
1278 }
1279 }
1280 if !ctx.ctx.Device() {
1281 // Host modules do not need ABI dumps.
1282 return false
1283 }
Hsin-Yi Chend2451682020-01-10 16:47:50 +08001284 if ctx.isStubs() || ctx.isNDKStubLibrary() {
Hsin-Yi Chenf6a95462019-06-25 14:46:52 +08001285 // Stubs do not need ABI dumps.
1286 return false
1287 }
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001288 return true
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001289}
1290
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001291func (ctx *moduleContextImpl) selectedStl() string {
1292 if stl := ctx.mod.stl; stl != nil {
1293 return stl.Properties.SelectedStl
1294 }
1295 return ""
1296}
1297
Ivan Lozanobd721262018-11-27 14:33:03 -08001298func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1299 return ctx.mod.linker.useClangLld(actx)
1300}
1301
Colin Crossce75d2c2016-10-06 16:12:58 -07001302func (ctx *moduleContextImpl) baseModuleName() string {
1303 return ctx.mod.ModuleBase.BaseModuleName()
1304}
1305
Logan Chienf3511742017-10-31 18:04:35 +08001306func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1307 return ctx.mod.getVndkExtendsModuleName()
1308}
1309
Logan Chiene274fc92019-12-03 11:18:32 -08001310func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001311 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001312}
1313
Colin Crosse07f2312020-08-13 11:24:56 -07001314func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001315 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001316}
1317
Dan Albertc8060532020-07-22 22:32:17 -07001318func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001319 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001320}
1321
Jiyong Parkb0788572018-12-20 22:10:17 +09001322func (ctx *moduleContextImpl) hasStubsVariants() bool {
1323 return ctx.mod.HasStubsVariants()
1324}
1325
1326func (ctx *moduleContextImpl) isStubs() bool {
1327 return ctx.mod.IsStubs()
1328}
1329
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001330func (ctx *moduleContextImpl) bootstrap() bool {
1331 return ctx.mod.bootstrap()
1332}
1333
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001334func (ctx *moduleContextImpl) nativeCoverage() bool {
1335 return ctx.mod.nativeCoverage()
1336}
1337
Colin Cross56a83212020-09-15 18:30:11 -07001338func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1339 return ctx.mod.DirectlyInAnyApex()
1340}
1341
Colin Cross635c3b02016-05-18 15:37:25 -07001342func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001343 return &Module{
1344 hod: hod,
1345 multilib: multilib,
1346 }
1347}
1348
Colin Cross635c3b02016-05-18 15:37:25 -07001349func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001350 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001351 module.features = []feature{
1352 &tidyFeature{},
1353 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001354 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001355 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001356 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001357 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001358 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001359 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001360 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001361 return module
1362}
1363
Colin Crossce75d2c2016-10-06 16:12:58 -07001364func (c *Module) Prebuilt() *android.Prebuilt {
1365 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1366 return p.prebuilt()
1367 }
1368 return nil
1369}
1370
1371func (c *Module) Name() string {
1372 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001373 if p, ok := c.linker.(interface {
1374 Name(string) string
1375 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001376 name = p.Name(name)
1377 }
1378 return name
1379}
1380
Alex Light3d673592019-01-18 14:37:31 -08001381func (c *Module) Symlinks() []string {
1382 if p, ok := c.installer.(interface {
1383 symlinkList() []string
1384 }); ok {
1385 return p.symlinkList()
1386 }
1387 return nil
1388}
1389
Roland Levillainf89cd092019-07-29 16:22:59 +01001390func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1391 test, ok := c.linker.(testPerSrc)
1392 return ok && test.isAllTestsVariation()
1393}
1394
Chris Parsons216e10a2020-07-09 17:12:52 -04001395func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001396 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001397 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001398 }); ok {
1399 return p.dataPaths()
1400 }
1401 return nil
1402}
1403
Justin Yun5f7f7e82019-11-18 19:52:14 +09001404func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1405 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1406 // "current", it will append the VNDK version to the name suffix.
1407 var vndkVersion string
1408 var nameSuffix string
1409 if c.inProduct() {
1410 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1411 nameSuffix = productSuffix
1412 } else {
1413 vndkVersion = ctx.DeviceConfig().VndkVersion()
1414 nameSuffix = vendorSuffix
1415 }
1416 if vndkVersion == "current" {
1417 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1418 }
1419 if c.Properties.VndkVersion != vndkVersion {
1420 // add version suffix only if the module is using different vndk version than the
1421 // version in product or vendor partition.
1422 nameSuffix += "." + c.Properties.VndkVersion
1423 }
1424 return nameSuffix
1425}
1426
Colin Cross635c3b02016-05-18 15:37:25 -07001427func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Roland Levillainf2fad972019-06-28 15:41:19 +01001428 // Handle the case of a test module split by `test_per_src` mutator.
Roland Levillainf89cd092019-07-29 16:22:59 +01001429 //
1430 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1431 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1432 // module and return early, as this module does not produce an output file per se.
1433 if c.IsTestPerSrcAllTestsVariation() {
1434 c.outputFile = android.OptionalPath{}
1435 return
Roland Levillainf2fad972019-06-28 15:41:19 +01001436 }
1437
Colin Cross56a83212020-09-15 18:30:11 -07001438 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1439 if !apexInfo.IsForPlatform() {
1440 c.hideApexVariantFromMake = true
1441 }
1442
Jooyung Han38002912019-05-16 04:01:54 +09001443 c.makeLinkType = c.getMakeLinkType(actx)
Inseob Kim9516ee92019-05-09 10:56:13 +09001444
Inseob Kim64c43952019-08-26 16:52:35 +09001445 c.Properties.SubName = ""
1446
1447 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1448 c.Properties.SubName += nativeBridgeSuffix
1449 }
1450
Justin Yun5f7f7e82019-11-18 19:52:14 +09001451 _, llndk := c.linker.(*llndkStubDecorator)
1452 _, llndkHeader := c.linker.(*llndkHeadersDecorator)
1453 if llndk || llndkHeader || (c.UseVndk() && c.HasVendorVariant()) {
1454 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1455 // added for product variant only when we have vendor and product variants with core
1456 // variant. The suffix is not added for vendor-only or product-only module.
1457 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
1458 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001459 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1460 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
1461 c.Properties.SubName += vendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001462 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1463 c.Properties.SubName += ramdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001464 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001465 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001466 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001467 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001468 if c.SplitPerApiLevel() {
1469 c.Properties.SubName += "." + c.SdkVersion()
1470 }
Inseob Kim64c43952019-08-26 16:52:35 +09001471 }
1472
Colin Crossca860ac2016-01-04 14:34:37 -08001473 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001474 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001475 moduleContextImpl: moduleContextImpl{
1476 mod: c,
1477 },
1478 }
1479 ctx.ctx = ctx
1480
Colin Crossf18e1102017-11-16 14:33:08 -08001481 deps := c.depsToPaths(ctx)
1482 if ctx.Failed() {
1483 return
1484 }
1485
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001486 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1487 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1488 }
1489
Colin Crossca860ac2016-01-04 14:34:37 -08001490 flags := Flags{
1491 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001492 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001493 }
Colin Crossca860ac2016-01-04 14:34:37 -08001494 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001495 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001496 }
1497 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001498 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001499 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001500 if c.stl != nil {
1501 flags = c.stl.flags(ctx, flags)
1502 }
Colin Cross16b23492016-01-06 14:41:07 -08001503 if c.sanitize != nil {
1504 flags = c.sanitize.flags(ctx, flags)
1505 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001506 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001507 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001508 }
Stephen Craneba090d12017-05-09 15:44:35 -07001509 if c.lto != nil {
1510 flags = c.lto.flags(ctx, flags)
1511 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001512 if c.pgo != nil {
1513 flags = c.pgo.flags(ctx, flags)
1514 }
Colin Crossca860ac2016-01-04 14:34:37 -08001515 for _, feature := range c.features {
1516 flags = feature.flags(ctx, flags)
1517 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001518 if ctx.Failed() {
1519 return
1520 }
1521
Colin Cross4af21ed2019-11-04 09:37:55 -08001522 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1523 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1524 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001525
Colin Cross4af21ed2019-11-04 09:37:55 -08001526 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001527
1528 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001529 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001530 }
1531 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001532 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001533 }
1534
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001535 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001536 // We need access to all the flags seen by a source file.
1537 if c.sabi != nil {
1538 flags = c.sabi.flags(ctx, flags)
1539 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001540
Colin Cross4af21ed2019-11-04 09:37:55 -08001541 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001542
Colin Crossca860ac2016-01-04 14:34:37 -08001543 // Optimization to reduce size of build.ninja
1544 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001545 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1546 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1547 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1548 flags.Local.CFlags = []string{"$cflags"}
1549 flags.Local.CppFlags = []string{"$cppflags"}
1550 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001551
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001552 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001553 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001554 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001555 if ctx.Failed() {
1556 return
1557 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001558 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001559 }
1560
Colin Crossca860ac2016-01-04 14:34:37 -08001561 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001562 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001563 if ctx.Failed() {
1564 return
1565 }
Colin Cross635c3b02016-05-18 15:37:25 -07001566 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001567
1568 // If a lib is directly included in any of the APEXes, unhide the stubs
1569 // variant having the latest version gets visible to make. In addition,
1570 // the non-stubs variant is renamed to <libname>.bootstrap. This is to
1571 // force anything in the make world to link against the stubs library.
1572 // (unless it is explicitly referenced via .bootstrap suffix or the
1573 // module is marked with 'bootstrap: true').
Colin Cross56a83212020-09-15 18:30:11 -07001574 if c.HasStubsVariants() && c.AnyVariantDirectlyInAnyApex() && !c.InRamdisk() &&
Ivan Lozano52767be2019-10-18 14:49:46 -07001575 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001576 c.IsStubs() {
Jiyong Parkb0788572018-12-20 22:10:17 +09001577 c.Properties.HideFromMake = false // unhide
1578 // Note: this is still non-installable
1579 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001580
1581 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current.
1582 if i, ok := c.linker.(snapshotLibraryInterface); ok && ctx.DeviceConfig().VndkVersion() == "current" {
Colin Cross56a83212020-09-15 18:30:11 -07001583 if isSnapshotAware(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001584 i.collectHeadersForSnapshot(ctx)
1585 }
1586 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001587 }
Colin Cross5049f022015-03-18 13:28:46 -07001588
Colin Cross56a83212020-09-15 18:30:11 -07001589 if c.installable(apexInfo) {
Colin Crossce75d2c2016-10-06 16:12:58 -07001590 c.installer.install(ctx, c.outputFile.Path())
1591 if ctx.Failed() {
1592 return
Colin Crossca860ac2016-01-04 14:34:37 -08001593 }
Paul Duffin0cb37b92020-03-04 14:52:46 +00001594 } else if !proptools.BoolDefault(c.Properties.Installable, true) {
1595 // If the module has been specifically configure to not be installed then
1596 // skip the installation as otherwise it will break when running inside make
1597 // as the output path to install will not be specified. Not all uninstallable
1598 // modules can skip installation as some are needed for resolving make side
1599 // dependencies.
1600 c.SkipInstall()
Dan Albertc403f7c2015-03-18 14:01:18 -07001601 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001602}
1603
Colin Cross0ea8ba82019-06-06 14:33:29 -07001604func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001605 if c.cachedToolchain == nil {
Colin Crossb98c8b02016-07-29 13:44:28 -07001606 c.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
Colin Cross3f40fa42015-01-30 17:27:36 -08001607 }
Colin Crossca860ac2016-01-04 14:34:37 -08001608 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001609}
1610
Colin Crossca860ac2016-01-04 14:34:37 -08001611func (c *Module) begin(ctx BaseModuleContext) {
1612 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001613 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001614 }
Colin Crossca860ac2016-01-04 14:34:37 -08001615 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001616 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001617 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001618 if c.stl != nil {
1619 c.stl.begin(ctx)
1620 }
Colin Cross16b23492016-01-06 14:41:07 -08001621 if c.sanitize != nil {
1622 c.sanitize.begin(ctx)
1623 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001624 if c.coverage != nil {
1625 c.coverage.begin(ctx)
1626 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001627 if c.sabi != nil {
1628 c.sabi.begin(ctx)
1629 }
Justin Yun8effde42017-06-23 19:24:43 +09001630 if c.vndkdep != nil {
1631 c.vndkdep.begin(ctx)
1632 }
Stephen Craneba090d12017-05-09 15:44:35 -07001633 if c.lto != nil {
1634 c.lto.begin(ctx)
1635 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001636 if c.pgo != nil {
1637 c.pgo.begin(ctx)
1638 }
Colin Crossca860ac2016-01-04 14:34:37 -08001639 for _, feature := range c.features {
1640 feature.begin(ctx)
1641 }
Dan Albert92fe7402020-07-15 13:33:30 -07001642 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001643 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001644 if err != nil {
1645 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001646 c.Properties.Sdk_version = nil
1647 } else {
1648 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001649 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001650 }
Colin Crossca860ac2016-01-04 14:34:37 -08001651}
1652
Colin Cross37047f12016-12-13 17:06:13 -08001653func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001654 deps := Deps{}
1655
1656 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001657 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001658 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001659 // Add the PGO dependency (the clang_rt.profile runtime library), which
1660 // sometimes depends on symbols from libgcc, before libgcc gets added
1661 // in linkerDeps().
Pirama Arumuga Nainar49b53d52017-10-04 16:47:29 -07001662 if c.pgo != nil {
1663 deps = c.pgo.deps(ctx, deps)
1664 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001665 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001666 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001667 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001668 if c.stl != nil {
1669 deps = c.stl.deps(ctx, deps)
1670 }
Colin Cross16b23492016-01-06 14:41:07 -08001671 if c.sanitize != nil {
1672 deps = c.sanitize.deps(ctx, deps)
1673 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001674 if c.coverage != nil {
1675 deps = c.coverage.deps(ctx, deps)
1676 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001677 if c.sabi != nil {
1678 deps = c.sabi.deps(ctx, deps)
1679 }
Justin Yun8effde42017-06-23 19:24:43 +09001680 if c.vndkdep != nil {
1681 deps = c.vndkdep.deps(ctx, deps)
1682 }
Stephen Craneba090d12017-05-09 15:44:35 -07001683 if c.lto != nil {
1684 deps = c.lto.deps(ctx, deps)
1685 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001686 for _, feature := range c.features {
1687 deps = feature.deps(ctx, deps)
1688 }
1689
Colin Crossb6715442017-10-24 11:13:31 -07001690 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1691 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1692 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1693 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1694 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1695 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001696 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001697
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001698 for _, lib := range deps.ReexportSharedLibHeaders {
1699 if !inList(lib, deps.SharedLibs) {
1700 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1701 }
1702 }
1703
1704 for _, lib := range deps.ReexportStaticLibHeaders {
1705 if !inList(lib, deps.StaticLibs) {
1706 ctx.PropertyErrorf("export_static_lib_headers", "Static library not in static_libs: '%s'", lib)
1707 }
1708 }
1709
Colin Cross5950f382016-12-13 12:50:57 -08001710 for _, lib := range deps.ReexportHeaderLibHeaders {
1711 if !inList(lib, deps.HeaderLibs) {
1712 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1713 }
1714 }
1715
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001716 for _, gen := range deps.ReexportGeneratedHeaders {
1717 if !inList(gen, deps.GeneratedHeaders) {
1718 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1719 }
1720 }
1721
Colin Crossc99deeb2016-04-11 15:06:20 -07001722 return deps
1723}
1724
Dan Albert7e9d2952016-08-04 13:02:36 -07001725func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001726 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001727 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001728 moduleContextImpl: moduleContextImpl{
1729 mod: c,
1730 },
1731 }
1732 ctx.ctx = ctx
1733
Colin Crossca860ac2016-01-04 14:34:37 -08001734 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001735}
1736
Jiyong Park7ed9de32018-10-15 22:25:07 +09001737// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001738func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001739 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1740 version := name[sharp+1:]
1741 libname := name[:sharp]
1742 return libname, version
1743 }
1744 return name, ""
1745}
1746
Dan Albert92fe7402020-07-15 13:33:30 -07001747func GetCrtVariations(ctx android.BottomUpMutatorContext,
1748 m LinkableInterface) []blueprint.Variation {
1749 if ctx.Os() != android.Android {
1750 return nil
1751 }
1752 if m.UseSdk() {
1753 return []blueprint.Variation{
1754 {Mutator: "sdk", Variation: "sdk"},
1755 {Mutator: "ndk_api", Variation: m.SdkVersion()},
1756 }
1757 }
1758 return []blueprint.Variation{
1759 {Mutator: "sdk", Variation: ""},
1760 }
1761}
1762
Colin Crosse7257d22020-09-24 09:56:18 -07001763func (c *Module) addSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext,
1764 variations []blueprint.Variation, depTag libraryDependencyTag, name, version string, far bool) {
1765
1766 variations = append([]blueprint.Variation(nil), variations...)
1767
Colin Cross3146c5c2020-09-30 15:34:40 -07001768 if version != "" && CanBeOrLinkAgainstVersionVariants(c) {
Colin Crosse7257d22020-09-24 09:56:18 -07001769 // Version is explicitly specified. i.e. libFoo#30
1770 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
1771 depTag.explicitlyVersioned = true
1772 }
Colin Crosse7257d22020-09-24 09:56:18 -07001773
Colin Cross0de8a1e2020-09-18 14:15:30 -07001774 if far {
1775 ctx.AddFarVariationDependencies(variations, depTag, name)
1776 } else {
1777 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07001778 }
1779}
1780
Colin Cross1e676be2016-10-12 14:38:15 -07001781func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09001782 if !c.Enabled() {
1783 return
1784 }
1785
Colin Cross37047f12016-12-13 17:06:13 -08001786 ctx := &depsContext{
1787 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07001788 moduleContextImpl: moduleContextImpl{
1789 mod: c,
1790 },
1791 }
1792 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08001793
Colin Crossc99deeb2016-04-11 15:06:20 -07001794 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001795
Yo Chiang219968c2020-09-22 18:45:04 +08001796 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
1797
Dan Albert914449f2016-06-17 16:45:24 -07001798 variantNdkLibs := []string{}
1799 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07001800 if ctx.Os() == android.Android {
Inseob Kimeec88e12020-01-22 11:11:29 +09001801 // rewriteLibs takes a list of names of shared libraries and scans it for three types
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001802 // of names:
Dan Albert914449f2016-06-17 16:45:24 -07001803 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001804 // 1. Name of an NDK library that refers to a prebuilt module.
1805 // For each of these, it adds the name of the prebuilt module (which will be in
1806 // prebuilts/ndk) to the list of nonvariant libs.
1807 // 2. Name of an NDK library that refers to an ndk_library module.
1808 // For each of these, it adds the name of the ndk_library module to the list of
1809 // variant libs.
1810 // 3. Anything else (so anything that isn't an NDK library).
1811 // It adds these to the nonvariantLibs list.
Dan Albert914449f2016-06-17 16:45:24 -07001812 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001813 // The caller can then know to add the variantLibs dependencies differently from the
1814 // nonvariantLibs
Inseob Kim9516ee92019-05-09 10:56:13 +09001815
Inseob Kim9516ee92019-05-09 10:56:13 +09001816 vendorPublicLibraries := vendorPublicLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001817 vendorSnapshotSharedLibs := vendorSnapshotSharedLibs(actx.Config())
1818
1819 rewriteVendorLibs := func(lib string) string {
1820 if isLlndkLibrary(lib, ctx.Config()) {
1821 return lib + llndkLibrarySuffix
1822 }
1823
1824 // only modules with BOARD_VNDK_VERSION uses snapshot.
1825 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1826 return lib
1827 }
1828
1829 if snapshot, ok := vendorSnapshotSharedLibs.get(lib, actx.Arch().ArchType); ok {
1830 return snapshot
1831 }
1832
1833 return lib
1834 }
1835
1836 rewriteLibs := func(list []string) (nonvariantLibs []string, variantLibs []string) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001837 variantLibs = []string{}
1838 nonvariantLibs = []string{}
Dan Albert914449f2016-06-17 16:45:24 -07001839 for _, entry := range list {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001840 // strip #version suffix out
Jiyong Park73c54ee2019-10-22 20:31:18 +09001841 name, _ := StubsLibNameAndVersion(entry)
Dan Albertde5aade2020-06-30 12:32:51 -07001842 if ctx.useSdk() && inList(name, ndkKnownLibs) {
1843 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Inseob Kimeec88e12020-01-22 11:11:29 +09001844 } else if ctx.useVndk() {
1845 nonvariantLibs = append(nonvariantLibs, rewriteVendorLibs(entry))
Inseob Kim9516ee92019-05-09 10:56:13 +09001846 } else if (ctx.Platform() || ctx.ProductSpecific()) && inList(name, *vendorPublicLibraries) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001847 vendorPublicLib := name + vendorPublicLibrarySuffix
Jiyong Park374510b2018-03-19 18:23:01 +09001848 if actx.OtherModuleExists(vendorPublicLib) {
1849 nonvariantLibs = append(nonvariantLibs, vendorPublicLib)
1850 } else {
1851 // This can happen if vendor_public_library module is defined in a
1852 // namespace that isn't visible to the current module. In that case,
1853 // link to the original library.
Jiyong Park7ed9de32018-10-15 22:25:07 +09001854 nonvariantLibs = append(nonvariantLibs, name)
Jiyong Park374510b2018-03-19 18:23:01 +09001855 }
Dan Albert914449f2016-06-17 16:45:24 -07001856 } else {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001857 // put name#version back
Dan Willemsen7cbf5f82017-03-28 00:08:30 -07001858 nonvariantLibs = append(nonvariantLibs, entry)
Dan Willemsen72d39932016-07-08 23:23:48 -07001859 }
1860 }
Dan Albert914449f2016-06-17 16:45:24 -07001861 return nonvariantLibs, variantLibs
Dan Willemsen72d39932016-07-08 23:23:48 -07001862 }
1863
Inseob Kimeec88e12020-01-22 11:11:29 +09001864 deps.SharedLibs, variantNdkLibs = rewriteLibs(deps.SharedLibs)
1865 deps.LateSharedLibs, variantLateNdkLibs = rewriteLibs(deps.LateSharedLibs)
1866 deps.ReexportSharedLibHeaders, _ = rewriteLibs(deps.ReexportSharedLibHeaders)
1867 if ctx.useVndk() {
1868 for idx, lib := range deps.RuntimeLibs {
1869 deps.RuntimeLibs[idx] = rewriteVendorLibs(lib)
1870 }
1871 }
Dan Willemsen72d39932016-07-08 23:23:48 -07001872 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001873
Jiyong Park7e636d02019-01-28 16:16:54 +09001874 buildStubs := false
Jiyong Park7ed9de32018-10-15 22:25:07 +09001875 if c.linker != nil {
1876 if library, ok := c.linker.(*libraryDecorator); ok {
1877 if library.buildStubs() {
Jiyong Park7e636d02019-01-28 16:16:54 +09001878 buildStubs = true
Jiyong Park7ed9de32018-10-15 22:25:07 +09001879 }
1880 }
Colin Crossd48fe732020-09-23 20:37:24 -07001881 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
1882 if library.buildStubs() {
1883 buildStubs = true
1884 }
1885 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001886 }
1887
Inseob Kimeec88e12020-01-22 11:11:29 +09001888 rewriteSnapshotLibs := func(lib string, snapshotMap *snapshotMap) string {
1889 // only modules with BOARD_VNDK_VERSION uses snapshot.
1890 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1891 return lib
1892 }
1893
1894 if snapshot, ok := snapshotMap.get(lib, actx.Arch().ArchType); ok {
1895 return snapshot
1896 }
1897
1898 return lib
1899 }
1900
1901 vendorSnapshotHeaderLibs := vendorSnapshotHeaderLibs(actx.Config())
Colin Cross32ec36c2016-12-15 07:39:51 -08001902 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001903 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08001904 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001905 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08001906 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001907
1908 lib = rewriteSnapshotLibs(lib, vendorSnapshotHeaderLibs)
1909
Jiyong Park7e636d02019-01-28 16:16:54 +09001910 if buildStubs {
Colin Cross7228ecd2019-11-18 16:00:16 -08001911 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001912 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09001913 } else {
1914 actx.AddVariationDependencies(nil, depTag, lib)
1915 }
1916 }
1917
1918 if buildStubs {
1919 // Stubs lib does not have dependency to other static/shared libraries.
1920 // Don't proceed.
1921 return
Colin Cross32ec36c2016-12-15 07:39:51 -08001922 }
Colin Cross5950f382016-12-13 12:50:57 -08001923
Inseob Kimc0907f12019-02-08 21:00:45 +09001924 syspropImplLibraries := syspropImplLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001925 vendorSnapshotStaticLibs := vendorSnapshotStaticLibs(actx.Config())
Inseob Kimc0907f12019-02-08 21:00:45 +09001926
Jiyong Park5d1598f2019-02-25 22:14:17 +09001927 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001928 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09001929 if impl, ok := syspropImplLibraries[lib]; ok {
1930 lib = impl
1931 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001932
1933 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1934
Jiyong Park5d1598f2019-02-25 22:14:17 +09001935 actx.AddVariationDependencies([]blueprint.Variation{
1936 {Mutator: "link", Variation: "static"},
1937 }, depTag, lib)
1938 }
1939
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001940 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001941 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001942 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001943 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001944 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001945
1946 if impl, ok := syspropImplLibraries[lib]; ok {
1947 lib = impl
1948 }
1949
Inseob Kimeec88e12020-01-22 11:11:29 +09001950 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1951
Dan Willemsen59339a22018-07-22 21:18:45 -07001952 actx.AddVariationDependencies([]blueprint.Variation{
1953 {Mutator: "link", Variation: "static"},
1954 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001955 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001956
Jooyung Han75568392020-03-20 04:29:24 +09001957 // staticUnwinderDep is treated as staticDep for Q apexes
1958 // so that native libraries/binaries are linked with static unwinder
1959 // because Q libc doesn't have unwinder APIs
1960 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07001961 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001962 actx.AddVariationDependencies([]blueprint.Variation{
1963 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001964 }, depTag, rewriteSnapshotLibs(staticUnwinder(actx), vendorSnapshotStaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001965 }
1966
Inseob Kimeec88e12020-01-22 11:11:29 +09001967 for _, lib := range deps.LateStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001968 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Inseob Kimeec88e12020-01-22 11:11:29 +09001969 actx.AddVariationDependencies([]blueprint.Variation{
1970 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001971 }, depTag, rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs))
Inseob Kimeec88e12020-01-22 11:11:29 +09001972 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001973
Jiyong Park7ed9de32018-10-15 22:25:07 +09001974 // shared lib names without the #version suffix
1975 var sharedLibNames []string
1976
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001977 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001978 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001979 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001980 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001981 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001982
1983 if impl, ok := syspropImplLibraries[lib]; ok {
1984 lib = impl
1985 }
1986
Jiyong Park73c54ee2019-10-22 20:31:18 +09001987 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09001988 sharedLibNames = append(sharedLibNames, name)
1989
Colin Crosse7257d22020-09-24 09:56:18 -07001990 variations := []blueprint.Variation{
1991 {Mutator: "link", Variation: "shared"},
1992 }
1993 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001994 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001995
Jiyong Park7ed9de32018-10-15 22:25:07 +09001996 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09001997 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001998 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
1999 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2000 // linking against both the stubs lib and the non-stubs lib at the same time.
2001 continue
2002 }
Colin Cross6e511a92020-07-27 21:26:48 -07002003 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002004 variations := []blueprint.Variation{
2005 {Mutator: "link", Variation: "shared"},
2006 }
2007 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002008 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002009
Dan Willemsen59339a22018-07-22 21:18:45 -07002010 actx.AddVariationDependencies([]blueprint.Variation{
2011 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002012 }, dataLibDepTag, deps.DataLibs...)
2013
2014 actx.AddVariationDependencies([]blueprint.Variation{
2015 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002016 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002017
Colin Cross68861832016-07-08 10:41:41 -07002018 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002019
2020 for _, gen := range deps.GeneratedHeaders {
2021 depTag := genHeaderDepTag
2022 if inList(gen, deps.ReexportGeneratedHeaders) {
2023 depTag = genHeaderExportDepTag
2024 }
2025 actx.AddDependency(c, depTag, gen)
2026 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002027
Colin Cross42d48b72018-08-29 14:10:52 -07002028 actx.AddVariationDependencies(nil, objDepTag, deps.ObjFiles...)
Colin Crossc99deeb2016-04-11 15:06:20 -07002029
Inseob Kim1042d292020-06-01 23:23:05 +09002030 vendorSnapshotObjects := vendorSnapshotObjects(actx.Config())
2031
Dan Albert92fe7402020-07-15 13:33:30 -07002032 crtVariations := GetCrtVariations(ctx, c)
Colin Crossc99deeb2016-04-11 15:06:20 -07002033 if deps.CrtBegin != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07002034 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
2035 rewriteSnapshotLibs(deps.CrtBegin, vendorSnapshotObjects))
Colin Crossca860ac2016-01-04 14:34:37 -08002036 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002037 if deps.CrtEnd != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07002038 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
2039 rewriteSnapshotLibs(deps.CrtEnd, vendorSnapshotObjects))
Colin Cross21b9a242015-03-24 14:15:58 -07002040 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002041 if deps.LinkerFlagsFile != "" {
2042 actx.AddDependency(c, linkerFlagsDepTag, deps.LinkerFlagsFile)
2043 }
2044 if deps.DynamicLinker != "" {
2045 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002046 }
Dan Albert914449f2016-06-17 16:45:24 -07002047
2048 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002049
2050 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002051 actx.AddVariationDependencies([]blueprint.Variation{
Dan Willemsen59339a22018-07-22 21:18:45 -07002052 {Mutator: "ndk_api", Variation: version},
2053 {Mutator: "link", Variation: "shared"},
2054 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002055
2056 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002057 actx.AddVariationDependencies([]blueprint.Variation{
Dan Willemsen59339a22018-07-22 21:18:45 -07002058 {Mutator: "ndk_api", Variation: version},
2059 {Mutator: "link", Variation: "shared"},
2060 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002061
2062 if vndkdep := c.vndkdep; vndkdep != nil {
2063 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002064 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002065 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002066 {Mutator: "link", Variation: "shared"},
2067 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002068 }
2069 }
Colin Cross6362e272015-10-29 15:25:03 -07002070}
Colin Cross21b9a242015-03-24 14:15:58 -07002071
Colin Crosse40b4ea2018-10-02 22:25:58 -07002072func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002073 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2074 c.beginMutator(ctx)
2075 }
2076}
2077
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002078// Whether a module can link to another module, taking into
2079// account NDK linking.
Colin Cross6e511a92020-07-27 21:26:48 -07002080func checkLinkType(ctx android.ModuleContext, from LinkableInterface, to LinkableInterface,
2081 tag blueprint.DependencyTag) {
2082
2083 switch t := tag.(type) {
2084 case dependencyTag:
2085 if t != vndkExtDepTag {
2086 return
2087 }
2088 case libraryDependencyTag:
2089 default:
2090 return
2091 }
2092
Ivan Lozano52767be2019-10-18 14:49:46 -07002093 if from.Module().Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002094 // Host code is not restricted
2095 return
2096 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002097
2098 // VNDK is cc.Module supported only for now.
2099 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002100 // Though vendor code is limited by the vendor mutator,
2101 // each vendor-available module needs to check
2102 // link-type for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002103 if ccTo, ok := to.(*Module); ok {
2104 if ccFrom.vndkdep != nil {
2105 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2106 }
2107 } else {
2108 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002109 }
2110 return
2111 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002112 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002113 // Platform code can link to anything
2114 return
2115 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002116 if from.InRamdisk() {
2117 // Ramdisk code is not NDK
2118 return
2119 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002120 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002121 // Recovery code is not NDK
2122 return
2123 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002124 if to.ToolchainLibrary() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002125 // These are always allowed
2126 return
2127 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002128 if to.NdkPrebuiltStl() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002129 // These are allowed, but they don't set sdk_version
2130 return
2131 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002132 if to.StubDecorator() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002133 // These aren't real libraries, but are the stub shared libraries that are included in
2134 // the NDK.
2135 return
2136 }
Logan Chien834b9a62019-01-14 15:39:03 +08002137
Ivan Lozano52767be2019-10-18 14:49:46 -07002138 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002139 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2140 // to link to libc++ (non-NDK and without sdk_version).
2141 return
2142 }
2143
Ivan Lozano52767be2019-10-18 14:49:46 -07002144 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002145 // NDK code linking to platform code is never okay.
2146 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002147 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002148 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002149 }
2150
2151 // At this point we know we have two NDK libraries, but we need to
2152 // check that we're not linking against anything built against a higher
2153 // API level, as it is only valid to link against older or equivalent
2154 // APIs.
2155
Inseob Kim01a28722018-04-11 09:48:45 +09002156 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002157 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002158 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002159 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002160 // Current can't be linked against by anything else.
2161 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002162 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002163 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002164 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002165 if err != nil {
2166 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002167 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002168 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002169 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002170 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002171 if err != nil {
2172 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002173 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002174 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002175 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002176
Inseob Kim01a28722018-04-11 09:48:45 +09002177 if toApi > fromApi {
2178 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002179 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002180 }
2181 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002182 }
Dan Albert202fe492017-12-15 13:56:59 -08002183
2184 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002185 fromStl := from.SelectedStl()
2186 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002187 if fromStl == "" || toStl == "" {
2188 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002189 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002190 // We can be permissive with the system "STL" since it is only the C++
2191 // ABI layer, but in the future we should make sure that everyone is
2192 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002193 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002194 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002195 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2196 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002197 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002198}
2199
Jiyong Park5fb8c102018-04-09 12:03:06 +09002200// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002201// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2202// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002203// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002204func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2205 check := func(child, parent android.Module) bool {
2206 to, ok := child.(*Module)
2207 if !ok {
2208 // follow thru cc.Defaults, etc.
2209 return true
2210 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002211
Jooyung Hana70f0672019-01-18 15:20:43 +09002212 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2213 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002214 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002215
2216 // if target lib has no vendor variant, keep checking dependency graph
Ivan Lozano52767be2019-10-18 14:49:46 -07002217 if !to.HasVendorVariant() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002218 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002219 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002220
Jooyung Han0302a842019-10-30 18:43:49 +09002221 if to.isVndkSp() || to.isLlndk(ctx.Config()) || Bool(to.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002222 return false
2223 }
2224
2225 var stringPath []string
2226 for _, m := range ctx.GetWalkPath() {
2227 stringPath = append(stringPath, m.Name())
2228 }
2229 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2230 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
2231 "(dependency: %s)", ctx.OtherModuleName(to), strings.Join(stringPath, " -> "))
2232 return false
2233 }
2234 if module, ok := ctx.Module().(*Module); ok {
2235 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jooyung Han0302a842019-10-30 18:43:49 +09002236 if module.isLlndk(ctx.Config()) || Bool(module.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002237 ctx.WalkDeps(check)
2238 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002239 }
2240 }
2241}
2242
Colin Cross0de8a1e2020-09-18 14:15:30 -07002243// Returns the highest version which is <= maxSdkVersion.
2244// For example, with maxSdkVersion is 10 and versionList is [9,11]
2245// it returns 9 as string. The list of stubs must be in order from
2246// oldest to newest.
2247func (c *Module) chooseSdkVersion(ctx android.PathContext, stubsInfo []SharedLibraryStubsInfo,
2248 maxSdkVersion android.ApiLevel) (SharedLibraryStubsInfo, error) {
2249
2250 for i := range stubsInfo {
2251 stubInfo := stubsInfo[len(stubsInfo)-i-1]
2252 var ver android.ApiLevel
2253 if stubInfo.Version == "" {
2254 ver = android.FutureApiLevel
2255 } else {
2256 var err error
2257 ver, err = android.ApiLevelFromUser(ctx, stubInfo.Version)
2258 if err != nil {
2259 return SharedLibraryStubsInfo{}, err
2260 }
2261 }
2262 if ver.LessThanOrEqualTo(maxSdkVersion) {
2263 return stubInfo, nil
2264 }
2265 }
2266 var versionList []string
2267 for _, stubInfo := range stubsInfo {
2268 versionList = append(versionList, stubInfo.Version)
2269 }
2270 return SharedLibraryStubsInfo{}, fmt.Errorf("not found a version(<=%s) in versionList: %v", maxSdkVersion.String(), versionList)
2271}
2272
Colin Crossc99deeb2016-04-11 15:06:20 -07002273// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002274func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002275 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002276
Colin Cross0de8a1e2020-09-18 14:15:30 -07002277 var directStaticDeps []StaticLibraryInfo
2278 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002279
Colin Cross0de8a1e2020-09-18 14:15:30 -07002280 reexportExporter := func(exporter FlagExporterInfo) {
2281 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2282 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2283 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2284 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2285 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002286 }
2287
Jooyung Hande34d232020-07-23 13:04:15 +09002288 // For the dependency from platform to apex, use the latest stubs
2289 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002290 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2291 if !apexInfo.IsForPlatform() {
2292 c.apexSdkVersion = apexInfo.MinSdkVersion(ctx)
Jooyung Hande34d232020-07-23 13:04:15 +09002293 }
2294
2295 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2296 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2297 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2298 // (b/144430859)
2299 c.apexSdkVersion = android.FutureApiLevel
2300 }
2301
Colin Crossd11fcda2017-10-23 17:59:01 -07002302 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002303 depName := ctx.OtherModuleName(dep)
2304 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002305
Ivan Lozano52767be2019-10-18 14:49:46 -07002306 ccDep, ok := dep.(LinkableInterface)
2307 if !ok {
2308
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002309 // handling for a few module types that aren't cc Module but that are also supported
2310 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002311 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002312 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002313 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2314 genRule.GeneratedSourceFiles()...)
2315 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002316 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002317 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002318 // Support exported headers from a generated_sources dependency
2319 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002320 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002321 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002322 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002323 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002324 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002325 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002326 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002327 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002328 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2329 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002330 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002331 // 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 +09002332 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002333
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002334 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002335 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002336 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002337 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002338 case linkerFlagsDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002339 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002340 files := genRule.GeneratedSourceFiles()
2341 if len(files) == 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002342 depPaths.LinkerFlagsFile = android.OptionalPathForPath(files[0])
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002343 } else if len(files) > 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002344 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 -07002345 }
2346 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002347 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002348 }
Colin Crossca860ac2016-01-04 14:34:37 -08002349 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002350 return
2351 }
2352
Colin Crossfe17f6f2019-03-28 19:30:56 -07002353 if depTag == android.ProtoPluginDepTag {
2354 return
2355 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002356 if depTag == llndkImplDep {
2357 return
2358 }
Colin Crossfe17f6f2019-03-28 19:30:56 -07002359
Colin Crossd11fcda2017-10-23 17:59:01 -07002360 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002361 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2362 return
2363 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002364 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002365 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2366 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002367 return
2368 }
2369
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002370 if depTag == reuseObjTag {
Ivan Lozano52767be2019-10-18 14:49:46 -07002371 // reusing objects only make sense for cc.Modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002372 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2373 objs := staticAnalogue.ReuseObjects
2374 depPaths.Objs = depPaths.Objs.Append(objs)
2375 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2376 reexportExporter(depExporterInfo)
2377 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002378 }
2379
Colin Cross6e511a92020-07-27 21:26:48 -07002380 checkLinkType(ctx, c, ccDep, depTag)
2381
2382 linkFile := ccDep.OutputFile()
2383
2384 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2385 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002386 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002387 return
2388 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002389
Colin Cross0de8a1e2020-09-18 14:15:30 -07002390 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002391
Colin Cross6e511a92020-07-27 21:26:48 -07002392 var ptr *android.Paths
2393 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002394
Colin Cross6e511a92020-07-27 21:26:48 -07002395 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002396
Colin Cross6e511a92020-07-27 21:26:48 -07002397 switch {
2398 case libDepTag.header():
2399 // nothing
2400 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002401 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2402 if !ctx.Config().AllowMissingDependencies() {
2403 ctx.ModuleErrorf("module %q is not a shared library", depName)
2404 } else {
2405 ctx.AddMissingDependencies([]string{depName})
2406 }
2407 return
2408 }
2409 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2410 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryImplementationStubsInfoProvider).(SharedLibraryImplementationStubsInfo)
2411
2412 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedLibraryStubsInfos) > 0 {
2413 useStubs := false
2414 if m, ok := ccDep.(*Module); ok && m.IsStubs() && c.UseVndk() { // LLNDK
2415 if !apexInfo.IsForPlatform() {
2416 // For platform libraries, use current version of LLNDK
2417 // If this is for use_vendor apex we will apply the same rules
2418 // of apex sdk enforcement below to choose right version.
2419 useStubs = true
2420 }
2421 } else if apexInfo.IsForPlatform() {
2422 // If not building for APEX, use stubs only when it is from
2423 // an APEX (and not from platform)
2424 // However, for host, ramdisk, recovery or bootstrap modules,
2425 // always link to non-stub variant
2426 useStubs = dep.(android.ApexModule).AnyVariantDirectlyInAnyApex() && !c.bootstrap()
2427 // Another exception: if this module is bundled with an APEX, then
2428 // it is linked with the non-stub variant of a module in the APEX
2429 // as if this is part of the APEX.
2430 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2431 for _, apexContents := range testFor.ApexContents {
2432 if apexContents.DirectlyInApex(depName) {
2433 useStubs = false
2434 break
2435 }
2436 }
2437 } else {
2438 // If building for APEX, use stubs when the parent is in any APEX that
2439 // the child is not in.
2440 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2441 }
2442
2443 // when to use (unspecified) stubs, check min_sdk_version and choose the right one
2444 if useStubs {
2445 sharedLibraryStubsInfo, err :=
2446 c.chooseSdkVersion(ctx, sharedLibraryStubsInfo.SharedLibraryStubsInfos, c.apexSdkVersion)
2447 if err != nil {
2448 ctx.OtherModuleErrorf(dep, err.Error())
2449 return
2450 }
2451 sharedLibraryInfo = sharedLibraryStubsInfo.SharedLibraryInfo
2452 depExporterInfo = sharedLibraryStubsInfo.FlagExporterInfo
2453 }
2454 }
2455
2456 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2457 depFile = sharedLibraryInfo.TableOfContents
2458
Colin Cross6e511a92020-07-27 21:26:48 -07002459 ptr = &depPaths.SharedLibs
2460 switch libDepTag.Order {
2461 case earlyLibraryDependency:
2462 ptr = &depPaths.EarlySharedLibs
2463 depPtr = &depPaths.EarlySharedLibsDeps
2464 case normalLibraryDependency:
2465 ptr = &depPaths.SharedLibs
2466 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002467 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002468 case lateLibraryDependency:
2469 ptr = &depPaths.LateSharedLibs
2470 depPtr = &depPaths.LateSharedLibsDeps
2471 default:
2472 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002473 }
Colin Cross6e511a92020-07-27 21:26:48 -07002474 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002475 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2476 if !ctx.Config().AllowMissingDependencies() {
2477 ctx.ModuleErrorf("module %q is not a static library", depName)
2478 } else {
2479 ctx.AddMissingDependencies([]string{depName})
2480 }
2481 return
2482 }
2483 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2484 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002485 if libDepTag.wholeStatic {
2486 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002487 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2488 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002489 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002490 // This case normally catches prebuilt static
2491 // libraries, but it can also occur when
2492 // AllowMissingDependencies is on and the
2493 // dependencies has no sources of its own
2494 // but has a whole_static_libs dependency
2495 // on a missing library. We want to depend
2496 // on the .a file so that there is something
2497 // in the dependency tree that contains the
2498 // error rule for the missing transitive
2499 // dependency.
2500 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002501 }
Colin Cross6e511a92020-07-27 21:26:48 -07002502 } else {
2503 switch libDepTag.Order {
2504 case earlyLibraryDependency:
2505 panic(fmt.Errorf("early static libs not suppported"))
2506 case normalLibraryDependency:
2507 // static dependencies will be handled separately so they can be ordered
2508 // using transitive dependencies.
2509 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002510 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002511 case lateLibraryDependency:
2512 ptr = &depPaths.LateStaticLibs
2513 default:
2514 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002515 }
2516 }
2517 }
2518
Colin Cross6e511a92020-07-27 21:26:48 -07002519 if libDepTag.static() && !libDepTag.wholeStatic {
2520 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2521 ctx.ModuleErrorf("module %q not a static library", depName)
2522 return
2523 }
Logan Chien43d34c32017-12-20 01:17:32 +08002524
Colin Cross6e511a92020-07-27 21:26:48 -07002525 // When combining coverage files for shared libraries and executables, coverage files
2526 // in static libraries act as if they were whole static libraries. The same goes for
2527 // source based Abi dump files.
2528 if c, ok := ccDep.(*Module); ok {
2529 staticLib := c.linker.(libraryInterface)
2530 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2531 staticLib.objs().coverageFiles...)
2532 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2533 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002534 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002535 // Handle non-CC modules here
2536 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002537 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002538 }
2539 }
2540
Colin Cross6e511a92020-07-27 21:26:48 -07002541 if ptr != nil {
2542 if !linkFile.Valid() {
2543 if !ctx.Config().AllowMissingDependencies() {
2544 ctx.ModuleErrorf("module %q missing output file", depName)
2545 } else {
2546 ctx.AddMissingDependencies([]string{depName})
2547 }
2548 return
2549 }
2550 *ptr = append(*ptr, linkFile.Path())
2551 }
2552
2553 if depPtr != nil {
2554 dep := depFile
2555 if !dep.Valid() {
2556 dep = linkFile
2557 }
2558 *depPtr = append(*depPtr, dep.Path())
2559 }
2560
Colin Cross0de8a1e2020-09-18 14:15:30 -07002561 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2562 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2563 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2564 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2565
2566 if libDepTag.reexportFlags {
2567 reexportExporter(depExporterInfo)
2568 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2569 // Re-exported shared library headers must be included as well since they can help us with type information
2570 // about template instantiations (instantiated from their headers).
2571 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2572 // scripts.
2573 c.sabi.Properties.ReexportedIncludes = append(
2574 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2575 }
2576
Colin Cross6e511a92020-07-27 21:26:48 -07002577 makeLibName := c.makeLibName(ctx, ccDep, depName) + libDepTag.makeSuffix
2578 switch {
2579 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002580 c.Properties.AndroidMkHeaderLibs = append(
2581 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002582 case libDepTag.shared():
2583 if ccDep.CcLibrary() {
Colin Cross56a83212020-09-15 18:30:11 -07002584 if ccDep.BuildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002585 // Add the dependency to the APEX(es) providing the library so that
2586 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002587 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
2588 for _, an := range depApexInfo.InApexes {
Colin Cross6e511a92020-07-27 21:26:48 -07002589 c.Properties.ApexesProvidingSharedLibs = append(
2590 c.Properties.ApexesProvidingSharedLibs, an)
2591 }
2592 }
2593 }
2594
2595 // Note: the order of libs in this list is not important because
2596 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002597 c.Properties.AndroidMkSharedLibs = append(
2598 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002599 // Record baseLibName for snapshots.
2600 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, baseLibName(depName))
2601 case libDepTag.static():
2602 if libDepTag.wholeStatic {
2603 c.Properties.AndroidMkWholeStaticLibs = append(
2604 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2605 } else {
2606 c.Properties.AndroidMkStaticLibs = append(
2607 c.Properties.AndroidMkStaticLibs, makeLibName)
2608 }
2609 }
2610 } else {
2611 switch depTag {
2612 case runtimeDepTag:
2613 c.Properties.AndroidMkRuntimeLibs = append(
2614 c.Properties.AndroidMkRuntimeLibs, c.makeLibName(ctx, ccDep, depName)+libDepTag.makeSuffix)
2615 // Record baseLibName for snapshots.
2616 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, baseLibName(depName))
2617 case objDepTag:
2618 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2619 case CrtBeginDepTag:
2620 depPaths.CrtBegin = linkFile
2621 case CrtEndDepTag:
2622 depPaths.CrtEnd = linkFile
2623 case dynamicLinkerDepTag:
2624 depPaths.DynamicLinker = linkFile
2625 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002626 }
Colin Crossca860ac2016-01-04 14:34:37 -08002627 })
2628
Jeff Gaston294356f2017-09-27 17:05:30 -07002629 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002630 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2631 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2632 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002633
Colin Crossdd84e052017-05-17 13:44:16 -07002634 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002635 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002636 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2637 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002638 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002639 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2640 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002641 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002642 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002643 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002644
2645 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002646 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002647 }
Colin Crossdd84e052017-05-17 13:44:16 -07002648
Colin Crossca860ac2016-01-04 14:34:37 -08002649 return depPaths
2650}
2651
Colin Cross0de8a1e2020-09-18 14:15:30 -07002652// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2653// to match the topological order of the dependency tree, including any static analogues of
2654// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2655// of the transitive dependencies.
2656func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2657 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2658 var staticPaths android.Paths
2659 for _, staticDep := range staticDeps {
2660 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2661 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2662 }
2663 for _, sharedDep := range sharedDeps {
2664 if sharedDep.StaticAnalogue != nil {
2665 transitiveStaticLibsBuilder.Transitive(sharedDep.StaticAnalogue.TransitiveStaticLibrariesForOrdering)
2666 }
2667 }
2668 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2669
2670 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2671
2672 // reorder the dependencies based on transitive dependencies
2673 staticPaths = android.FirstUniquePaths(staticPaths)
2674 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2675
2676 if len(orderedStaticPaths) != len(staticPaths) {
2677 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2678 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2679 }
2680
2681 return orderedStaticPaths, transitiveStaticLibs
2682}
2683
Colin Cross6e511a92020-07-27 21:26:48 -07002684// baseLibName trims known prefixes and suffixes
2685func baseLibName(depName string) string {
2686 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
2687 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
2688 libName = strings.TrimPrefix(libName, "prebuilt_")
2689 return libName
2690}
2691
2692func (c *Module) makeLibName(ctx android.ModuleContext, ccDep LinkableInterface, depName string) string {
2693 vendorSuffixModules := vendorSuffixModules(ctx.Config())
2694 vendorPublicLibraries := vendorPublicLibraries(ctx.Config())
2695
2696 libName := baseLibName(depName)
2697 isLLndk := isLlndkLibrary(libName, ctx.Config())
2698 isVendorPublicLib := inList(libName, *vendorPublicLibraries)
2699 bothVendorAndCoreVariantsExist := ccDep.HasVendorVariant() || isLLndk
2700
2701 if c, ok := ccDep.(*Module); ok {
2702 // Use base module name for snapshots when exporting to Makefile.
2703 if c.isSnapshotPrebuilt() {
2704 baseName := c.BaseModuleName()
2705
2706 if c.IsVndk() {
2707 return baseName + ".vendor"
2708 }
2709
2710 if vendorSuffixModules[baseName] {
2711 return baseName + ".vendor"
2712 } else {
2713 return baseName
2714 }
2715 }
2716 }
2717
2718 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() && !c.InRamdisk() && !c.InRecovery() {
2719 // The vendor module is a no-vendor-variant VNDK library. Depend on the
2720 // core module instead.
2721 return libName
2722 } else if c.UseVndk() && bothVendorAndCoreVariantsExist {
2723 // The vendor module in Make will have been renamed to not conflict with the core
2724 // module, so update the dependency name here accordingly.
2725 return libName + c.getNameSuffixWithVndkVersion(ctx)
2726 } else if (ctx.Platform() || ctx.ProductSpecific()) && isVendorPublicLib {
2727 return libName + vendorPublicLibrarySuffix
2728 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
2729 return libName + ramdiskSuffix
2730 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
2731 return libName + recoverySuffix
2732 } else if ccDep.Module().Target().NativeBridge == android.NativeBridgeEnabled {
2733 return libName + nativeBridgeSuffix
2734 } else {
2735 return libName
2736 }
2737}
2738
Colin Crossca860ac2016-01-04 14:34:37 -08002739func (c *Module) InstallInData() bool {
2740 if c.installer == nil {
2741 return false
2742 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002743 return c.installer.inData()
2744}
2745
2746func (c *Module) InstallInSanitizerDir() bool {
2747 if c.installer == nil {
2748 return false
2749 }
2750 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07002751 return true
2752 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002753 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08002754}
2755
Yifan Hong1b3348d2020-01-21 15:53:22 -08002756func (c *Module) InstallInRamdisk() bool {
2757 return c.InRamdisk()
2758}
2759
Jiyong Parkf9332f12018-02-01 00:54:12 +09002760func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07002761 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09002762}
2763
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002764func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002765 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002766 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002767 return
2768 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002769 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002770}
2771
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07002772func (c *Module) HostToolPath() android.OptionalPath {
2773 if c.installer == nil {
2774 return android.OptionalPath{}
2775 }
2776 return c.installer.hostToolPath()
2777}
2778
Nan Zhangd4e641b2017-07-12 12:55:28 -07002779func (c *Module) IntermPathForModuleOut() android.OptionalPath {
2780 return c.outputFile
2781}
2782
Colin Cross41955e82019-05-29 14:40:35 -07002783func (c *Module) OutputFiles(tag string) (android.Paths, error) {
2784 switch tag {
2785 case "":
2786 if c.outputFile.Valid() {
2787 return android.Paths{c.outputFile.Path()}, nil
2788 }
2789 return android.Paths{}, nil
2790 default:
2791 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002792 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002793}
2794
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00002795func (c *Module) static() bool {
2796 if static, ok := c.linker.(interface {
2797 static() bool
2798 }); ok {
2799 return static.static()
2800 }
2801 return false
2802}
2803
Jiyong Park379de2f2018-12-19 02:47:14 +09002804func (c *Module) staticBinary() bool {
2805 if static, ok := c.linker.(interface {
2806 staticBinary() bool
2807 }); ok {
2808 return static.staticBinary()
2809 }
2810 return false
2811}
2812
Jiyong Park1d1119f2019-07-29 21:27:18 +09002813func (c *Module) header() bool {
2814 if h, ok := c.linker.(interface {
2815 header() bool
2816 }); ok {
2817 return h.header()
2818 }
2819 return false
2820}
2821
Inseob Kim7f283f42020-06-01 21:53:49 +09002822func (c *Module) binary() bool {
2823 if b, ok := c.linker.(interface {
2824 binary() bool
2825 }); ok {
2826 return b.binary()
2827 }
2828 return false
2829}
2830
Inseob Kim1042d292020-06-01 23:23:05 +09002831func (c *Module) object() bool {
2832 if o, ok := c.linker.(interface {
2833 object() bool
2834 }); ok {
2835 return o.object()
2836 }
2837 return false
2838}
2839
Jooyung Han38002912019-05-16 04:01:54 +09002840func (c *Module) getMakeLinkType(actx android.ModuleContext) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07002841 if c.UseVndk() {
Jooyung Han38002912019-05-16 04:01:54 +09002842 if lib, ok := c.linker.(*llndkStubDecorator); ok {
2843 if Bool(lib.Properties.Vendor_available) {
Colin Crossb60190a2018-09-04 16:28:17 -07002844 return "native:vndk"
2845 }
Jooyung Han38002912019-05-16 04:01:54 +09002846 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07002847 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002848 if c.IsVndk() && !c.isVndkExt() {
Jooyung Han38002912019-05-16 04:01:54 +09002849 if Bool(c.VendorProperties.Vendor_available) {
2850 return "native:vndk"
2851 }
2852 return "native:vndk_private"
2853 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09002854 if c.inProduct() {
2855 return "native:product"
2856 }
Jooyung Han38002912019-05-16 04:01:54 +09002857 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08002858 } else if c.InRamdisk() {
2859 return "native:ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07002860 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07002861 return "native:recovery"
2862 } else if c.Target().Os == android.Android && String(c.Properties.Sdk_version) != "" {
2863 return "native:ndk:none:none"
2864 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
2865 //family, link := getNdkStlFamilyAndLinkType(c)
2866 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07002867 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08002868 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07002869 } else {
2870 return "native:platform"
2871 }
2872}
2873
Jiyong Park9d452992018-10-03 00:38:19 +09002874// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01002875// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09002876func (c *Module) IsInstallableToApex() bool {
2877 if shared, ok := c.linker.(interface {
2878 shared() bool
2879 }); ok {
Jiyong Park73c54ee2019-10-22 20:31:18 +09002880 // Stub libs and prebuilt libs in a versioned SDK are not
2881 // installable to APEX even though they are shared libs.
2882 return shared.shared() && !c.IsStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01002883 } else if _, ok := c.linker.(testPerSrc); ok {
2884 return true
Jiyong Park9d452992018-10-03 00:38:19 +09002885 }
2886 return false
2887}
2888
Jiyong Parka90ca002019-10-07 15:47:24 +09002889func (c *Module) AvailableFor(what string) bool {
2890 if linker, ok := c.linker.(interface {
2891 availableFor(string) bool
2892 }); ok {
2893 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
2894 } else {
2895 return c.ApexModuleBase.AvailableFor(what)
2896 }
2897}
2898
Jiyong Park62304bb2020-04-13 16:19:48 +09002899func (c *Module) TestFor() []string {
2900 if test, ok := c.linker.(interface {
2901 testFor() []string
2902 }); ok {
2903 return test.testFor()
2904 } else {
2905 return c.ApexModuleBase.TestFor()
2906 }
2907}
2908
Colin Crossaede88c2020-08-11 12:17:01 -07002909func (c *Module) UniqueApexVariations() bool {
2910 if u, ok := c.compiler.(interface {
2911 uniqueApexVariations() bool
2912 }); ok {
2913 return u.uniqueApexVariations()
2914 } else {
2915 return false
2916 }
2917}
2918
Paul Duffin0cb37b92020-03-04 14:52:46 +00002919// Return true if the module is ever installable.
2920func (c *Module) EverInstallable() bool {
2921 return c.installer != nil &&
2922 // Check to see whether the module is actually ever installable.
2923 c.installer.everInstallable()
2924}
2925
Colin Cross56a83212020-09-15 18:30:11 -07002926func (c *Module) installable(apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00002927 ret := c.EverInstallable() &&
2928 // Check to see whether the module has been configured to not be installed.
2929 proptools.BoolDefault(c.Properties.Installable, true) &&
2930 !c.Properties.PreventInstall && c.outputFile.Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002931
2932 // The platform variant doesn't need further condition. Apex variants however might not
2933 // be installable because it will likely to be included in the APEX and won't appear
2934 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07002935 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002936 return ret
2937 }
2938
2939 // Special case for modules that are configured to be installed to /data, which includes
2940 // test modules. For these modules, both APEX and non-APEX variants are considered as
2941 // installable. This is because even the APEX variants won't be included in the APEX, but
2942 // will anyway be installed to /data/*.
2943 // See b/146995717
2944 if c.InstallInData() {
2945 return ret
2946 }
2947
2948 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09002949}
2950
Logan Chien41eabe62019-04-10 13:33:58 +08002951func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
2952 if c.linker != nil {
2953 if library, ok := c.linker.(*libraryDecorator); ok {
2954 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
2955 }
2956 }
2957}
2958
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002959func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07002960 depTag := ctx.OtherModuleDependencyTag(dep)
2961 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
2962
2963 if cc, ok := dep.(*Module); ok {
2964 if cc.HasStubsVariants() {
2965 if isLibDepTag && libDepTag.shared() {
2966 // dynamic dep to a stubs lib crosses APEX boundary
2967 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002968 }
Colin Cross6e511a92020-07-27 21:26:48 -07002969 if IsRuntimeDepTag(depTag) {
2970 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002971 return false
2972 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002973 }
Colin Crossaac32222020-07-29 12:51:56 -07002974 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07002975 // shared_lib dependency from a static lib is considered as crossing
2976 // the APEX boundary because the dependency doesn't actually is
2977 // linked; the dependency is used only during the compilation phase.
2978 return false
2979 }
2980 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002981 if depTag == stubImplDepTag || depTag == llndkImplDep {
2982 // We don't track beyond LLNDK or from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09002983 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002984 }
2985 return true
2986}
2987
Dan Albertc8060532020-07-22 22:32:17 -07002988func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2989 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09002990 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
2991 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
2992 return nil
2993 }
2994 // b/154569636: set min_sdk_version correctly for toolchain_libraries
2995 if c.ToolchainLibrary() {
2996 return nil
2997 }
2998 // We don't check for prebuilt modules
2999 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3000 return nil
3001 }
3002 minSdkVersion := c.MinSdkVersion()
3003 if minSdkVersion == "apex_inherit" {
3004 return nil
3005 }
3006 if minSdkVersion == "" {
3007 // JNI libs within APK-in-APEX fall into here
3008 // Those are okay to set sdk_version instead
3009 // We don't have to check if this is a SDK variant because
3010 // non-SDK variant resets sdk_version, which works too.
3011 minSdkVersion = c.SdkVersion()
3012 }
Dan Albertc8060532020-07-22 22:32:17 -07003013 if minSdkVersion == "" {
3014 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3015 }
3016 // Not using nativeApiLevelFromUser because the context here is not
3017 // necessarily a native context.
3018 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003019 if err != nil {
3020 return err
3021 }
Dan Albertc8060532020-07-22 22:32:17 -07003022
3023 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003024 return fmt.Errorf("newer SDK(%v)", ver)
3025 }
3026 return nil
3027}
3028
Colin Cross2ba19d92015-05-07 15:44:20 -07003029//
Colin Crosscfad1192015-11-02 16:43:11 -08003030// Defaults
3031//
Colin Crossca860ac2016-01-04 14:34:37 -08003032type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003033 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003034 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003035 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003036}
3037
Patrice Arrudac249c712019-03-19 17:00:29 -07003038// cc_defaults provides a set of properties that can be inherited by other cc
3039// modules. A module can use the properties from a cc_defaults using
3040// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3041// merged (when possible) by prepending the default module's values to the
3042// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003043func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003044 return DefaultsFactory()
3045}
3046
Colin Cross36242852017-06-23 15:06:31 -07003047func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003048 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003049
Colin Cross36242852017-06-23 15:06:31 -07003050 module.AddProperties(props...)
3051 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003052 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003053 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003054 &BaseCompilerProperties{},
3055 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003056 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003057 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003058 &StaticProperties{},
3059 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003060 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003061 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003062 &TestProperties{},
3063 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003064 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003065 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003066 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003067 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003068 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003069 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003070 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003071 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003072 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003073 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003074 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003075 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003076 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003077 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3078 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003079 )
Colin Crosscfad1192015-11-02 16:43:11 -08003080
Jooyung Hancc372c52019-09-25 15:18:44 +09003081 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003082
3083 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003084}
3085
Jiyong Park6a43f042017-10-12 23:05:00 +09003086func squashVendorSrcs(m *Module) {
3087 if lib, ok := m.compiler.(*libraryDecorator); ok {
3088 lib.baseCompiler.Properties.Srcs = append(lib.baseCompiler.Properties.Srcs,
3089 lib.baseCompiler.Properties.Target.Vendor.Srcs...)
3090
3091 lib.baseCompiler.Properties.Exclude_srcs = append(lib.baseCompiler.Properties.Exclude_srcs,
3092 lib.baseCompiler.Properties.Target.Vendor.Exclude_srcs...)
Jooyung Hanac07f882020-07-05 03:54:35 +09003093
3094 lib.baseCompiler.Properties.Exclude_generated_sources = append(lib.baseCompiler.Properties.Exclude_generated_sources,
3095 lib.baseCompiler.Properties.Target.Vendor.Exclude_generated_sources...)
Jiyong Park6a43f042017-10-12 23:05:00 +09003096 }
3097}
3098
Jiyong Parkf9332f12018-02-01 00:54:12 +09003099func squashRecoverySrcs(m *Module) {
3100 if lib, ok := m.compiler.(*libraryDecorator); ok {
3101 lib.baseCompiler.Properties.Srcs = append(lib.baseCompiler.Properties.Srcs,
3102 lib.baseCompiler.Properties.Target.Recovery.Srcs...)
3103
3104 lib.baseCompiler.Properties.Exclude_srcs = append(lib.baseCompiler.Properties.Exclude_srcs,
3105 lib.baseCompiler.Properties.Target.Recovery.Exclude_srcs...)
Jooyung Hanac07f882020-07-05 03:54:35 +09003106
3107 lib.baseCompiler.Properties.Exclude_generated_sources = append(lib.baseCompiler.Properties.Exclude_generated_sources,
3108 lib.baseCompiler.Properties.Target.Recovery.Exclude_generated_sources...)
Jiyong Parkf9332f12018-02-01 00:54:12 +09003109 }
3110}
3111
Jiyong Park2286afd2020-06-16 21:58:53 +09003112func (c *Module) IsSdkVariant() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07003113 return c.Properties.IsSdkVariant || c.AlwaysSdk()
Jiyong Park2286afd2020-06-16 21:58:53 +09003114}
3115
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003116func kytheExtractAllFactory() android.Singleton {
3117 return &kytheExtractAllSingleton{}
3118}
3119
3120type kytheExtractAllSingleton struct {
3121}
3122
3123func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3124 var xrefTargets android.Paths
3125 ctx.VisitAllModules(func(module android.Module) {
3126 if ccModule, ok := module.(xref); ok {
3127 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3128 }
3129 })
3130 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3131 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003132 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003133 }
3134}
3135
Colin Cross06a931b2015-10-28 17:23:31 -07003136var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003137var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003138var BoolPtr = proptools.BoolPtr
3139var String = proptools.String
3140var StringPtr = proptools.StringPtr