blob: b70e55c88215fffde9b225cc8604eeb2c2ee7aa4 [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) {
Inseob Kim64c43952019-08-26 16:52:35 +090045 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070046 ctx.BottomUp("link", LinkageMutator).Parallel()
Jooyung Hanb90e4912019-12-09 18:21:48 +090047 ctx.BottomUp("ndk_api", NdkApiMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010048 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Jiyong Park25fc6a92018-11-18 18:02:45 +090049 ctx.BottomUp("version", VersionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070050 ctx.BottomUp("begin", BeginMutator).Parallel()
Inseob Kimac1e9862019-12-09 18:15:47 +090051 ctx.BottomUp("sysprop_cc", SyspropMutator).Parallel()
Inseob Kimeec88e12020-01-22 11:11:29 +090052 ctx.BottomUp("vendor_snapshot", VendorSnapshotMutator).Parallel()
53 ctx.BottomUp("vendor_snapshot_source", VendorSnapshotSourceMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070054 })
Colin Cross16b23492016-01-06 14:41:07 -080055
Paul Duffin036e7002019-12-19 19:16:28 +000056 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Cross1e676be2016-10-12 14:38:15 -070057 ctx.TopDown("asan_deps", sanitizerDepsMutator(asan))
58 ctx.BottomUp("asan", sanitizerMutator(asan)).Parallel()
Colin Cross16b23492016-01-06 14:41:07 -080059
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070060 ctx.TopDown("hwasan_deps", sanitizerDepsMutator(hwasan))
61 ctx.BottomUp("hwasan", sanitizerMutator(hwasan)).Parallel()
62
Mitch Phillipsbfeade62019-05-01 14:42:05 -070063 ctx.TopDown("fuzzer_deps", sanitizerDepsMutator(fuzzer))
64 ctx.BottomUp("fuzzer", sanitizerMutator(fuzzer)).Parallel()
65
Jiyong Park1d1119f2019-07-29 21:27:18 +090066 // cfi mutator shouldn't run before sanitizers that return true for
67 // incompatibleWithCfi()
Vishwath Mohanb743e9c2017-11-01 09:20:21 +000068 ctx.TopDown("cfi_deps", sanitizerDepsMutator(cfi))
69 ctx.BottomUp("cfi", sanitizerMutator(cfi)).Parallel()
70
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -080071 ctx.TopDown("scs_deps", sanitizerDepsMutator(scs))
72 ctx.BottomUp("scs", sanitizerMutator(scs)).Parallel()
73
Colin Cross1e676be2016-10-12 14:38:15 -070074 ctx.TopDown("tsan_deps", sanitizerDepsMutator(tsan))
75 ctx.BottomUp("tsan", sanitizerMutator(tsan)).Parallel()
Dan Willemsen581341d2017-02-09 16:16:31 -080076
Colin Cross0b908332019-06-19 23:00:20 -070077 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090078 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080079
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080080 ctx.BottomUp("coverage", coverageMutator).Parallel()
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -080081 ctx.TopDown("vndk_deps", sabiDepsMutator)
Stephen Craneba090d12017-05-09 15:44:35 -070082
83 ctx.TopDown("lto_deps", ltoDepsMutator)
84 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090085
86 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070087 })
Colin Crossb98c8b02016-07-29 13:44:28 -070088
Sasha Smundak2a4549e2018-11-05 16:49:08 -080089 android.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070090}
91
Colin Crossca860ac2016-01-04 14:34:37 -080092type Deps struct {
93 SharedLibs, LateSharedLibs []string
94 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080095 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +080096 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -070097
Colin Cross5950f382016-12-13 12:50:57 -080098 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -070099
Colin Cross81413472016-04-11 14:37:39 -0700100 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700101
Dan Willemsenb40aab62016-04-20 14:21:14 -0700102 GeneratedSources []string
103 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900104 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700105
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700106 ReexportGeneratedHeaders []string
107
Colin Cross97ba0732015-03-23 17:50:24 -0700108 CrtBegin, CrtEnd string
Dan Willemsena0790e32018-10-12 00:24:23 -0700109
110 // Used for host bionic
111 LinkerFlagsFile string
112 DynamicLinker string
Colin Crossc472d572015-03-17 15:06:21 -0700113}
114
Colin Crossca860ac2016-01-04 14:34:37 -0800115type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700116 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900117 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700118 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900119 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700120 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700121 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700122
Colin Cross26c34ed2016-09-30 17:10:16 -0700123 // Paths to .o files
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700124 Objs Objects
Dan Willemsen581341d2017-02-09 16:16:31 -0800125 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700126 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700127
Colin Cross26c34ed2016-09-30 17:10:16 -0700128 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700129 GeneratedSources android.Paths
130 GeneratedHeaders android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900131 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700132
Inseob Kimd110f872019-12-06 13:15:38 +0900133 Flags []string
134 IncludeDirs android.Paths
135 SystemIncludeDirs android.Paths
136 ReexportedDirs android.Paths
137 ReexportedSystemDirs android.Paths
138 ReexportedFlags []string
139 ReexportedGeneratedHeaders android.Paths
140 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700141
Colin Cross26c34ed2016-09-30 17:10:16 -0700142 // Paths to crt*.o files
Colin Cross635c3b02016-05-18 15:37:25 -0700143 CrtBegin, CrtEnd android.OptionalPath
Dan Willemsena0790e32018-10-12 00:24:23 -0700144
145 // Path to the file container flags to use with the linker
146 LinkerFlagsFile android.OptionalPath
147
148 // Path to the dynamic linker binary
149 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700150}
151
Colin Cross4af21ed2019-11-04 09:37:55 -0800152// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
153// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
154// command line so they can be overridden by the local module flags).
155type LocalOrGlobalFlags struct {
156 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700157 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800158 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700159 CFlags []string // Flags that apply to C and C++ source files
160 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
161 ConlyFlags []string // Flags that apply to C source files
162 CppFlags []string // Flags that apply to C++ source files
163 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700164 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800165}
166
167type Flags struct {
168 Local LocalOrGlobalFlags
169 Global LocalOrGlobalFlags
170
171 aidlFlags []string // Flags that apply to aidl source files
172 rsFlags []string // Flags that apply to renderscript source files
173 libFlags []string // Flags to add libraries early to the link order
174 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
175 TidyFlags []string // Flags that apply to clang-tidy
176 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700177
Colin Crossc3199482017-03-30 15:03:04 -0700178 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800179 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700180 SystemIncludeFlags []string
181
Colin Crossb98c8b02016-07-29 13:44:28 -0700182 Toolchain config.Toolchain
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700183 Tidy bool
Dan Willemsen581341d2017-02-09 16:16:31 -0800184 Coverage bool
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800185 SAbiDump bool
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800186 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800187
188 RequiredInstructionSet string
Colin Cross16b23492016-01-06 14:41:07 -0800189 DynamicLinker string
190
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700191 CFlagsDeps android.Paths // Files depended on by compiler flags
192 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800193
Dan Willemsen98ab3112019-08-27 21:20:40 -0700194 AssemblerWithCpp bool
195 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800196
Colin Cross19878da2019-03-28 14:45:07 -0700197 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700198 protoC bool // Whether to use C instead of C++
199 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700200
201 Yacc *YaccProperties
Colin Crossc472d572015-03-17 15:06:21 -0700202}
203
Colin Crossca860ac2016-01-04 14:34:37 -0800204// Properties used to compile all C or C++ modules
205type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700206 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800207 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700208
209 // Minimum sdk version supported when compiling against the ndk
Nan Zhang0007d812017-11-07 10:57:05 -0800210 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700211
Jiyong Parkde866cb2018-12-07 23:08:36 +0900212 AndroidMkSharedLibs []string `blueprint:"mutated"`
213 AndroidMkStaticLibs []string `blueprint:"mutated"`
214 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
215 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
216 HideFromMake bool `blueprint:"mutated"`
217 PreventInstall bool `blueprint:"mutated"`
218 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700219
Justin Yun5f7f7e82019-11-18 19:52:14 +0900220 ImageVariationPrefix string `blueprint:"mutated"`
221 VndkVersion string `blueprint:"mutated"`
222 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800223
224 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
225 // file
226 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900227
Yifan Hong1b3348d2020-01-21 15:53:22 -0800228 // Make this module available when building for ramdisk
229 Ramdisk_available *bool
230
Jiyong Parkf9332f12018-02-01 00:54:12 +0900231 // Make this module available when building for recovery
232 Recovery_available *bool
233
Colin Crossae6c5202019-11-20 13:35:50 -0800234 // Set by imageMutator
Colin Cross7228ecd2019-11-18 16:00:16 -0800235 CoreVariantNeeded bool `blueprint:"mutated"`
Yifan Hong1b3348d2020-01-21 15:53:22 -0800236 RamdiskVariantNeeded bool `blueprint:"mutated"`
Colin Cross7228ecd2019-11-18 16:00:16 -0800237 RecoveryVariantNeeded bool `blueprint:"mutated"`
Justin Yun5f7f7e82019-11-18 19:52:14 +0900238 ExtraVariants []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900239
240 // Allows this module to use non-APEX version of libraries. Useful
241 // for building binaries that are started before APEXes are activated.
242 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900243
244 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
245 // see soong/cc/config/vndk.go
246 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900247
248 // Used by vendor snapshot to record dependencies from snapshot modules.
249 SnapshotSharedLibs []string `blueprint:"mutated"`
250 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700251}
252
253type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900254 // whether this module should be allowed to be directly depended by other
255 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun5f7f7e82019-11-18 19:52:14 +0900256 // In addition, this module should be allowed to be directly depended by
257 // product modules with `product_specific: true`.
258 // If set to true, three variants will be built separately, one like
259 // normal, another limited to the set of libraries and headers
260 // that are exposed to /vendor modules, and the other to /product modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700261 //
Justin Yun5f7f7e82019-11-18 19:52:14 +0900262 // The vendor and product variants may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700263 // so it shouldn't have any unversioned runtime dependencies, or
264 // make assumptions about the system that may not be true in the
265 // future.
266 //
Justin Yun5f7f7e82019-11-18 19:52:14 +0900267 // If set to false, this module becomes inaccessible from /vendor or /product
268 // modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900269 //
270 // Default value is true when vndk: {enabled: true} or vendor: true.
271 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700272 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
Justin Yun5f7f7e82019-11-18 19:52:14 +0900273 // If PRODUCT_PRODUCT_VNDK_VERSION isn't set, product variant will not be used.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700274 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900275
276 // whether this module is capable of being loaded with other instance
277 // (possibly an older version) of the same module in the same process.
278 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
279 // can be double loaded in a vendor process if the library is also a
280 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
281 // explicitly marked as `double_loadable: true` by the owner, or the dependency
282 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
283 Double_loadable *bool
Colin Crossca860ac2016-01-04 14:34:37 -0800284}
285
Colin Crossca860ac2016-01-04 14:34:37 -0800286type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800287 static() bool
288 staticBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900289 header() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700290 toolchain() config.Toolchain
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700291 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800292 sdkVersion() string
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700293 useVndk() bool
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800294 isNdk() bool
Inseob Kim9516ee92019-05-09 10:56:13 +0900295 isLlndk(config android.Config) bool
296 isLlndkPublic(config android.Config) bool
297 isVndkPrivate(config android.Config) bool
Justin Yun8effde42017-06-23 19:24:43 +0900298 isVndk() bool
299 isVndkSp() bool
Logan Chienf3511742017-10-31 18:04:35 +0800300 isVndkExt() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900301 inProduct() bool
302 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800303 inRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900304 inRecovery() bool
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +0800305 shouldCreateSourceAbiDump() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700306 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700307 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800308 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800309 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800310 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800311 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800312 isForPlatform() bool
Jiyong Park58e364a2019-01-19 19:24:06 +0900313 apexName() string
Jiyong Parkb0788572018-12-20 22:10:17 +0900314 hasStubsVariants() bool
315 isStubs() bool
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900316 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800317 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700318 nativeCoverage() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800319}
320
321type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700322 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800323 ModuleContextIntf
324}
325
326type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700327 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800328 ModuleContextIntf
329}
330
Colin Cross37047f12016-12-13 17:06:13 -0800331type DepsContext interface {
332 android.BottomUpMutatorContext
333 ModuleContextIntf
334}
335
Colin Crossca860ac2016-01-04 14:34:37 -0800336type feature interface {
337 begin(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800338 deps(ctx DepsContext, deps Deps) Deps
Colin Crossca860ac2016-01-04 14:34:37 -0800339 flags(ctx ModuleContext, flags Flags) Flags
340 props() []interface{}
341}
342
343type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700344 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800345 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800346 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700347 compilerProps() []interface{}
348
Colin Cross76fada02016-07-27 10:31:13 -0700349 appendCflags([]string)
350 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700351 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800352}
353
354type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700355 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800356 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700357 linkerFlags(ctx ModuleContext, flags Flags) Flags
358 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800359 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700360
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700361 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700362 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900363 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700364
365 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900366 coverageOutputFilePath() android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800367}
368
369type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700370 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700371 install(ctx ModuleContext, path android.Path)
Colin Crossca860ac2016-01-04 14:34:37 -0800372 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700373 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700374 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900375 relativeInstallPath() string
Colin Crossca860ac2016-01-04 14:34:37 -0800376}
377
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800378type xref interface {
379 XrefCcFiles() android.Paths
380}
381
Colin Crossc99deeb2016-04-11 15:06:20 -0700382var (
Ivan Lozano183a3212019-10-18 14:18:45 -0700383 sharedExportDepTag = DependencyTag{Name: "shared", Library: true, Shared: true, ReexportFlags: true}
384 earlySharedDepTag = DependencyTag{Name: "early_shared", Library: true, Shared: true}
385 lateSharedDepTag = DependencyTag{Name: "late shared", Library: true, Shared: true}
386 staticExportDepTag = DependencyTag{Name: "static", Library: true, ReexportFlags: true}
387 lateStaticDepTag = DependencyTag{Name: "late static", Library: true}
388 wholeStaticDepTag = DependencyTag{Name: "whole static", Library: true, ReexportFlags: true}
389 headerDepTag = DependencyTag{Name: "header", Library: true}
390 headerExportDepTag = DependencyTag{Name: "header", Library: true, ReexportFlags: true}
391 genSourceDepTag = DependencyTag{Name: "gen source"}
392 genHeaderDepTag = DependencyTag{Name: "gen header"}
393 genHeaderExportDepTag = DependencyTag{Name: "gen header", ReexportFlags: true}
394 objDepTag = DependencyTag{Name: "obj"}
395 linkerFlagsDepTag = DependencyTag{Name: "linker flags file"}
396 dynamicLinkerDepTag = DependencyTag{Name: "dynamic linker"}
397 reuseObjTag = DependencyTag{Name: "reuse objects"}
398 staticVariantTag = DependencyTag{Name: "static variant"}
399 ndkStubDepTag = DependencyTag{Name: "ndk stub", Library: true}
400 ndkLateStubDepTag = DependencyTag{Name: "ndk late stub", Library: true}
401 vndkExtDepTag = DependencyTag{Name: "vndk extends", Library: true}
402 runtimeDepTag = DependencyTag{Name: "runtime lib"}
403 coverageDepTag = DependencyTag{Name: "coverage"}
404 testPerSrcDepTag = DependencyTag{Name: "test_per_src"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700405)
406
Roland Levillainf89cd092019-07-29 16:22:59 +0100407func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Ivan Lozano183a3212019-10-18 14:18:45 -0700408 ccDepTag, ok := depTag.(DependencyTag)
409 return ok && ccDepTag.Shared
Roland Levillainf89cd092019-07-29 16:22:59 +0100410}
411
412func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Ivan Lozano183a3212019-10-18 14:18:45 -0700413 ccDepTag, ok := depTag.(DependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100414 return ok && ccDepTag == runtimeDepTag
415}
416
417func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Ivan Lozano183a3212019-10-18 14:18:45 -0700418 ccDepTag, ok := depTag.(DependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100419 return ok && ccDepTag == testPerSrcDepTag
420}
421
Colin Crossca860ac2016-01-04 14:34:37 -0800422// Module contains the properties and members used by all C/C++ module types, and implements
423// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
424// to construct the output file. Behavior can be customized with a Customizer interface
425type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700426 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700427 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900428 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900429 android.SdkBase
Colin Crossc472d572015-03-17 15:06:21 -0700430
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700431 Properties BaseProperties
432 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700433
Colin Crossca860ac2016-01-04 14:34:37 -0800434 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700435 hod android.HostOrDeviceSupported
436 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700437
Paul Duffina0843f62019-12-13 19:50:38 +0000438 // Allowable SdkMemberTypes of this module type.
439 sdkMemberTypes []android.SdkMemberType
440
Colin Crossca860ac2016-01-04 14:34:37 -0800441 // delegates, initialize before calling Init
Colin Crossb4ce0ec2016-09-13 13:41:39 -0700442 features []feature
443 compiler compiler
444 linker linker
445 installer installer
446 stl *stl
447 sanitize *sanitize
Dan Willemsen581341d2017-02-09 16:16:31 -0800448 coverage *coverage
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800449 sabi *sabi
Justin Yun8effde42017-06-23 19:24:43 +0900450 vndkdep *vndkdep
Stephen Craneba090d12017-05-09 15:44:35 -0700451 lto *lto
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700452 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800453
Colin Cross635c3b02016-05-18 15:37:25 -0700454 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800455
Colin Crossb98c8b02016-07-29 13:44:28 -0700456 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700457
458 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800459
460 // Flags used to compile this module
461 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700462
463 // When calling a linker, if module A depends on module B, then A must precede B in its command
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800464 // line invocation. depsInLinkOrder stores the proper ordering of all of the transitive
Jeff Gaston294356f2017-09-27 17:05:30 -0700465 // deps of this module
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800466 depsInLinkOrder android.Paths
467
468 // only non-nil when this is a shared library that reuses the objects of a static library
Ivan Lozano52767be2019-10-18 14:49:46 -0700469 staticVariant LinkableInterface
Inseob Kim9516ee92019-05-09 10:56:13 +0900470
471 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800472 // Kythe (source file indexer) paths for this compilation module
473 kytheFiles android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700474}
475
Ivan Lozano52767be2019-10-18 14:49:46 -0700476func (c *Module) Toc() android.OptionalPath {
477 if c.linker != nil {
478 if library, ok := c.linker.(libraryInterface); ok {
479 return library.toc()
480 }
481 }
482 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
483}
484
485func (c *Module) ApiLevel() string {
486 if c.linker != nil {
487 if stub, ok := c.linker.(*stubDecorator); ok {
488 return stub.properties.ApiLevel
489 }
490 }
491 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
492}
493
494func (c *Module) Static() bool {
495 if c.linker != nil {
496 if library, ok := c.linker.(libraryInterface); ok {
497 return library.static()
498 }
499 }
500 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
501}
502
503func (c *Module) Shared() bool {
504 if c.linker != nil {
505 if library, ok := c.linker.(libraryInterface); ok {
506 return library.shared()
507 }
508 }
509 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
510}
511
512func (c *Module) SelectedStl() string {
513 return c.stl.Properties.SelectedStl
514}
515
516func (c *Module) ToolchainLibrary() bool {
517 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
518 return true
519 }
520 return false
521}
522
523func (c *Module) NdkPrebuiltStl() bool {
524 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
525 return true
526 }
527 return false
528}
529
530func (c *Module) StubDecorator() bool {
531 if _, ok := c.linker.(*stubDecorator); ok {
532 return true
533 }
534 return false
535}
536
537func (c *Module) SdkVersion() string {
538 return String(c.Properties.Sdk_version)
539}
540
Ivan Lozanoe0833b12019-11-06 19:15:49 -0800541func (c *Module) IncludeDirs() android.Paths {
Ivan Lozano183a3212019-10-18 14:18:45 -0700542 if c.linker != nil {
543 if library, ok := c.linker.(exportedFlagsProducer); ok {
544 return library.exportedDirs()
545 }
546 }
547 panic(fmt.Errorf("IncludeDirs called on non-exportedFlagsProducer module: %q", c.BaseModuleName()))
548}
549
550func (c *Module) HasStaticVariant() bool {
551 if c.staticVariant != nil {
552 return true
553 }
554 return false
555}
556
557func (c *Module) GetStaticVariant() LinkableInterface {
558 return c.staticVariant
559}
560
561func (c *Module) SetDepsInLinkOrder(depsInLinkOrder []android.Path) {
562 c.depsInLinkOrder = depsInLinkOrder
563}
564
565func (c *Module) GetDepsInLinkOrder() []android.Path {
566 return c.depsInLinkOrder
567}
568
569func (c *Module) StubsVersions() []string {
570 if c.linker != nil {
571 if library, ok := c.linker.(*libraryDecorator); ok {
572 return library.Properties.Stubs.Versions
573 }
574 }
575 panic(fmt.Errorf("StubsVersions called on non-library module: %q", c.BaseModuleName()))
576}
577
578func (c *Module) CcLibrary() bool {
579 if c.linker != nil {
580 if _, ok := c.linker.(*libraryDecorator); ok {
581 return true
582 }
583 }
584 return false
585}
586
587func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700588 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700589 return true
590 }
591 return false
592}
593
Ivan Lozano2b262972019-11-21 12:30:50 -0800594func (c *Module) NonCcVariants() bool {
595 return false
596}
597
Ivan Lozano183a3212019-10-18 14:18:45 -0700598func (c *Module) SetBuildStubs() {
599 if c.linker != nil {
600 if library, ok := c.linker.(*libraryDecorator); ok {
601 library.MutatedProperties.BuildStubs = true
Ivan Lozano52767be2019-10-18 14:49:46 -0700602 c.Properties.HideFromMake = true
603 c.sanitize = nil
604 c.stl = nil
605 c.Properties.PreventInstall = true
Ivan Lozano183a3212019-10-18 14:18:45 -0700606 return
607 }
608 }
609 panic(fmt.Errorf("SetBuildStubs called on non-library module: %q", c.BaseModuleName()))
610}
611
Ivan Lozano52767be2019-10-18 14:49:46 -0700612func (c *Module) BuildStubs() bool {
613 if c.linker != nil {
614 if library, ok := c.linker.(*libraryDecorator); ok {
615 return library.buildStubs()
616 }
617 }
618 panic(fmt.Errorf("BuildStubs called on non-library module: %q", c.BaseModuleName()))
619}
620
Ivan Lozano183a3212019-10-18 14:18:45 -0700621func (c *Module) SetStubsVersions(version string) {
622 if c.linker != nil {
623 if library, ok := c.linker.(*libraryDecorator); ok {
624 library.MutatedProperties.StubsVersion = version
625 return
626 }
627 }
628 panic(fmt.Errorf("SetStubsVersions called on non-library module: %q", c.BaseModuleName()))
629}
630
631func (c *Module) SetStatic() {
632 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700633 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700634 library.setStatic()
635 return
636 }
637 }
638 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
639}
640
641func (c *Module) SetShared() {
642 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700643 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700644 library.setShared()
645 return
646 }
647 }
648 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
649}
650
651func (c *Module) BuildStaticVariant() bool {
652 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700653 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700654 return library.buildStatic()
655 }
656 }
657 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
658}
659
660func (c *Module) BuildSharedVariant() bool {
661 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700662 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700663 return library.buildShared()
664 }
665 }
666 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
667}
668
669func (c *Module) Module() android.Module {
670 return c
671}
672
Jiyong Parkc20eee32018-09-05 22:36:17 +0900673func (c *Module) OutputFile() android.OptionalPath {
674 return c.outputFile
675}
676
Ivan Lozano183a3212019-10-18 14:18:45 -0700677var _ LinkableInterface = (*Module)(nil)
678
Jiyong Park719b4462019-01-13 00:39:51 +0900679func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900680 if c.linker != nil {
681 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +0900682 }
683 return nil
684}
685
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900686func (c *Module) CoverageOutputFile() android.OptionalPath {
687 if c.linker != nil {
688 return c.linker.coverageOutputFilePath()
689 }
690 return android.OptionalPath{}
691}
692
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900693func (c *Module) RelativeInstallPath() string {
694 if c.installer != nil {
695 return c.installer.relativeInstallPath()
696 }
697 return ""
698}
699
Jooyung Han344d5432019-08-23 11:17:39 +0900700func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +0900701 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +0900702}
703
Colin Cross36242852017-06-23 15:06:31 -0700704func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -0700705 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -0800706 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -0700707 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800708 }
709 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -0700710 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800711 }
712 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -0700713 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800714 }
Colin Crossa8e07cc2016-04-04 15:07:06 -0700715 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -0700716 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -0700717 }
Colin Cross16b23492016-01-06 14:41:07 -0800718 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -0700719 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -0800720 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800721 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -0700722 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -0800723 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800724 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -0700725 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800726 }
Justin Yun8effde42017-06-23 19:24:43 +0900727 if c.vndkdep != nil {
728 c.AddProperties(c.vndkdep.props()...)
729 }
Stephen Craneba090d12017-05-09 15:44:35 -0700730 if c.lto != nil {
731 c.AddProperties(c.lto.props()...)
732 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700733 if c.pgo != nil {
734 c.AddProperties(c.pgo.props()...)
735 }
Colin Crossca860ac2016-01-04 14:34:37 -0800736 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -0700737 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800738 }
Colin Crossc472d572015-03-17 15:06:21 -0700739
Colin Crossa9d8bee2018-10-02 13:59:46 -0700740 c.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool {
741 switch class {
742 case android.Device:
743 return ctx.Config().DevicePrefer32BitExecutables()
744 case android.HostCross:
745 // Windows builds always prefer 32-bit
746 return true
747 default:
748 return false
749 }
750 })
Colin Cross36242852017-06-23 15:06:31 -0700751 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +0900752 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900753 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +0900754 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +0900755
Colin Cross36242852017-06-23 15:06:31 -0700756 return c
Colin Crossc472d572015-03-17 15:06:21 -0700757}
758
Colin Crossb916a382016-07-29 17:28:03 -0700759// Returns true for dependency roots (binaries)
760// TODO(ccross): also handle dlopenable libraries
761func (c *Module) isDependencyRoot() bool {
762 if root, ok := c.linker.(interface {
763 isDependencyRoot() bool
764 }); ok {
765 return root.isDependencyRoot()
766 }
767 return false
768}
769
Justin Yun5f7f7e82019-11-18 19:52:14 +0900770// Returns true if the module is using VNDK libraries instead of the libraries in /system/lib or /system/lib64.
771// "product" and "vendor" variant modules return true for this function.
772// When BOARD_VNDK_VERSION is set, vendor variants of "vendor_available: true", "vendor: true",
773// "soc_specific: true" and more vendor installed modules are included here.
774// When PRODUCT_PRODUCT_VNDK_VERSION is set, product variants of "vendor_available: true" or
775// "product_specific: true" modules are included here.
Ivan Lozano52767be2019-10-18 14:49:46 -0700776func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +0900777 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700778}
779
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800780func (c *Module) isCoverageVariant() bool {
781 return c.coverage.Properties.IsCoverageVariant
782}
783
Peter Collingbournead84f972019-12-17 16:46:18 -0800784func (c *Module) IsNdk() bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800785 return inList(c.Name(), ndkMigratedLibs)
786}
787
Inseob Kim9516ee92019-05-09 10:56:13 +0900788func (c *Module) isLlndk(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800789 // Returns true for both LLNDK (public) and LLNDK-private libs.
Jooyung Han0302a842019-10-30 18:43:49 +0900790 return isLlndkLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800791}
792
Inseob Kim9516ee92019-05-09 10:56:13 +0900793func (c *Module) isLlndkPublic(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800794 // Returns true only for LLNDK (public) libs.
Jooyung Han0302a842019-10-30 18:43:49 +0900795 name := c.BaseModuleName()
796 return isLlndkLibrary(name, config) && !isVndkPrivateLibrary(name, config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800797}
798
Inseob Kim9516ee92019-05-09 10:56:13 +0900799func (c *Module) isVndkPrivate(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800800 // Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Jooyung Han0302a842019-10-30 18:43:49 +0900801 return isVndkPrivateLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +0800802}
803
Ivan Lozano52767be2019-10-18 14:49:46 -0700804func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +0800805 if vndkdep := c.vndkdep; vndkdep != nil {
806 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +0900807 }
808 return false
809}
810
Yi Kong7e53c572018-02-14 18:16:12 +0800811func (c *Module) isPgoCompile() bool {
812 if pgo := c.pgo; pgo != nil {
813 return pgo.Properties.PgoCompile
814 }
815 return false
816}
817
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800818func (c *Module) isNDKStubLibrary() bool {
819 if _, ok := c.compiler.(*stubDecorator); ok {
820 return true
821 }
822 return false
823}
824
Logan Chienf3511742017-10-31 18:04:35 +0800825func (c *Module) isVndkSp() bool {
826 if vndkdep := c.vndkdep; vndkdep != nil {
827 return vndkdep.isVndkSp()
828 }
829 return false
830}
831
832func (c *Module) isVndkExt() bool {
833 if vndkdep := c.vndkdep; vndkdep != nil {
834 return vndkdep.isVndkExt()
835 }
836 return false
837}
838
Ivan Lozano52767be2019-10-18 14:49:46 -0700839func (c *Module) MustUseVendorVariant() bool {
Jooyung Han097087b2019-10-22 19:32:18 +0900840 return c.isVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -0800841}
842
Logan Chienf3511742017-10-31 18:04:35 +0800843func (c *Module) getVndkExtendsModuleName() string {
844 if vndkdep := c.vndkdep; vndkdep != nil {
845 return vndkdep.getVndkExtendsModuleName()
846 }
847 return ""
848}
849
Justin Yun5f7f7e82019-11-18 19:52:14 +0900850// Returns true only when this module is configured to have core, product and vendor
Jiyong Park82e2bf32017-08-16 14:05:54 +0900851// variants.
Ivan Lozano52767be2019-10-18 14:49:46 -0700852func (c *Module) HasVendorVariant() bool {
853 return c.IsVndk() || Bool(c.VendorProperties.Vendor_available)
Jiyong Park82e2bf32017-08-16 14:05:54 +0900854}
855
Justin Yun5f7f7e82019-11-18 19:52:14 +0900856const (
857 // VendorVariationPrefix is the variant prefix used for /vendor code that compiles
858 // against the VNDK.
859 VendorVariationPrefix = "vendor."
860
861 // ProductVariationPrefix is the variant prefix used for /product code that compiles
862 // against the VNDK.
863 ProductVariationPrefix = "product."
864)
865
866// Returns true if the module is "product" variant. Usually these modules are installed in /product
867func (c *Module) inProduct() bool {
868 return c.Properties.ImageVariationPrefix == ProductVariationPrefix
869}
870
871// Returns true if the module is "vendor" variant. Usually these modules are installed in /vendor
872func (c *Module) inVendor() bool {
873 return c.Properties.ImageVariationPrefix == VendorVariationPrefix
874}
875
Yifan Hong1b3348d2020-01-21 15:53:22 -0800876func (c *Module) InRamdisk() bool {
877 return c.ModuleBase.InRamdisk() || c.ModuleBase.InstallInRamdisk()
878}
879
Ivan Lozano52767be2019-10-18 14:49:46 -0700880func (c *Module) InRecovery() bool {
Colin Cross7228ecd2019-11-18 16:00:16 -0800881 return c.ModuleBase.InRecovery() || c.ModuleBase.InstallInRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +0900882}
883
Yifan Hong1b3348d2020-01-21 15:53:22 -0800884func (c *Module) OnlyInRamdisk() bool {
885 return c.ModuleBase.InstallInRamdisk()
886}
887
Ivan Lozano52767be2019-10-18 14:49:46 -0700888func (c *Module) OnlyInRecovery() bool {
Jiyong Parkf9332f12018-02-01 00:54:12 +0900889 return c.ModuleBase.InstallInRecovery()
890}
891
Jiyong Park25fc6a92018-11-18 18:02:45 +0900892func (c *Module) IsStubs() bool {
893 if library, ok := c.linker.(*libraryDecorator); ok {
894 return library.buildStubs()
Jiyong Park379de2f2018-12-19 02:47:14 +0900895 } else if _, ok := c.linker.(*llndkStubDecorator); ok {
896 return true
Jiyong Park25fc6a92018-11-18 18:02:45 +0900897 }
898 return false
899}
900
901func (c *Module) HasStubsVariants() bool {
902 if library, ok := c.linker.(*libraryDecorator); ok {
903 return len(library.Properties.Stubs.Versions) > 0
904 }
Peter Collingbourne3478bb22019-04-24 14:41:12 -0700905 if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
906 return len(library.Properties.Stubs.Versions) > 0
907 }
Jiyong Park25fc6a92018-11-18 18:02:45 +0900908 return false
909}
910
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900911func (c *Module) bootstrap() bool {
912 return Bool(c.Properties.Bootstrap)
913}
914
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700915func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -0700916 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
917 if c.Target().NativeBridge == android.NativeBridgeEnabled {
918 return false
919 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700920 return c.linker != nil && c.linker.nativeCoverage()
921}
922
Inseob Kim8471cda2019-11-15 09:59:12 +0900923func (c *Module) isSnapshotPrebuilt() bool {
Inseob Kimeec88e12020-01-22 11:11:29 +0900924 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
925 return true
926 }
927 if _, ok := c.linker.(*vendorSnapshotLibraryDecorator); ok {
928 return true
929 }
930 if _, ok := c.linker.(*vendorSnapshotBinaryDecorator); ok {
931 return true
932 }
933 return false
Inseob Kim8471cda2019-11-15 09:59:12 +0900934}
935
Jiyong Park73c54ee2019-10-22 20:31:18 +0900936func (c *Module) ExportedIncludeDirs() android.Paths {
937 if flagsProducer, ok := c.linker.(exportedFlagsProducer); ok {
938 return flagsProducer.exportedDirs()
939 }
Jiyong Park232e7852019-11-04 12:23:40 +0900940 return nil
Jiyong Park73c54ee2019-10-22 20:31:18 +0900941}
942
943func (c *Module) ExportedSystemIncludeDirs() android.Paths {
944 if flagsProducer, ok := c.linker.(exportedFlagsProducer); ok {
945 return flagsProducer.exportedSystemDirs()
946 }
Jiyong Park232e7852019-11-04 12:23:40 +0900947 return nil
Jiyong Park73c54ee2019-10-22 20:31:18 +0900948}
949
950func (c *Module) ExportedFlags() []string {
951 if flagsProducer, ok := c.linker.(exportedFlagsProducer); ok {
952 return flagsProducer.exportedFlags()
953 }
Jiyong Park232e7852019-11-04 12:23:40 +0900954 return nil
955}
956
957func (c *Module) ExportedDeps() android.Paths {
958 if flagsProducer, ok := c.linker.(exportedFlagsProducer); ok {
959 return flagsProducer.exportedDeps()
960 }
961 return nil
Jiyong Park73c54ee2019-10-22 20:31:18 +0900962}
963
Inseob Kimd110f872019-12-06 13:15:38 +0900964func (c *Module) ExportedGeneratedHeaders() android.Paths {
965 if flagsProducer, ok := c.linker.(exportedFlagsProducer); ok {
966 return flagsProducer.exportedGeneratedHeaders()
967 }
968 return nil
969}
970
Jiyong Parkf1194352019-02-25 11:05:47 +0900971func isBionic(name string) bool {
972 switch name {
Martin Stjernholm203489b2019-11-11 15:33:27 +0000973 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +0900974 return true
975 }
976 return false
977}
978
Martin Stjernholm279de572019-09-10 23:18:20 +0100979func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -0700980 if name == "libclang_rt.hwasan-aarch64-android" {
981 return inList("hwaddress", config.SanitizeDevice())
982 }
983 return isBionic(name)
984}
985
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800986func (c *Module) XrefCcFiles() android.Paths {
987 return c.kytheFiles
988}
989
Colin Crossca860ac2016-01-04 14:34:37 -0800990type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700991 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800992 moduleContextImpl
993}
994
Colin Cross37047f12016-12-13 17:06:13 -0800995type depsContext struct {
996 android.BottomUpMutatorContext
997 moduleContextImpl
998}
999
Colin Crossca860ac2016-01-04 14:34:37 -08001000type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001001 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001002 moduleContextImpl
1003}
1004
Justin Yun5f7f7e82019-11-18 19:52:14 +09001005func (ctx *moduleContext) ProductSpecific() bool {
1006 return ctx.ModuleContext.ProductSpecific() ||
1007 (ctx.mod.HasVendorVariant() && ctx.mod.inProduct() && !ctx.mod.IsVndk())
1008}
1009
Jiyong Park2db76922017-11-08 16:03:48 +09001010func (ctx *moduleContext) SocSpecific() bool {
1011 return ctx.ModuleContext.SocSpecific() ||
Justin Yun5f7f7e82019-11-18 19:52:14 +09001012 (ctx.mod.HasVendorVariant() && ctx.mod.inVendor() && !ctx.mod.IsVndk())
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001013}
1014
Colin Crossca860ac2016-01-04 14:34:37 -08001015type moduleContextImpl struct {
1016 mod *Module
1017 ctx BaseModuleContext
1018}
1019
Colin Crossb98c8b02016-07-29 13:44:28 -07001020func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001021 return ctx.mod.toolchain(ctx.ctx)
1022}
1023
1024func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001025 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001026}
1027
1028func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001029 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001030}
1031
Jiyong Park1d1119f2019-07-29 21:27:18 +09001032func (ctx *moduleContextImpl) header() bool {
1033 return ctx.mod.header()
1034}
1035
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001036func (ctx *moduleContextImpl) useSdk() bool {
Yifan Hong1b3348d2020-01-21 15:53:22 -08001037 if ctx.ctx.Device() && !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inRecovery() && !ctx.ctx.Fuchsia() {
Nan Zhang0007d812017-11-07 10:57:05 -08001038 return String(ctx.mod.Properties.Sdk_version) != ""
Dan Willemsena96ff642016-06-07 12:34:45 -07001039 }
1040 return false
Colin Crossca860ac2016-01-04 14:34:37 -08001041}
1042
1043func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001044 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001045 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001046 vndkVer := ctx.mod.VndkVersion()
1047 if inList(vndkVer, ctx.ctx.Config().PlatformVersionCombinedCodenames()) {
1048 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001049 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001050 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001051 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001052 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001053 }
1054 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001055}
1056
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001057func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001058 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001059}
Justin Yun8effde42017-06-23 19:24:43 +09001060
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001061func (ctx *moduleContextImpl) isNdk() bool {
Peter Collingbournead84f972019-12-17 16:46:18 -08001062 return ctx.mod.IsNdk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001063}
1064
Inseob Kim9516ee92019-05-09 10:56:13 +09001065func (ctx *moduleContextImpl) isLlndk(config android.Config) bool {
1066 return ctx.mod.isLlndk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001067}
1068
Inseob Kim9516ee92019-05-09 10:56:13 +09001069func (ctx *moduleContextImpl) isLlndkPublic(config android.Config) bool {
1070 return ctx.mod.isLlndkPublic(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001071}
1072
Inseob Kim9516ee92019-05-09 10:56:13 +09001073func (ctx *moduleContextImpl) isVndkPrivate(config android.Config) bool {
1074 return ctx.mod.isVndkPrivate(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001075}
1076
Logan Chienf3511742017-10-31 18:04:35 +08001077func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001078 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001079}
1080
Yi Kong7e53c572018-02-14 18:16:12 +08001081func (ctx *moduleContextImpl) isPgoCompile() bool {
1082 return ctx.mod.isPgoCompile()
1083}
1084
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001085func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1086 return ctx.mod.isNDKStubLibrary()
1087}
1088
Justin Yun8effde42017-06-23 19:24:43 +09001089func (ctx *moduleContextImpl) isVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001090 return ctx.mod.isVndkSp()
1091}
1092
1093func (ctx *moduleContextImpl) isVndkExt() bool {
1094 return ctx.mod.isVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001095}
1096
Vic Yangefd249e2018-11-12 20:19:56 -08001097func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001098 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001099}
1100
Justin Yun5f7f7e82019-11-18 19:52:14 +09001101func (ctx *moduleContextImpl) inProduct() bool {
1102 return ctx.mod.inProduct()
1103}
1104
1105func (ctx *moduleContextImpl) inVendor() bool {
1106 return ctx.mod.inVendor()
1107}
1108
Yifan Hong1b3348d2020-01-21 15:53:22 -08001109func (ctx *moduleContextImpl) inRamdisk() bool {
1110 return ctx.mod.InRamdisk()
1111}
1112
Jiyong Parkf9332f12018-02-01 00:54:12 +09001113func (ctx *moduleContextImpl) inRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001114 return ctx.mod.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09001115}
1116
Logan Chien2f2b8902018-07-10 15:01:19 +08001117// Check whether ABI dumps should be created for this module.
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001118func (ctx *moduleContextImpl) shouldCreateSourceAbiDump() bool {
Logan Chien2f2b8902018-07-10 15:01:19 +08001119 if ctx.ctx.Config().IsEnvTrue("SKIP_ABI_CHECKS") {
1120 return false
Jayant Chowdharyea0a2e12018-03-01 19:12:16 -08001121 }
Doug Hornc32c6b02019-01-17 14:44:05 -08001122
1123 if ctx.ctx.Fuchsia() {
1124 return false
1125 }
1126
Logan Chien2f2b8902018-07-10 15:01:19 +08001127 if sanitize := ctx.mod.sanitize; sanitize != nil {
1128 if !sanitize.isVariantOnProductionDevice() {
1129 return false
1130 }
1131 }
1132 if !ctx.ctx.Device() {
1133 // Host modules do not need ABI dumps.
1134 return false
1135 }
Hsin-Yi Chend2451682020-01-10 16:47:50 +08001136 if ctx.isStubs() || ctx.isNDKStubLibrary() {
Hsin-Yi Chenf6a95462019-06-25 14:46:52 +08001137 // Stubs do not need ABI dumps.
1138 return false
1139 }
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001140 return true
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001141}
1142
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001143func (ctx *moduleContextImpl) selectedStl() string {
1144 if stl := ctx.mod.stl; stl != nil {
1145 return stl.Properties.SelectedStl
1146 }
1147 return ""
1148}
1149
Ivan Lozanobd721262018-11-27 14:33:03 -08001150func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1151 return ctx.mod.linker.useClangLld(actx)
1152}
1153
Colin Crossce75d2c2016-10-06 16:12:58 -07001154func (ctx *moduleContextImpl) baseModuleName() string {
1155 return ctx.mod.ModuleBase.BaseModuleName()
1156}
1157
Logan Chienf3511742017-10-31 18:04:35 +08001158func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1159 return ctx.mod.getVndkExtendsModuleName()
1160}
1161
Logan Chiene274fc92019-12-03 11:18:32 -08001162func (ctx *moduleContextImpl) isForPlatform() bool {
1163 return ctx.mod.IsForPlatform()
1164}
1165
Jiyong Park58e364a2019-01-19 19:24:06 +09001166func (ctx *moduleContextImpl) apexName() string {
1167 return ctx.mod.ApexName()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001168}
1169
Jiyong Parkb0788572018-12-20 22:10:17 +09001170func (ctx *moduleContextImpl) hasStubsVariants() bool {
1171 return ctx.mod.HasStubsVariants()
1172}
1173
1174func (ctx *moduleContextImpl) isStubs() bool {
1175 return ctx.mod.IsStubs()
1176}
1177
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001178func (ctx *moduleContextImpl) bootstrap() bool {
1179 return ctx.mod.bootstrap()
1180}
1181
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001182func (ctx *moduleContextImpl) nativeCoverage() bool {
1183 return ctx.mod.nativeCoverage()
1184}
1185
Colin Cross635c3b02016-05-18 15:37:25 -07001186func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001187 return &Module{
1188 hod: hod,
1189 multilib: multilib,
1190 }
1191}
1192
Colin Cross635c3b02016-05-18 15:37:25 -07001193func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001194 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001195 module.features = []feature{
1196 &tidyFeature{},
1197 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001198 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001199 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001200 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001201 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001202 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001203 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001204 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001205 return module
1206}
1207
Colin Crossce75d2c2016-10-06 16:12:58 -07001208func (c *Module) Prebuilt() *android.Prebuilt {
1209 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1210 return p.prebuilt()
1211 }
1212 return nil
1213}
1214
1215func (c *Module) Name() string {
1216 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001217 if p, ok := c.linker.(interface {
1218 Name(string) string
1219 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001220 name = p.Name(name)
1221 }
1222 return name
1223}
1224
Alex Light3d673592019-01-18 14:37:31 -08001225func (c *Module) Symlinks() []string {
1226 if p, ok := c.installer.(interface {
1227 symlinkList() []string
1228 }); ok {
1229 return p.symlinkList()
1230 }
1231 return nil
1232}
1233
Jeff Gaston294356f2017-09-27 17:05:30 -07001234// orderDeps reorders dependencies into a list such that if module A depends on B, then
1235// A will precede B in the resultant list.
1236// This is convenient for passing into a linker.
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001237// Note that directSharedDeps should be the analogous static library for each shared lib dep
1238func orderDeps(directStaticDeps []android.Path, directSharedDeps []android.Path, allTransitiveDeps map[android.Path][]android.Path) (orderedAllDeps []android.Path, orderedDeclaredDeps []android.Path) {
Jeff Gaston294356f2017-09-27 17:05:30 -07001239 // If A depends on B, then
1240 // Every list containing A will also contain B later in the list
1241 // So, after concatenating all lists, the final instance of B will have come from the same
1242 // original list as the final instance of A
1243 // So, the final instance of B will be later in the concatenation than the final A
1244 // So, keeping only the final instance of A and of B ensures that A is earlier in the output
1245 // list than B
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001246 for _, dep := range directStaticDeps {
Jeff Gaston294356f2017-09-27 17:05:30 -07001247 orderedAllDeps = append(orderedAllDeps, dep)
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001248 orderedAllDeps = append(orderedAllDeps, allTransitiveDeps[dep]...)
1249 }
1250 for _, dep := range directSharedDeps {
1251 orderedAllDeps = append(orderedAllDeps, dep)
1252 orderedAllDeps = append(orderedAllDeps, allTransitiveDeps[dep]...)
Jeff Gaston294356f2017-09-27 17:05:30 -07001253 }
1254
Colin Crossb6715442017-10-24 11:13:31 -07001255 orderedAllDeps = android.LastUniquePaths(orderedAllDeps)
Jeff Gaston294356f2017-09-27 17:05:30 -07001256
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001257 // We don't want to add any new dependencies into directStaticDeps (to allow the caller to
Jeff Gaston294356f2017-09-27 17:05:30 -07001258 // intentionally exclude or replace any unwanted transitive dependencies), so we limit the
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001259 // resultant list to only what the caller has chosen to include in directStaticDeps
1260 _, orderedDeclaredDeps = android.FilterPathList(orderedAllDeps, directStaticDeps)
Jeff Gaston294356f2017-09-27 17:05:30 -07001261
1262 return orderedAllDeps, orderedDeclaredDeps
1263}
1264
Ivan Lozano183a3212019-10-18 14:18:45 -07001265func orderStaticModuleDeps(module LinkableInterface, staticDeps []LinkableInterface, sharedDeps []LinkableInterface) (results []android.Path) {
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001266 // convert Module to Path
Ivan Lozano183a3212019-10-18 14:18:45 -07001267 var depsInLinkOrder []android.Path
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001268 allTransitiveDeps := make(map[android.Path][]android.Path, len(staticDeps))
1269 staticDepFiles := []android.Path{}
1270 for _, dep := range staticDeps {
Nicolas Geoffray0b787662020-02-04 18:27:55 +00001271 // The OutputFile may not be valid for a variant not present, and the AllowMissingDependencies flag is set.
1272 if dep.OutputFile().Valid() {
1273 allTransitiveDeps[dep.OutputFile().Path()] = dep.GetDepsInLinkOrder()
1274 staticDepFiles = append(staticDepFiles, dep.OutputFile().Path())
1275 }
Jeff Gaston294356f2017-09-27 17:05:30 -07001276 }
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001277 sharedDepFiles := []android.Path{}
1278 for _, sharedDep := range sharedDeps {
Ivan Lozano183a3212019-10-18 14:18:45 -07001279 if sharedDep.HasStaticVariant() {
1280 staticAnalogue := sharedDep.GetStaticVariant()
1281 allTransitiveDeps[staticAnalogue.OutputFile().Path()] = staticAnalogue.GetDepsInLinkOrder()
1282 sharedDepFiles = append(sharedDepFiles, staticAnalogue.OutputFile().Path())
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001283 }
Jeff Gaston294356f2017-09-27 17:05:30 -07001284 }
1285
1286 // reorder the dependencies based on transitive dependencies
Ivan Lozano183a3212019-10-18 14:18:45 -07001287 depsInLinkOrder, results = orderDeps(staticDepFiles, sharedDepFiles, allTransitiveDeps)
1288 module.SetDepsInLinkOrder(depsInLinkOrder)
Jeff Gaston294356f2017-09-27 17:05:30 -07001289
1290 return results
Jeff Gaston294356f2017-09-27 17:05:30 -07001291}
1292
Roland Levillainf89cd092019-07-29 16:22:59 +01001293func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1294 test, ok := c.linker.(testPerSrc)
1295 return ok && test.isAllTestsVariation()
1296}
1297
Justin Yun5f7f7e82019-11-18 19:52:14 +09001298func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1299 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1300 // "current", it will append the VNDK version to the name suffix.
1301 var vndkVersion string
1302 var nameSuffix string
1303 if c.inProduct() {
1304 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1305 nameSuffix = productSuffix
1306 } else {
1307 vndkVersion = ctx.DeviceConfig().VndkVersion()
1308 nameSuffix = vendorSuffix
1309 }
1310 if vndkVersion == "current" {
1311 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1312 }
1313 if c.Properties.VndkVersion != vndkVersion {
1314 // add version suffix only if the module is using different vndk version than the
1315 // version in product or vendor partition.
1316 nameSuffix += "." + c.Properties.VndkVersion
1317 }
1318 return nameSuffix
1319}
1320
Colin Cross635c3b02016-05-18 15:37:25 -07001321func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Roland Levillainf2fad972019-06-28 15:41:19 +01001322 // Handle the case of a test module split by `test_per_src` mutator.
Roland Levillainf89cd092019-07-29 16:22:59 +01001323 //
1324 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1325 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1326 // module and return early, as this module does not produce an output file per se.
1327 if c.IsTestPerSrcAllTestsVariation() {
1328 c.outputFile = android.OptionalPath{}
1329 return
Roland Levillainf2fad972019-06-28 15:41:19 +01001330 }
1331
Jooyung Han38002912019-05-16 04:01:54 +09001332 c.makeLinkType = c.getMakeLinkType(actx)
Inseob Kim9516ee92019-05-09 10:56:13 +09001333
Inseob Kim64c43952019-08-26 16:52:35 +09001334 c.Properties.SubName = ""
1335
1336 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1337 c.Properties.SubName += nativeBridgeSuffix
1338 }
1339
Justin Yun5f7f7e82019-11-18 19:52:14 +09001340 _, llndk := c.linker.(*llndkStubDecorator)
1341 _, llndkHeader := c.linker.(*llndkHeadersDecorator)
1342 if llndk || llndkHeader || (c.UseVndk() && c.HasVendorVariant()) {
1343 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1344 // added for product variant only when we have vendor and product variants with core
1345 // variant. The suffix is not added for vendor-only or product-only module.
1346 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
1347 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001348 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1349 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
1350 c.Properties.SubName += vendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001351 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1352 c.Properties.SubName += ramdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001353 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001354 c.Properties.SubName += recoverySuffix
1355 }
1356
Colin Crossca860ac2016-01-04 14:34:37 -08001357 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001358 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001359 moduleContextImpl: moduleContextImpl{
1360 mod: c,
1361 },
1362 }
1363 ctx.ctx = ctx
1364
Colin Crossf18e1102017-11-16 14:33:08 -08001365 deps := c.depsToPaths(ctx)
1366 if ctx.Failed() {
1367 return
1368 }
1369
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001370 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1371 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1372 }
1373
Colin Crossca860ac2016-01-04 14:34:37 -08001374 flags := Flags{
1375 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001376 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001377 }
Colin Crossca860ac2016-01-04 14:34:37 -08001378 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001379 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001380 }
1381 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001382 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001383 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001384 if c.stl != nil {
1385 flags = c.stl.flags(ctx, flags)
1386 }
Colin Cross16b23492016-01-06 14:41:07 -08001387 if c.sanitize != nil {
1388 flags = c.sanitize.flags(ctx, flags)
1389 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001390 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001391 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001392 }
Stephen Craneba090d12017-05-09 15:44:35 -07001393 if c.lto != nil {
1394 flags = c.lto.flags(ctx, flags)
1395 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001396 if c.pgo != nil {
1397 flags = c.pgo.flags(ctx, flags)
1398 }
Colin Crossca860ac2016-01-04 14:34:37 -08001399 for _, feature := range c.features {
1400 flags = feature.flags(ctx, flags)
1401 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001402 if ctx.Failed() {
1403 return
1404 }
1405
Colin Cross4af21ed2019-11-04 09:37:55 -08001406 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1407 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1408 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001409
Colin Cross4af21ed2019-11-04 09:37:55 -08001410 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001411
1412 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001413 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001414 }
1415 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001416 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001417 }
1418
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001419 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001420 // We need access to all the flags seen by a source file.
1421 if c.sabi != nil {
1422 flags = c.sabi.flags(ctx, flags)
1423 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001424
Colin Cross4af21ed2019-11-04 09:37:55 -08001425 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001426
Colin Crossca860ac2016-01-04 14:34:37 -08001427 // Optimization to reduce size of build.ninja
1428 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001429 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1430 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1431 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1432 flags.Local.CFlags = []string{"$cflags"}
1433 flags.Local.CppFlags = []string{"$cppflags"}
1434 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001435
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001436 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001437 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001438 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001439 if ctx.Failed() {
1440 return
1441 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001442 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001443 }
1444
Colin Crossca860ac2016-01-04 14:34:37 -08001445 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001446 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001447 if ctx.Failed() {
1448 return
1449 }
Colin Cross635c3b02016-05-18 15:37:25 -07001450 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001451
1452 // If a lib is directly included in any of the APEXes, unhide the stubs
1453 // variant having the latest version gets visible to make. In addition,
1454 // the non-stubs variant is renamed to <libname>.bootstrap. This is to
1455 // force anything in the make world to link against the stubs library.
1456 // (unless it is explicitly referenced via .bootstrap suffix or the
1457 // module is marked with 'bootstrap: true').
Nicolas Geoffrayc22c1bf2019-01-15 19:53:23 +00001458 if c.HasStubsVariants() &&
Yifan Hong1b3348d2020-01-21 15:53:22 -08001459 android.DirectlyInAnyApex(ctx, ctx.baseModuleName()) && !c.InRamdisk() &&
Ivan Lozano52767be2019-10-18 14:49:46 -07001460 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001461 c.IsStubs() {
Jiyong Parkb0788572018-12-20 22:10:17 +09001462 c.Properties.HideFromMake = false // unhide
1463 // Note: this is still non-installable
1464 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001465 }
Colin Cross5049f022015-03-18 13:28:46 -07001466
Inseob Kim1f086e22019-05-09 13:29:15 +09001467 if c.installable() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001468 c.installer.install(ctx, c.outputFile.Path())
1469 if ctx.Failed() {
1470 return
Colin Crossca860ac2016-01-04 14:34:37 -08001471 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001472 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001473}
1474
Colin Cross0ea8ba82019-06-06 14:33:29 -07001475func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001476 if c.cachedToolchain == nil {
Colin Crossb98c8b02016-07-29 13:44:28 -07001477 c.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
Colin Cross3f40fa42015-01-30 17:27:36 -08001478 }
Colin Crossca860ac2016-01-04 14:34:37 -08001479 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001480}
1481
Colin Crossca860ac2016-01-04 14:34:37 -08001482func (c *Module) begin(ctx BaseModuleContext) {
1483 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001484 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001485 }
Colin Crossca860ac2016-01-04 14:34:37 -08001486 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001487 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001488 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001489 if c.stl != nil {
1490 c.stl.begin(ctx)
1491 }
Colin Cross16b23492016-01-06 14:41:07 -08001492 if c.sanitize != nil {
1493 c.sanitize.begin(ctx)
1494 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001495 if c.coverage != nil {
1496 c.coverage.begin(ctx)
1497 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001498 if c.sabi != nil {
1499 c.sabi.begin(ctx)
1500 }
Justin Yun8effde42017-06-23 19:24:43 +09001501 if c.vndkdep != nil {
1502 c.vndkdep.begin(ctx)
1503 }
Stephen Craneba090d12017-05-09 15:44:35 -07001504 if c.lto != nil {
1505 c.lto.begin(ctx)
1506 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001507 if c.pgo != nil {
1508 c.pgo.begin(ctx)
1509 }
Colin Crossca860ac2016-01-04 14:34:37 -08001510 for _, feature := range c.features {
1511 feature.begin(ctx)
1512 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001513 if ctx.useSdk() {
Dan Albertf5415d72017-08-17 16:19:59 -07001514 version, err := normalizeNdkApiLevel(ctx, ctx.sdkVersion(), ctx.Arch())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001515 if err != nil {
1516 ctx.PropertyErrorf("sdk_version", err.Error())
1517 }
Nan Zhang0007d812017-11-07 10:57:05 -08001518 c.Properties.Sdk_version = StringPtr(version)
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001519 }
Colin Crossca860ac2016-01-04 14:34:37 -08001520}
1521
Colin Cross37047f12016-12-13 17:06:13 -08001522func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001523 deps := Deps{}
1524
1525 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001526 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001527 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001528 // Add the PGO dependency (the clang_rt.profile runtime library), which
1529 // sometimes depends on symbols from libgcc, before libgcc gets added
1530 // in linkerDeps().
Pirama Arumuga Nainar49b53d52017-10-04 16:47:29 -07001531 if c.pgo != nil {
1532 deps = c.pgo.deps(ctx, deps)
1533 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001534 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001535 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001536 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001537 if c.stl != nil {
1538 deps = c.stl.deps(ctx, deps)
1539 }
Colin Cross16b23492016-01-06 14:41:07 -08001540 if c.sanitize != nil {
1541 deps = c.sanitize.deps(ctx, deps)
1542 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001543 if c.coverage != nil {
1544 deps = c.coverage.deps(ctx, deps)
1545 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001546 if c.sabi != nil {
1547 deps = c.sabi.deps(ctx, deps)
1548 }
Justin Yun8effde42017-06-23 19:24:43 +09001549 if c.vndkdep != nil {
1550 deps = c.vndkdep.deps(ctx, deps)
1551 }
Stephen Craneba090d12017-05-09 15:44:35 -07001552 if c.lto != nil {
1553 deps = c.lto.deps(ctx, deps)
1554 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001555 for _, feature := range c.features {
1556 deps = feature.deps(ctx, deps)
1557 }
1558
Colin Crossb6715442017-10-24 11:13:31 -07001559 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1560 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1561 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1562 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1563 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1564 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001565 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001566
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001567 for _, lib := range deps.ReexportSharedLibHeaders {
1568 if !inList(lib, deps.SharedLibs) {
1569 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1570 }
1571 }
1572
1573 for _, lib := range deps.ReexportStaticLibHeaders {
1574 if !inList(lib, deps.StaticLibs) {
1575 ctx.PropertyErrorf("export_static_lib_headers", "Static library not in static_libs: '%s'", lib)
1576 }
1577 }
1578
Colin Cross5950f382016-12-13 12:50:57 -08001579 for _, lib := range deps.ReexportHeaderLibHeaders {
1580 if !inList(lib, deps.HeaderLibs) {
1581 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1582 }
1583 }
1584
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001585 for _, gen := range deps.ReexportGeneratedHeaders {
1586 if !inList(gen, deps.GeneratedHeaders) {
1587 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1588 }
1589 }
1590
Colin Crossc99deeb2016-04-11 15:06:20 -07001591 return deps
1592}
1593
Dan Albert7e9d2952016-08-04 13:02:36 -07001594func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001595 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001596 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001597 moduleContextImpl: moduleContextImpl{
1598 mod: c,
1599 },
1600 }
1601 ctx.ctx = ctx
1602
Colin Crossca860ac2016-01-04 14:34:37 -08001603 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001604}
1605
Jiyong Park7ed9de32018-10-15 22:25:07 +09001606// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001607func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001608 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1609 version := name[sharp+1:]
1610 libname := name[:sharp]
1611 return libname, version
1612 }
1613 return name, ""
1614}
1615
Colin Cross1e676be2016-10-12 14:38:15 -07001616func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09001617 if !c.Enabled() {
1618 return
1619 }
1620
Colin Cross37047f12016-12-13 17:06:13 -08001621 ctx := &depsContext{
1622 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07001623 moduleContextImpl: moduleContextImpl{
1624 mod: c,
1625 },
1626 }
1627 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08001628
Colin Crossc99deeb2016-04-11 15:06:20 -07001629 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001630
Dan Albert914449f2016-06-17 16:45:24 -07001631 variantNdkLibs := []string{}
1632 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07001633 if ctx.Os() == android.Android {
Dan Albert914449f2016-06-17 16:45:24 -07001634 version := ctx.sdkVersion()
Dan Willemsen72d39932016-07-08 23:23:48 -07001635
Inseob Kimeec88e12020-01-22 11:11:29 +09001636 // rewriteLibs takes a list of names of shared libraries and scans it for three types
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001637 // of names:
Dan Albert914449f2016-06-17 16:45:24 -07001638 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001639 // 1. Name of an NDK library that refers to a prebuilt module.
1640 // For each of these, it adds the name of the prebuilt module (which will be in
1641 // prebuilts/ndk) to the list of nonvariant libs.
1642 // 2. Name of an NDK library that refers to an ndk_library module.
1643 // For each of these, it adds the name of the ndk_library module to the list of
1644 // variant libs.
1645 // 3. Anything else (so anything that isn't an NDK library).
1646 // It adds these to the nonvariantLibs list.
Dan Albert914449f2016-06-17 16:45:24 -07001647 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001648 // The caller can then know to add the variantLibs dependencies differently from the
1649 // nonvariantLibs
Inseob Kim9516ee92019-05-09 10:56:13 +09001650
Inseob Kim9516ee92019-05-09 10:56:13 +09001651 vendorPublicLibraries := vendorPublicLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001652 vendorSnapshotSharedLibs := vendorSnapshotSharedLibs(actx.Config())
1653
1654 rewriteVendorLibs := func(lib string) string {
1655 if isLlndkLibrary(lib, ctx.Config()) {
1656 return lib + llndkLibrarySuffix
1657 }
1658
1659 // only modules with BOARD_VNDK_VERSION uses snapshot.
1660 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1661 return lib
1662 }
1663
1664 if snapshot, ok := vendorSnapshotSharedLibs.get(lib, actx.Arch().ArchType); ok {
1665 return snapshot
1666 }
1667
1668 return lib
1669 }
1670
1671 rewriteLibs := func(list []string) (nonvariantLibs []string, variantLibs []string) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001672 variantLibs = []string{}
1673 nonvariantLibs = []string{}
Dan Albert914449f2016-06-17 16:45:24 -07001674 for _, entry := range list {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001675 // strip #version suffix out
Jiyong Park73c54ee2019-10-22 20:31:18 +09001676 name, _ := StubsLibNameAndVersion(entry)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001677 if ctx.useSdk() && inList(name, ndkPrebuiltSharedLibraries) {
1678 if !inList(name, ndkMigratedLibs) {
1679 nonvariantLibs = append(nonvariantLibs, name+".ndk."+version)
Dan Albert914449f2016-06-17 16:45:24 -07001680 } else {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001681 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Dan Albert914449f2016-06-17 16:45:24 -07001682 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001683 } else if ctx.useVndk() {
1684 nonvariantLibs = append(nonvariantLibs, rewriteVendorLibs(entry))
Inseob Kim9516ee92019-05-09 10:56:13 +09001685 } else if (ctx.Platform() || ctx.ProductSpecific()) && inList(name, *vendorPublicLibraries) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001686 vendorPublicLib := name + vendorPublicLibrarySuffix
Jiyong Park374510b2018-03-19 18:23:01 +09001687 if actx.OtherModuleExists(vendorPublicLib) {
1688 nonvariantLibs = append(nonvariantLibs, vendorPublicLib)
1689 } else {
1690 // This can happen if vendor_public_library module is defined in a
1691 // namespace that isn't visible to the current module. In that case,
1692 // link to the original library.
Jiyong Park7ed9de32018-10-15 22:25:07 +09001693 nonvariantLibs = append(nonvariantLibs, name)
Jiyong Park374510b2018-03-19 18:23:01 +09001694 }
Dan Albert914449f2016-06-17 16:45:24 -07001695 } else {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001696 // put name#version back
Dan Willemsen7cbf5f82017-03-28 00:08:30 -07001697 nonvariantLibs = append(nonvariantLibs, entry)
Dan Willemsen72d39932016-07-08 23:23:48 -07001698 }
1699 }
Dan Albert914449f2016-06-17 16:45:24 -07001700 return nonvariantLibs, variantLibs
Dan Willemsen72d39932016-07-08 23:23:48 -07001701 }
1702
Inseob Kimeec88e12020-01-22 11:11:29 +09001703 deps.SharedLibs, variantNdkLibs = rewriteLibs(deps.SharedLibs)
1704 deps.LateSharedLibs, variantLateNdkLibs = rewriteLibs(deps.LateSharedLibs)
1705 deps.ReexportSharedLibHeaders, _ = rewriteLibs(deps.ReexportSharedLibHeaders)
1706 if ctx.useVndk() {
1707 for idx, lib := range deps.RuntimeLibs {
1708 deps.RuntimeLibs[idx] = rewriteVendorLibs(lib)
1709 }
1710 }
Dan Willemsen72d39932016-07-08 23:23:48 -07001711 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001712
Jiyong Park7e636d02019-01-28 16:16:54 +09001713 buildStubs := false
Jiyong Park7ed9de32018-10-15 22:25:07 +09001714 if c.linker != nil {
1715 if library, ok := c.linker.(*libraryDecorator); ok {
1716 if library.buildStubs() {
Jiyong Park7e636d02019-01-28 16:16:54 +09001717 buildStubs = true
Jiyong Park7ed9de32018-10-15 22:25:07 +09001718 }
1719 }
1720 }
1721
Inseob Kimeec88e12020-01-22 11:11:29 +09001722 rewriteSnapshotLibs := func(lib string, snapshotMap *snapshotMap) string {
1723 // only modules with BOARD_VNDK_VERSION uses snapshot.
1724 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1725 return lib
1726 }
1727
1728 if snapshot, ok := snapshotMap.get(lib, actx.Arch().ArchType); ok {
1729 return snapshot
1730 }
1731
1732 return lib
1733 }
1734
1735 vendorSnapshotHeaderLibs := vendorSnapshotHeaderLibs(actx.Config())
Colin Cross32ec36c2016-12-15 07:39:51 -08001736 for _, lib := range deps.HeaderLibs {
1737 depTag := headerDepTag
1738 if inList(lib, deps.ReexportHeaderLibHeaders) {
1739 depTag = headerExportDepTag
1740 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001741
1742 lib = rewriteSnapshotLibs(lib, vendorSnapshotHeaderLibs)
1743
Jiyong Park7e636d02019-01-28 16:16:54 +09001744 if buildStubs {
Colin Cross7228ecd2019-11-18 16:00:16 -08001745 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001746 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09001747 } else {
1748 actx.AddVariationDependencies(nil, depTag, lib)
1749 }
1750 }
1751
1752 if buildStubs {
1753 // Stubs lib does not have dependency to other static/shared libraries.
1754 // Don't proceed.
1755 return
Colin Cross32ec36c2016-12-15 07:39:51 -08001756 }
Colin Cross5950f382016-12-13 12:50:57 -08001757
Inseob Kimc0907f12019-02-08 21:00:45 +09001758 syspropImplLibraries := syspropImplLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001759 vendorSnapshotStaticLibs := vendorSnapshotStaticLibs(actx.Config())
Inseob Kimc0907f12019-02-08 21:00:45 +09001760
Jiyong Park5d1598f2019-02-25 22:14:17 +09001761 for _, lib := range deps.WholeStaticLibs {
1762 depTag := wholeStaticDepTag
1763 if impl, ok := syspropImplLibraries[lib]; ok {
1764 lib = impl
1765 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001766
1767 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1768
Jiyong Park5d1598f2019-02-25 22:14:17 +09001769 actx.AddVariationDependencies([]blueprint.Variation{
1770 {Mutator: "link", Variation: "static"},
1771 }, depTag, lib)
1772 }
1773
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001774 for _, lib := range deps.StaticLibs {
Ivan Lozano183a3212019-10-18 14:18:45 -07001775 depTag := StaticDepTag
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001776 if inList(lib, deps.ReexportStaticLibHeaders) {
1777 depTag = staticExportDepTag
1778 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001779
1780 if impl, ok := syspropImplLibraries[lib]; ok {
1781 lib = impl
1782 }
1783
Inseob Kimeec88e12020-01-22 11:11:29 +09001784 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1785
Dan Willemsen59339a22018-07-22 21:18:45 -07001786 actx.AddVariationDependencies([]blueprint.Variation{
1787 {Mutator: "link", Variation: "static"},
1788 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001789 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001790
Inseob Kimeec88e12020-01-22 11:11:29 +09001791 for _, lib := range deps.LateStaticLibs {
1792 actx.AddVariationDependencies([]blueprint.Variation{
1793 {Mutator: "link", Variation: "static"},
1794 }, lateStaticDepTag, rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs))
1795 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001796
Ivan Lozano183a3212019-10-18 14:18:45 -07001797 addSharedLibDependencies := func(depTag DependencyTag, name string, version string) {
Jiyong Park25fc6a92018-11-18 18:02:45 +09001798 var variations []blueprint.Variation
1799 variations = append(variations, blueprint.Variation{Mutator: "link", Variation: "shared"})
Yifan Hong1b3348d2020-01-21 15:53:22 -08001800 versionVariantAvail := !ctx.useVndk() && !c.InRecovery() && !c.InRamdisk()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001801 if version != "" && versionVariantAvail {
1802 // Version is explicitly specified. i.e. libFoo#30
1803 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozano183a3212019-10-18 14:18:45 -07001804 depTag.ExplicitlyVersioned = true
Jiyong Park25fc6a92018-11-18 18:02:45 +09001805 }
1806 actx.AddVariationDependencies(variations, depTag, name)
1807
1808 // If the version is not specified, add dependency to the latest stubs library.
1809 // The stubs library will be used when the depending module is built for APEX and
1810 // the dependent module is not in the same APEX.
Jiyong Park73c54ee2019-10-22 20:31:18 +09001811 latestVersion := LatestStubsVersionFor(actx.Config(), name)
Jiyong Park25fc6a92018-11-18 18:02:45 +09001812 if version == "" && latestVersion != "" && versionVariantAvail {
1813 actx.AddVariationDependencies([]blueprint.Variation{
1814 {Mutator: "link", Variation: "shared"},
1815 {Mutator: "version", Variation: latestVersion},
1816 }, depTag, name)
Ivan Lozano183a3212019-10-18 14:18:45 -07001817 // Note that depTag.ExplicitlyVersioned is false in this case.
Jiyong Park25fc6a92018-11-18 18:02:45 +09001818 }
1819 }
1820
Jiyong Park7ed9de32018-10-15 22:25:07 +09001821 // shared lib names without the #version suffix
1822 var sharedLibNames []string
1823
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001824 for _, lib := range deps.SharedLibs {
Ivan Lozano183a3212019-10-18 14:18:45 -07001825 depTag := SharedDepTag
Jiyong Parkd7536ba2020-01-16 17:14:23 +09001826 if c.static() {
1827 depTag = SharedFromStaticDepTag
1828 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001829 if inList(lib, deps.ReexportSharedLibHeaders) {
1830 depTag = sharedExportDepTag
1831 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001832
1833 if impl, ok := syspropImplLibraries[lib]; ok {
1834 lib = impl
1835 }
1836
Jiyong Park73c54ee2019-10-22 20:31:18 +09001837 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09001838 sharedLibNames = append(sharedLibNames, name)
1839
Jiyong Park25fc6a92018-11-18 18:02:45 +09001840 addSharedLibDependencies(depTag, name, version)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001841 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001842
Jiyong Park7ed9de32018-10-15 22:25:07 +09001843 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09001844 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001845 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
1846 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
1847 // linking against both the stubs lib and the non-stubs lib at the same time.
1848 continue
1849 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001850 addSharedLibDependencies(lateSharedDepTag, lib, "")
Jiyong Park7ed9de32018-10-15 22:25:07 +09001851 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001852
Dan Willemsen59339a22018-07-22 21:18:45 -07001853 actx.AddVariationDependencies([]blueprint.Variation{
1854 {Mutator: "link", Variation: "shared"},
1855 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08001856
Colin Cross68861832016-07-08 10:41:41 -07001857 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001858
1859 for _, gen := range deps.GeneratedHeaders {
1860 depTag := genHeaderDepTag
1861 if inList(gen, deps.ReexportGeneratedHeaders) {
1862 depTag = genHeaderExportDepTag
1863 }
1864 actx.AddDependency(c, depTag, gen)
1865 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07001866
Colin Cross42d48b72018-08-29 14:10:52 -07001867 actx.AddVariationDependencies(nil, objDepTag, deps.ObjFiles...)
Colin Crossc99deeb2016-04-11 15:06:20 -07001868
1869 if deps.CrtBegin != "" {
Ivan Lozano183a3212019-10-18 14:18:45 -07001870 actx.AddVariationDependencies(nil, CrtBeginDepTag, deps.CrtBegin)
Colin Crossca860ac2016-01-04 14:34:37 -08001871 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001872 if deps.CrtEnd != "" {
Ivan Lozano183a3212019-10-18 14:18:45 -07001873 actx.AddVariationDependencies(nil, CrtEndDepTag, deps.CrtEnd)
Colin Cross21b9a242015-03-24 14:15:58 -07001874 }
Dan Willemsena0790e32018-10-12 00:24:23 -07001875 if deps.LinkerFlagsFile != "" {
1876 actx.AddDependency(c, linkerFlagsDepTag, deps.LinkerFlagsFile)
1877 }
1878 if deps.DynamicLinker != "" {
1879 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07001880 }
Dan Albert914449f2016-06-17 16:45:24 -07001881
1882 version := ctx.sdkVersion()
1883 actx.AddVariationDependencies([]blueprint.Variation{
Dan Willemsen59339a22018-07-22 21:18:45 -07001884 {Mutator: "ndk_api", Variation: version},
1885 {Mutator: "link", Variation: "shared"},
1886 }, ndkStubDepTag, variantNdkLibs...)
Dan Albert914449f2016-06-17 16:45:24 -07001887 actx.AddVariationDependencies([]blueprint.Variation{
Dan Willemsen59339a22018-07-22 21:18:45 -07001888 {Mutator: "ndk_api", Variation: version},
1889 {Mutator: "link", Variation: "shared"},
1890 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08001891
1892 if vndkdep := c.vndkdep; vndkdep != nil {
1893 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08001894 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08001895 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07001896 {Mutator: "link", Variation: "shared"},
1897 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08001898 }
1899 }
Colin Cross6362e272015-10-29 15:25:03 -07001900}
Colin Cross21b9a242015-03-24 14:15:58 -07001901
Colin Crosse40b4ea2018-10-02 22:25:58 -07001902func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07001903 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
1904 c.beginMutator(ctx)
1905 }
1906}
1907
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001908// Whether a module can link to another module, taking into
1909// account NDK linking.
Ivan Lozano52767be2019-10-18 14:49:46 -07001910func checkLinkType(ctx android.ModuleContext, from LinkableInterface, to LinkableInterface, tag DependencyTag) {
1911 if from.Module().Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001912 // Host code is not restricted
1913 return
1914 }
Ivan Lozano52767be2019-10-18 14:49:46 -07001915
1916 // VNDK is cc.Module supported only for now.
1917 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001918 // Though vendor code is limited by the vendor mutator,
1919 // each vendor-available module needs to check
1920 // link-type for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07001921 if ccTo, ok := to.(*Module); ok {
1922 if ccFrom.vndkdep != nil {
1923 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
1924 }
1925 } else {
1926 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001927 }
1928 return
1929 }
Ivan Lozano52767be2019-10-18 14:49:46 -07001930 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001931 // Platform code can link to anything
1932 return
1933 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08001934 if from.InRamdisk() {
1935 // Ramdisk code is not NDK
1936 return
1937 }
Ivan Lozano52767be2019-10-18 14:49:46 -07001938 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09001939 // Recovery code is not NDK
1940 return
1941 }
Ivan Lozano52767be2019-10-18 14:49:46 -07001942 if to.ToolchainLibrary() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001943 // These are always allowed
1944 return
1945 }
Ivan Lozano52767be2019-10-18 14:49:46 -07001946 if to.NdkPrebuiltStl() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001947 // These are allowed, but they don't set sdk_version
1948 return
1949 }
Ivan Lozano52767be2019-10-18 14:49:46 -07001950 if to.StubDecorator() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001951 // These aren't real libraries, but are the stub shared libraries that are included in
1952 // the NDK.
1953 return
1954 }
Logan Chien834b9a62019-01-14 15:39:03 +08001955
Ivan Lozano52767be2019-10-18 14:49:46 -07001956 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08001957 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
1958 // to link to libc++ (non-NDK and without sdk_version).
1959 return
1960 }
1961
Ivan Lozano52767be2019-10-18 14:49:46 -07001962 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001963 // NDK code linking to platform code is never okay.
1964 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07001965 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08001966 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001967 }
1968
1969 // At this point we know we have two NDK libraries, but we need to
1970 // check that we're not linking against anything built against a higher
1971 // API level, as it is only valid to link against older or equivalent
1972 // APIs.
1973
Inseob Kim01a28722018-04-11 09:48:45 +09001974 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07001975 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09001976 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07001977 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09001978 // Current can't be linked against by anything else.
1979 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07001980 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09001981 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07001982 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09001983 if err != nil {
1984 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09001985 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07001986 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09001987 }
Ivan Lozano52767be2019-10-18 14:49:46 -07001988 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09001989 if err != nil {
1990 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09001991 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07001992 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09001993 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001994
Inseob Kim01a28722018-04-11 09:48:45 +09001995 if toApi > fromApi {
1996 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07001997 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09001998 }
1999 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002000 }
Dan Albert202fe492017-12-15 13:56:59 -08002001
2002 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002003 fromStl := from.SelectedStl()
2004 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002005 if fromStl == "" || toStl == "" {
2006 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002007 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002008 // We can be permissive with the system "STL" since it is only the C++
2009 // ABI layer, but in the future we should make sure that everyone is
2010 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002011 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002012 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002013 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2014 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002015 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002016}
2017
Jiyong Park5fb8c102018-04-09 12:03:06 +09002018// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002019// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2020// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002021// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002022func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2023 check := func(child, parent android.Module) bool {
2024 to, ok := child.(*Module)
2025 if !ok {
2026 // follow thru cc.Defaults, etc.
2027 return true
2028 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002029
Jooyung Hana70f0672019-01-18 15:20:43 +09002030 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2031 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002032 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002033
2034 // if target lib has no vendor variant, keep checking dependency graph
Ivan Lozano52767be2019-10-18 14:49:46 -07002035 if !to.HasVendorVariant() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002036 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002037 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002038
Jooyung Han0302a842019-10-30 18:43:49 +09002039 if to.isVndkSp() || to.isLlndk(ctx.Config()) || Bool(to.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002040 return false
2041 }
2042
2043 var stringPath []string
2044 for _, m := range ctx.GetWalkPath() {
2045 stringPath = append(stringPath, m.Name())
2046 }
2047 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2048 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
2049 "(dependency: %s)", ctx.OtherModuleName(to), strings.Join(stringPath, " -> "))
2050 return false
2051 }
2052 if module, ok := ctx.Module().(*Module); ok {
2053 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jooyung Han0302a842019-10-30 18:43:49 +09002054 if module.isLlndk(ctx.Config()) || Bool(module.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002055 ctx.WalkDeps(check)
2056 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002057 }
2058 }
2059}
2060
Colin Crossc99deeb2016-04-11 15:06:20 -07002061// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002062func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002063 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002064
Ivan Lozano183a3212019-10-18 14:18:45 -07002065 directStaticDeps := []LinkableInterface{}
2066 directSharedDeps := []LinkableInterface{}
Jeff Gaston294356f2017-09-27 17:05:30 -07002067
Inseob Kim9516ee92019-05-09 10:56:13 +09002068 vendorPublicLibraries := vendorPublicLibraries(ctx.Config())
2069
Inseob Kim69378442019-06-03 19:10:47 +09002070 reexportExporter := func(exporter exportedFlagsProducer) {
2071 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.exportedDirs()...)
2072 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.exportedSystemDirs()...)
2073 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.exportedFlags()...)
2074 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.exportedDeps()...)
Inseob Kimd110f872019-12-06 13:15:38 +09002075 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.exportedGeneratedHeaders()...)
Inseob Kim69378442019-06-03 19:10:47 +09002076 }
2077
Colin Crossd11fcda2017-10-23 17:59:01 -07002078 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002079 depName := ctx.OtherModuleName(dep)
2080 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002081
Ivan Lozano52767be2019-10-18 14:49:46 -07002082 ccDep, ok := dep.(LinkableInterface)
2083 if !ok {
2084
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002085 // handling for a few module types that aren't cc Module but that are also supported
2086 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002087 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002088 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002089 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2090 genRule.GeneratedSourceFiles()...)
2091 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002092 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002093 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002094 // Support exported headers from a generated_sources dependency
2095 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002096 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002097 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002098 depPaths.GeneratedHeaders = append(depPaths.GeneratedHeaders,
Inseob Kimd110f872019-12-06 13:15:38 +09002099 genRule.GeneratedSourceFiles()...)
2100 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002101 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002102 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002103 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002104 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002105 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002106 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2107 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002108 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002109 // 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 +09002110 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002111
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002112 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002113 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002114 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002115 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002116 case linkerFlagsDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002117 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002118 files := genRule.GeneratedSourceFiles()
2119 if len(files) == 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002120 depPaths.LinkerFlagsFile = android.OptionalPathForPath(files[0])
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002121 } else if len(files) > 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002122 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 -07002123 }
2124 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002125 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002126 }
Colin Crossca860ac2016-01-04 14:34:37 -08002127 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002128 return
2129 }
2130
Colin Crossfe17f6f2019-03-28 19:30:56 -07002131 if depTag == android.ProtoPluginDepTag {
2132 return
2133 }
2134
Colin Crossd11fcda2017-10-23 17:59:01 -07002135 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002136 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2137 return
2138 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002139 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002140 ctx.ModuleErrorf("Arch mismatch between %q and %q", ctx.ModuleName(), depName)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002141 return
2142 }
2143
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002144 // re-exporting flags
2145 if depTag == reuseObjTag {
Ivan Lozano52767be2019-10-18 14:49:46 -07002146 // reusing objects only make sense for cc.Modules.
2147 if ccReuseDep, ok := ccDep.(*Module); ok && ccDep.CcLibraryInterface() {
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08002148 c.staticVariant = ccDep
Ivan Lozano52767be2019-10-18 14:49:46 -07002149 objs, exporter := ccReuseDep.compiler.(libraryInterface).reuseObjs()
Colin Cross10d22312017-05-03 11:01:58 -07002150 depPaths.Objs = depPaths.Objs.Append(objs)
Inseob Kim69378442019-06-03 19:10:47 +09002151 reexportExporter(exporter)
Colin Crossbba99042016-11-23 15:45:05 -08002152 return
2153 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002154 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09002155
Jiyong Parke4bb9862019-02-01 00:31:10 +09002156 if depTag == staticVariantTag {
Ivan Lozano52767be2019-10-18 14:49:46 -07002157 // staticVariants are a cc.Module specific concept.
2158 if _, ok := ccDep.(*Module); ok && ccDep.CcLibraryInterface() {
Jiyong Parke4bb9862019-02-01 00:31:10 +09002159 c.staticVariant = ccDep
2160 return
2161 }
2162 }
2163
Ivan Lozano183a3212019-10-18 14:18:45 -07002164 // Extract ExplicitlyVersioned field from the depTag and reset it inside the struct.
2165 // Otherwise, SharedDepTag and lateSharedDepTag with ExplicitlyVersioned set to true
2166 // won't be matched to SharedDepTag and lateSharedDepTag.
Jiyong Park25fc6a92018-11-18 18:02:45 +09002167 explicitlyVersioned := false
Ivan Lozano183a3212019-10-18 14:18:45 -07002168 if t, ok := depTag.(DependencyTag); ok {
2169 explicitlyVersioned = t.ExplicitlyVersioned
2170 t.ExplicitlyVersioned = false
Jiyong Park25fc6a92018-11-18 18:02:45 +09002171 depTag = t
2172 }
2173
Ivan Lozano183a3212019-10-18 14:18:45 -07002174 if t, ok := depTag.(DependencyTag); ok && t.Library {
Jiyong Park16e91a02018-12-20 18:18:08 +09002175 depIsStatic := false
2176 switch depTag {
Ivan Lozano183a3212019-10-18 14:18:45 -07002177 case StaticDepTag, staticExportDepTag, lateStaticDepTag, wholeStaticDepTag:
Jiyong Park16e91a02018-12-20 18:18:08 +09002178 depIsStatic = true
2179 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002180 if ccDep.CcLibrary() && !depIsStatic {
2181 depIsStubs := ccDep.BuildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09002182 depHasStubs := ccDep.HasStubsVariants()
Jiyong Park0ddfcd12018-12-11 01:35:25 +09002183 depInSameApex := android.DirectlyInApex(c.ApexName(), depName)
Nicolas Geoffrayc22c1bf2019-01-15 19:53:23 +00002184 depInPlatform := !android.DirectlyInAnyApex(ctx, depName)
Jiyong Park25fc6a92018-11-18 18:02:45 +09002185
2186 var useThisDep bool
2187 if depIsStubs && explicitlyVersioned {
2188 // Always respect dependency to the versioned stubs (i.e. libX#10)
2189 useThisDep = true
2190 } else if !depHasStubs {
2191 // Use non-stub variant if that is the only choice
2192 // (i.e. depending on a lib without stubs.version property)
2193 useThisDep = true
2194 } else if c.IsForPlatform() {
2195 // If not building for APEX, use stubs only when it is from
2196 // an APEX (and not from platform)
2197 useThisDep = (depInPlatform != depIsStubs)
Yifan Hong1b3348d2020-01-21 15:53:22 -08002198 if c.InRamdisk() || c.InRecovery() || c.bootstrap() {
2199 // However, for ramdisk, recovery or bootstrap modules,
Jiyong Park25fc6a92018-11-18 18:02:45 +09002200 // always link to non-stub variant
2201 useThisDep = !depIsStubs
2202 }
2203 } else {
2204 // If building for APEX, use stubs only when it is not from
2205 // the same APEX
2206 useThisDep = (depInSameApex != depIsStubs)
2207 }
2208
2209 if !useThisDep {
2210 return // stop processing this dep
2211 }
2212 }
2213
Ivan Lozanoe0833b12019-11-06 19:15:49 -08002214 depPaths.IncludeDirs = append(depPaths.IncludeDirs, ccDep.IncludeDirs()...)
2215
Ivan Lozano52767be2019-10-18 14:49:46 -07002216 // Exporting flags only makes sense for cc.Modules
2217 if _, ok := ccDep.(*Module); ok {
2218 if i, ok := ccDep.(*Module).linker.(exportedFlagsProducer); ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002219 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, i.exportedSystemDirs()...)
Inseob Kimd110f872019-12-06 13:15:38 +09002220 depPaths.GeneratedHeaders = append(depPaths.GeneratedHeaders, i.exportedGeneratedHeaders()...)
2221 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, i.exportedDeps()...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002222 depPaths.Flags = append(depPaths.Flags, i.exportedFlags()...)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002223
Ivan Lozano52767be2019-10-18 14:49:46 -07002224 if t.ReexportFlags {
2225 reexportExporter(i)
2226 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2227 // Re-exported shared library headers must be included as well since they can help us with type information
2228 // about template instantiations (instantiated from their headers).
2229 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2230 // scripts.
2231 c.sabi.Properties.ReexportedIncludes = append(
2232 c.sabi.Properties.ReexportedIncludes, i.exportedDirs().Strings()...)
2233 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002234 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002235 }
Logan Chienf3511742017-10-31 18:04:35 +08002236 checkLinkType(ctx, c, ccDep, t)
Colin Crossc99deeb2016-04-11 15:06:20 -07002237 }
2238
Colin Cross26c34ed2016-09-30 17:10:16 -07002239 var ptr *android.Paths
Colin Cross635c3b02016-05-18 15:37:25 -07002240 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002241
Ivan Lozano52767be2019-10-18 14:49:46 -07002242 linkFile := ccDep.OutputFile()
Colin Cross26c34ed2016-09-30 17:10:16 -07002243 depFile := android.OptionalPath{}
2244
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002245 switch depTag {
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002246 case ndkStubDepTag, SharedDepTag, SharedFromStaticDepTag, sharedExportDepTag:
Colin Cross26c34ed2016-09-30 17:10:16 -07002247 ptr = &depPaths.SharedLibs
2248 depPtr = &depPaths.SharedLibsDeps
Ivan Lozano52767be2019-10-18 14:49:46 -07002249 depFile = ccDep.Toc()
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08002250 directSharedDeps = append(directSharedDeps, ccDep)
Ivan Lozano183a3212019-10-18 14:18:45 -07002251
Jiyong Park64a44f22019-01-18 14:37:08 +09002252 case earlySharedDepTag:
2253 ptr = &depPaths.EarlySharedLibs
2254 depPtr = &depPaths.EarlySharedLibsDeps
Ivan Lozano52767be2019-10-18 14:49:46 -07002255 depFile = ccDep.Toc()
Jiyong Park64a44f22019-01-18 14:37:08 +09002256 directSharedDeps = append(directSharedDeps, ccDep)
Dan Albert914449f2016-06-17 16:45:24 -07002257 case lateSharedDepTag, ndkLateStubDepTag:
Colin Cross26c34ed2016-09-30 17:10:16 -07002258 ptr = &depPaths.LateSharedLibs
2259 depPtr = &depPaths.LateSharedLibsDeps
Ivan Lozano52767be2019-10-18 14:49:46 -07002260 depFile = ccDep.Toc()
Ivan Lozano183a3212019-10-18 14:18:45 -07002261 case StaticDepTag, staticExportDepTag:
Jeff Gaston294356f2017-09-27 17:05:30 -07002262 ptr = nil
2263 directStaticDeps = append(directStaticDeps, ccDep)
Colin Crossc99deeb2016-04-11 15:06:20 -07002264 case lateStaticDepTag:
Colin Cross26c34ed2016-09-30 17:10:16 -07002265 ptr = &depPaths.LateStaticLibs
Colin Crossc99deeb2016-04-11 15:06:20 -07002266 case wholeStaticDepTag:
Colin Cross26c34ed2016-09-30 17:10:16 -07002267 ptr = &depPaths.WholeStaticLibs
Ivan Lozano52767be2019-10-18 14:49:46 -07002268 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002269 ctx.ModuleErrorf("module %q not a static library", depName)
Colin Crossc99deeb2016-04-11 15:06:20 -07002270 return
2271 }
2272
Ivan Lozano52767be2019-10-18 14:49:46 -07002273 // Because the static library objects are included, this only makes sense
2274 // in the context of proper cc.Modules.
2275 if ccWholeStaticLib, ok := ccDep.(*Module); ok {
2276 staticLib := ccWholeStaticLib.linker.(libraryInterface)
2277 if missingDeps := staticLib.getWholeStaticMissingDeps(); missingDeps != nil {
2278 postfix := " (required by " + ctx.OtherModuleName(dep) + ")"
2279 for i := range missingDeps {
2280 missingDeps[i] += postfix
2281 }
2282 ctx.AddMissingDependencies(missingDeps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002283 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002284 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLib.objs())
2285 } else {
2286 ctx.ModuleErrorf(
2287 "non-cc.Modules cannot be included as whole static libraries.", depName)
2288 return
Colin Crossc99deeb2016-04-11 15:06:20 -07002289 }
Colin Cross5950f382016-12-13 12:50:57 -08002290 case headerDepTag:
2291 // Nothing
Colin Crossc99deeb2016-04-11 15:06:20 -07002292 case objDepTag:
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002293 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
Ivan Lozano183a3212019-10-18 14:18:45 -07002294 case CrtBeginDepTag:
Colin Cross26c34ed2016-09-30 17:10:16 -07002295 depPaths.CrtBegin = linkFile
Ivan Lozano183a3212019-10-18 14:18:45 -07002296 case CrtEndDepTag:
Colin Cross26c34ed2016-09-30 17:10:16 -07002297 depPaths.CrtEnd = linkFile
Dan Willemsena0790e32018-10-12 00:24:23 -07002298 case dynamicLinkerDepTag:
2299 depPaths.DynamicLinker = linkFile
Colin Crossc99deeb2016-04-11 15:06:20 -07002300 }
2301
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002302 switch depTag {
Ivan Lozano183a3212019-10-18 14:18:45 -07002303 case StaticDepTag, staticExportDepTag, lateStaticDepTag:
Ivan Lozano52767be2019-10-18 14:49:46 -07002304 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002305 ctx.ModuleErrorf("module %q not a static library", depName)
Dan Willemsen581341d2017-02-09 16:16:31 -08002306 return
2307 }
2308
2309 // When combining coverage files for shared libraries and executables, coverage files
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002310 // in static libraries act as if they were whole static libraries. The same goes for
2311 // source based Abi dump files.
Ivan Lozano52767be2019-10-18 14:49:46 -07002312 // This should only be done for cc.Modules
2313 if c, ok := ccDep.(*Module); ok {
2314 staticLib := c.linker.(libraryInterface)
2315 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2316 staticLib.objs().coverageFiles...)
2317 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2318 staticLib.objs().sAbiDumpFiles...)
2319 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002320 }
2321
Colin Cross26c34ed2016-09-30 17:10:16 -07002322 if ptr != nil {
Colin Crossce75d2c2016-10-06 16:12:58 -07002323 if !linkFile.Valid() {
Isaac Chen2c0a1802019-10-15 17:16:05 +08002324 if !ctx.Config().AllowMissingDependencies() {
2325 ctx.ModuleErrorf("module %q missing output file", depName)
2326 } else {
2327 ctx.AddMissingDependencies([]string{depName})
2328 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002329 return
2330 }
Colin Cross26c34ed2016-09-30 17:10:16 -07002331 *ptr = append(*ptr, linkFile.Path())
2332 }
2333
Colin Crossc99deeb2016-04-11 15:06:20 -07002334 if depPtr != nil {
Colin Cross26c34ed2016-09-30 17:10:16 -07002335 dep := depFile
2336 if !dep.Valid() {
2337 dep = linkFile
2338 }
2339 *depPtr = append(*depPtr, dep.Path())
Colin Crossca860ac2016-01-04 14:34:37 -08002340 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002341
Inseob Kimeec88e12020-01-22 11:11:29 +09002342 vendorSuffixModules := vendorSuffixModules(ctx.Config())
2343
2344 baseLibName := func(depName string) string {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002345 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
Jiyong Park374510b2018-03-19 18:23:01 +09002346 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Jiyong Park27b188b2017-07-18 13:23:39 +09002347 libName = strings.TrimPrefix(libName, "prebuilt_")
Inseob Kimeec88e12020-01-22 11:11:29 +09002348 return libName
2349 }
2350
2351 makeLibName := func(depName string) string {
2352 libName := baseLibName(depName)
Jooyung Han0302a842019-10-30 18:43:49 +09002353 isLLndk := isLlndkLibrary(libName, ctx.Config())
Inseob Kim9516ee92019-05-09 10:56:13 +09002354 isVendorPublicLib := inList(libName, *vendorPublicLibraries)
Ivan Lozano52767be2019-10-18 14:49:46 -07002355 bothVendorAndCoreVariantsExist := ccDep.HasVendorVariant() || isLLndk
Vic Yangefd249e2018-11-12 20:19:56 -08002356
Inseob Kimeec88e12020-01-22 11:11:29 +09002357 if c, ok := ccDep.(*Module); ok {
2358 // Use base module name for snapshots when exporting to Makefile.
2359 if c.isSnapshotPrebuilt() && !c.IsVndk() {
2360 baseName := c.BaseModuleName()
2361 if vendorSuffixModules[baseName] {
2362 return baseName + ".vendor"
2363 } else {
2364 return baseName
2365 }
2366 }
2367 }
2368
Yifan Hong1b3348d2020-01-21 15:53:22 -08002369 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() && !c.InRamdisk() && !c.InRecovery() {
Vic Yangefd249e2018-11-12 20:19:56 -08002370 // The vendor module is a no-vendor-variant VNDK library. Depend on the
2371 // core module instead.
2372 return libName
Ivan Lozano52767be2019-10-18 14:49:46 -07002373 } else if c.UseVndk() && bothVendorAndCoreVariantsExist {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002374 // The vendor module in Make will have been renamed to not conflict with the core
2375 // module, so update the dependency name here accordingly.
Justin Yun5f7f7e82019-11-18 19:52:14 +09002376 return libName + c.getNameSuffixWithVndkVersion(ctx)
Jiyong Park374510b2018-03-19 18:23:01 +09002377 } else if (ctx.Platform() || ctx.ProductSpecific()) && isVendorPublicLib {
Logan Chien43d34c32017-12-20 01:17:32 +08002378 return libName + vendorPublicLibrarySuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08002379 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
2380 return libName + ramdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07002381 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002382 return libName + recoverySuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07002383 } else if ccDep.Module().Target().NativeBridge == android.NativeBridgeEnabled {
dimitry43204492019-05-23 13:24:38 +02002384 return libName + nativeBridgeSuffix
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002385 } else {
Logan Chien43d34c32017-12-20 01:17:32 +08002386 return libName
Jiyong Park27b188b2017-07-18 13:23:39 +09002387 }
Logan Chien43d34c32017-12-20 01:17:32 +08002388 }
2389
2390 // Export the shared libs to Make.
2391 switch depTag {
Ivan Lozano183a3212019-10-18 14:18:45 -07002392 case SharedDepTag, sharedExportDepTag, lateSharedDepTag, earlySharedDepTag:
Ivan Lozano52767be2019-10-18 14:49:46 -07002393 if ccDep.CcLibrary() {
2394 if ccDep.BuildStubs() && android.InAnyApex(depName) {
Logan Chien09106e12019-01-18 14:57:48 +08002395 // Add the dependency to the APEX(es) providing the library so that
Jiyong Parkde866cb2018-12-07 23:08:36 +09002396 // m <module> can trigger building the APEXes as well.
Jiyong Park0ddfcd12018-12-11 01:35:25 +09002397 for _, an := range android.GetApexesForModule(depName) {
Jiyong Parkde866cb2018-12-07 23:08:36 +09002398 c.Properties.ApexesProvidingSharedLibs = append(
2399 c.Properties.ApexesProvidingSharedLibs, an)
2400 }
Jiyong Parkde866cb2018-12-07 23:08:36 +09002401 }
2402 }
2403
Jiyong Park27b188b2017-07-18 13:23:39 +09002404 // Note: the order of libs in this list is not important because
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002405 // they merely serve as Make dependencies and do not affect this lib itself.
Logan Chien43d34c32017-12-20 01:17:32 +08002406 c.Properties.AndroidMkSharedLibs = append(
2407 c.Properties.AndroidMkSharedLibs, makeLibName(depName))
Inseob Kimeec88e12020-01-22 11:11:29 +09002408 // Record baseLibName for snapshots.
2409 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, baseLibName(depName))
Logan Chienc7f797e2019-01-14 15:35:08 +08002410 case ndkStubDepTag, ndkLateStubDepTag:
Logan Chienc7f797e2019-01-14 15:35:08 +08002411 c.Properties.AndroidMkSharedLibs = append(
2412 c.Properties.AndroidMkSharedLibs,
Ivan Lozano52767be2019-10-18 14:49:46 -07002413 depName+"."+ccDep.ApiLevel())
Ivan Lozano183a3212019-10-18 14:18:45 -07002414 case StaticDepTag, staticExportDepTag, lateStaticDepTag:
Jaewoong Jung16c7d3d2018-11-16 01:19:56 +00002415 c.Properties.AndroidMkStaticLibs = append(
2416 c.Properties.AndroidMkStaticLibs, makeLibName(depName))
Logan Chien43d34c32017-12-20 01:17:32 +08002417 case runtimeDepTag:
2418 c.Properties.AndroidMkRuntimeLibs = append(
2419 c.Properties.AndroidMkRuntimeLibs, makeLibName(depName))
Inseob Kimeec88e12020-01-22 11:11:29 +09002420 // Record baseLibName for snapshots.
2421 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, baseLibName(depName))
Jaewoong Jung16c7d3d2018-11-16 01:19:56 +00002422 case wholeStaticDepTag:
2423 c.Properties.AndroidMkWholeStaticLibs = append(
2424 c.Properties.AndroidMkWholeStaticLibs, makeLibName(depName))
Jiyong Park27b188b2017-07-18 13:23:39 +09002425 }
Colin Crossca860ac2016-01-04 14:34:37 -08002426 })
2427
Jeff Gaston294356f2017-09-27 17:05:30 -07002428 // use the ordered dependencies as this module's dependencies
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08002429 depPaths.StaticLibs = append(depPaths.StaticLibs, orderStaticModuleDeps(c, directStaticDeps, directSharedDeps)...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002430
Colin Crossdd84e052017-05-17 13:44:16 -07002431 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002432 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002433 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2434 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002435 depPaths.GeneratedHeaders = android.FirstUniquePaths(depPaths.GeneratedHeaders)
Inseob Kimd110f872019-12-06 13:15:38 +09002436 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002437 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2438 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002439 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002440 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002441 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002442
2443 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002444 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002445 }
Colin Crossdd84e052017-05-17 13:44:16 -07002446
Colin Crossca860ac2016-01-04 14:34:37 -08002447 return depPaths
2448}
2449
2450func (c *Module) InstallInData() bool {
2451 if c.installer == nil {
2452 return false
2453 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002454 return c.installer.inData()
2455}
2456
2457func (c *Module) InstallInSanitizerDir() bool {
2458 if c.installer == nil {
2459 return false
2460 }
2461 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07002462 return true
2463 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002464 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08002465}
2466
Yifan Hong1b3348d2020-01-21 15:53:22 -08002467func (c *Module) InstallInRamdisk() bool {
2468 return c.InRamdisk()
2469}
2470
Jiyong Parkf9332f12018-02-01 00:54:12 +09002471func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07002472 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09002473}
2474
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07002475func (c *Module) HostToolPath() android.OptionalPath {
2476 if c.installer == nil {
2477 return android.OptionalPath{}
2478 }
2479 return c.installer.hostToolPath()
2480}
2481
Nan Zhangd4e641b2017-07-12 12:55:28 -07002482func (c *Module) IntermPathForModuleOut() android.OptionalPath {
2483 return c.outputFile
2484}
2485
Colin Cross41955e82019-05-29 14:40:35 -07002486func (c *Module) OutputFiles(tag string) (android.Paths, error) {
2487 switch tag {
2488 case "":
2489 if c.outputFile.Valid() {
2490 return android.Paths{c.outputFile.Path()}, nil
2491 }
2492 return android.Paths{}, nil
2493 default:
2494 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002495 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002496}
2497
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00002498func (c *Module) static() bool {
2499 if static, ok := c.linker.(interface {
2500 static() bool
2501 }); ok {
2502 return static.static()
2503 }
2504 return false
2505}
2506
Jiyong Park379de2f2018-12-19 02:47:14 +09002507func (c *Module) staticBinary() bool {
2508 if static, ok := c.linker.(interface {
2509 staticBinary() bool
2510 }); ok {
2511 return static.staticBinary()
2512 }
2513 return false
2514}
2515
Jiyong Park1d1119f2019-07-29 21:27:18 +09002516func (c *Module) header() bool {
2517 if h, ok := c.linker.(interface {
2518 header() bool
2519 }); ok {
2520 return h.header()
2521 }
2522 return false
2523}
2524
Jooyung Han38002912019-05-16 04:01:54 +09002525func (c *Module) getMakeLinkType(actx android.ModuleContext) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07002526 if c.UseVndk() {
Jooyung Han38002912019-05-16 04:01:54 +09002527 if lib, ok := c.linker.(*llndkStubDecorator); ok {
2528 if Bool(lib.Properties.Vendor_available) {
Colin Crossb60190a2018-09-04 16:28:17 -07002529 return "native:vndk"
2530 }
Jooyung Han38002912019-05-16 04:01:54 +09002531 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07002532 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002533 if c.IsVndk() && !c.isVndkExt() {
Jooyung Han38002912019-05-16 04:01:54 +09002534 if Bool(c.VendorProperties.Vendor_available) {
2535 return "native:vndk"
2536 }
2537 return "native:vndk_private"
2538 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09002539 if c.inProduct() {
2540 return "native:product"
2541 }
Jooyung Han38002912019-05-16 04:01:54 +09002542 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08002543 } else if c.InRamdisk() {
2544 return "native:ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07002545 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07002546 return "native:recovery"
2547 } else if c.Target().Os == android.Android && String(c.Properties.Sdk_version) != "" {
2548 return "native:ndk:none:none"
2549 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
2550 //family, link := getNdkStlFamilyAndLinkType(c)
2551 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07002552 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08002553 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07002554 } else {
2555 return "native:platform"
2556 }
2557}
2558
Jiyong Park9d452992018-10-03 00:38:19 +09002559// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01002560// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09002561func (c *Module) IsInstallableToApex() bool {
2562 if shared, ok := c.linker.(interface {
2563 shared() bool
2564 }); ok {
Jiyong Park73c54ee2019-10-22 20:31:18 +09002565 // Stub libs and prebuilt libs in a versioned SDK are not
2566 // installable to APEX even though they are shared libs.
2567 return shared.shared() && !c.IsStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01002568 } else if _, ok := c.linker.(testPerSrc); ok {
2569 return true
Jiyong Park9d452992018-10-03 00:38:19 +09002570 }
2571 return false
2572}
2573
Jiyong Parka90ca002019-10-07 15:47:24 +09002574func (c *Module) AvailableFor(what string) bool {
2575 if linker, ok := c.linker.(interface {
2576 availableFor(string) bool
2577 }); ok {
2578 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
2579 } else {
2580 return c.ApexModuleBase.AvailableFor(what)
2581 }
2582}
2583
Inseob Kim1f086e22019-05-09 13:29:15 +09002584func (c *Module) installable() bool {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09002585 ret := c.installer != nil && !c.Properties.PreventInstall && c.outputFile.Valid()
2586
2587 // The platform variant doesn't need further condition. Apex variants however might not
2588 // be installable because it will likely to be included in the APEX and won't appear
2589 // in the system partition.
2590 if c.IsForPlatform() {
2591 return ret
2592 }
2593
2594 // Special case for modules that are configured to be installed to /data, which includes
2595 // test modules. For these modules, both APEX and non-APEX variants are considered as
2596 // installable. This is because even the APEX variants won't be included in the APEX, but
2597 // will anyway be installed to /data/*.
2598 // See b/146995717
2599 if c.InstallInData() {
2600 return ret
2601 }
2602
2603 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09002604}
2605
Logan Chien41eabe62019-04-10 13:33:58 +08002606func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
2607 if c.linker != nil {
2608 if library, ok := c.linker.(*libraryDecorator); ok {
2609 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
2610 }
2611 }
2612}
2613
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002614func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Ivan Lozano183a3212019-10-18 14:18:45 -07002615 if depTag, ok := ctx.OtherModuleDependencyTag(dep).(DependencyTag); ok {
Jiyong Parkd7536ba2020-01-16 17:14:23 +09002616 if cc, ok := dep.(*Module); ok {
2617 if cc.HasStubsVariants() && depTag.Shared && depTag.Library {
2618 // dynamic dep to a stubs lib crosses APEX boundary
2619 return false
2620 }
2621 if depTag.FromStatic {
2622 // shared_lib dependency from a static lib is considered as crossing
2623 // the APEX boundary because the dependency doesn't actually is
2624 // linked; the dependency is used only during the compilation phase.
2625 return false
2626 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002627 }
2628 }
2629 return true
2630}
2631
Colin Cross2ba19d92015-05-07 15:44:20 -07002632//
Colin Crosscfad1192015-11-02 16:43:11 -08002633// Defaults
2634//
Colin Crossca860ac2016-01-04 14:34:37 -08002635type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002636 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07002637 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09002638 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08002639}
2640
Patrice Arrudac249c712019-03-19 17:00:29 -07002641// cc_defaults provides a set of properties that can be inherited by other cc
2642// modules. A module can use the properties from a cc_defaults using
2643// `defaults: ["<:default_module_name>"]`. Properties of both modules are
2644// merged (when possible) by prepending the default module's values to the
2645// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07002646func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07002647 return DefaultsFactory()
2648}
2649
Colin Cross36242852017-06-23 15:06:31 -07002650func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08002651 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08002652
Colin Cross36242852017-06-23 15:06:31 -07002653 module.AddProperties(props...)
2654 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08002655 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002656 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08002657 &BaseCompilerProperties{},
2658 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01002659 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07002660 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07002661 &StaticProperties{},
2662 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07002663 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08002664 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07002665 &TestProperties{},
2666 &TestBinaryProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07002667 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08002668 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08002669 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07002670 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07002671 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07002672 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08002673 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002674 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09002675 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07002676 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07002677 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002678 &android.ProtoProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07002679 )
Colin Crosscfad1192015-11-02 16:43:11 -08002680
Jooyung Hancc372c52019-09-25 15:18:44 +09002681 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002682
2683 return module
Colin Crosscfad1192015-11-02 16:43:11 -08002684}
2685
Jiyong Park6a43f042017-10-12 23:05:00 +09002686func squashVendorSrcs(m *Module) {
2687 if lib, ok := m.compiler.(*libraryDecorator); ok {
2688 lib.baseCompiler.Properties.Srcs = append(lib.baseCompiler.Properties.Srcs,
2689 lib.baseCompiler.Properties.Target.Vendor.Srcs...)
2690
2691 lib.baseCompiler.Properties.Exclude_srcs = append(lib.baseCompiler.Properties.Exclude_srcs,
2692 lib.baseCompiler.Properties.Target.Vendor.Exclude_srcs...)
2693 }
2694}
2695
Jiyong Parkf9332f12018-02-01 00:54:12 +09002696func squashRecoverySrcs(m *Module) {
2697 if lib, ok := m.compiler.(*libraryDecorator); ok {
2698 lib.baseCompiler.Properties.Srcs = append(lib.baseCompiler.Properties.Srcs,
2699 lib.baseCompiler.Properties.Target.Recovery.Srcs...)
2700
2701 lib.baseCompiler.Properties.Exclude_srcs = append(lib.baseCompiler.Properties.Exclude_srcs,
2702 lib.baseCompiler.Properties.Target.Recovery.Exclude_srcs...)
2703 }
2704}
2705
Colin Cross7228ecd2019-11-18 16:00:16 -08002706var _ android.ImageInterface = (*Module)(nil)
Dan Willemsen4416e5d2017-04-06 12:43:22 -07002707
Colin Cross7228ecd2019-11-18 16:00:16 -08002708func (m *Module) ImageMutatorBegin(mctx android.BaseModuleContext) {
Dan Willemsen4416e5d2017-04-06 12:43:22 -07002709 // Sanity check
Logan Chienf3511742017-10-31 18:04:35 +08002710 vendorSpecific := mctx.SocSpecific() || mctx.DeviceSpecific()
Justin Yun9357f4a2018-11-28 15:14:47 +09002711 productSpecific := mctx.ProductSpecific()
Logan Chienf3511742017-10-31 18:04:35 +08002712
2713 if m.VendorProperties.Vendor_available != nil && vendorSpecific {
Dan Willemsen4416e5d2017-04-06 12:43:22 -07002714 mctx.PropertyErrorf("vendor_available",
Jiyong Park2db76922017-11-08 16:03:48 +09002715 "doesn't make sense at the same time as `vendor: true`, `proprietary: true`, or `device_specific:true`")
Dan Willemsen4416e5d2017-04-06 12:43:22 -07002716 }
Logan Chienf3511742017-10-31 18:04:35 +08002717
2718 if vndkdep := m.vndkdep; vndkdep != nil {
2719 if vndkdep.isVndk() {
Justin Yun9357f4a2018-11-28 15:14:47 +09002720 if productSpecific {
2721 mctx.PropertyErrorf("product_specific",
2722 "product_specific must not be true when `vndk: {enabled: true}`")
Justin Yun9357f4a2018-11-28 15:14:47 +09002723 }
Logan Chienf3511742017-10-31 18:04:35 +08002724 if vendorSpecific {
2725 if !vndkdep.isVndkExt() {
2726 mctx.PropertyErrorf("vndk",
2727 "must set `extends: \"...\"` to vndk extension")
Logan Chienf3511742017-10-31 18:04:35 +08002728 }
2729 } else {
2730 if vndkdep.isVndkExt() {
2731 mctx.PropertyErrorf("vndk",
2732 "must set `vendor: true` to set `extends: %q`",
2733 m.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002734 }
2735 if m.VendorProperties.Vendor_available == nil {
2736 mctx.PropertyErrorf("vndk",
2737 "vendor_available must be set to either true or false when `vndk: {enabled: true}`")
Logan Chienf3511742017-10-31 18:04:35 +08002738 }
2739 }
2740 } else {
2741 if vndkdep.isVndkSp() {
2742 mctx.PropertyErrorf("vndk",
2743 "must set `enabled: true` to set `support_system_process: true`")
Logan Chienf3511742017-10-31 18:04:35 +08002744 }
2745 if vndkdep.isVndkExt() {
2746 mctx.PropertyErrorf("vndk",
2747 "must set `enabled: true` to set `extends: %q`",
2748 m.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002749 }
Justin Yun8effde42017-06-23 19:24:43 +09002750 }
2751 }
Dan Willemsen4416e5d2017-04-06 12:43:22 -07002752
Jiyong Parkf9332f12018-02-01 00:54:12 +09002753 var coreVariantNeeded bool = false
Yifan Hong1b3348d2020-01-21 15:53:22 -08002754 var ramdiskVariantNeeded bool = false
Jiyong Parkf9332f12018-02-01 00:54:12 +09002755 var recoveryVariantNeeded bool = false
2756
Inseob Kim64c43952019-08-26 16:52:35 +09002757 var vendorVariants []string
Justin Yun5f7f7e82019-11-18 19:52:14 +09002758 var productVariants []string
Inseob Kim64c43952019-08-26 16:52:35 +09002759
2760 platformVndkVersion := mctx.DeviceConfig().PlatformVndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09002761 boardVndkVersion := mctx.DeviceConfig().VndkVersion()
2762 productVndkVersion := mctx.DeviceConfig().ProductVndkVersion()
2763 if boardVndkVersion == "current" {
2764 boardVndkVersion = platformVndkVersion
2765 }
2766 if productVndkVersion == "current" {
2767 productVndkVersion = platformVndkVersion
Inseob Kim64c43952019-08-26 16:52:35 +09002768 }
2769
Justin Yun5f7f7e82019-11-18 19:52:14 +09002770 if boardVndkVersion == "" {
Dan Willemsen4416e5d2017-04-06 12:43:22 -07002771 // If the device isn't compiling against the VNDK, we always
2772 // use the core mode.
Jiyong Parkf9332f12018-02-01 00:54:12 +09002773 coreVariantNeeded = true
Dan Willemsen4416e5d2017-04-06 12:43:22 -07002774 } else if _, ok := m.linker.(*llndkStubDecorator); ok {
Justin Yun5f7f7e82019-11-18 19:52:14 +09002775 // LL-NDK stubs only exist in the vendor and product variants,
2776 // since the real libraries will be used in the core variant.
Inseob Kim64c43952019-08-26 16:52:35 +09002777 vendorVariants = append(vendorVariants,
2778 platformVndkVersion,
Justin Yun5f7f7e82019-11-18 19:52:14 +09002779 boardVndkVersion,
2780 )
2781 productVariants = append(productVariants,
2782 platformVndkVersion,
2783 productVndkVersion,
Inseob Kim64c43952019-08-26 16:52:35 +09002784 )
Jiyong Park2a454122017-10-19 15:59:33 +09002785 } else if _, ok := m.linker.(*llndkHeadersDecorator); ok {
2786 // ... and LL-NDK headers as well
Inseob Kim64c43952019-08-26 16:52:35 +09002787 vendorVariants = append(vendorVariants,
2788 platformVndkVersion,
Justin Yun5f7f7e82019-11-18 19:52:14 +09002789 boardVndkVersion,
2790 )
2791 productVariants = append(productVariants,
2792 platformVndkVersion,
2793 productVndkVersion,
Inseob Kim64c43952019-08-26 16:52:35 +09002794 )
Inseob Kimeec88e12020-01-22 11:11:29 +09002795 } else if m.isSnapshotPrebuilt() {
Justin Yun71549282017-11-17 12:10:28 +09002796 // Make vendor variants only for the versions in BOARD_VNDK_VERSION and
2797 // PRODUCT_EXTRA_VNDK_VERSIONS.
Inseob Kimeec88e12020-01-22 11:11:29 +09002798 if snapshot, ok := m.linker.(interface {
2799 version() string
2800 }); ok {
2801 vendorVariants = append(vendorVariants, snapshot.version())
2802 } else {
2803 mctx.ModuleErrorf("version is unknown for snapshot prebuilt")
2804 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002805 } else if m.HasVendorVariant() && !vendorSpecific {
Justin Yun5f7f7e82019-11-18 19:52:14 +09002806 // This will be available in /system, /vendor and /product
2807 // or a /system directory that is available to vendor and product.
Jiyong Parkf9332f12018-02-01 00:54:12 +09002808 coreVariantNeeded = true
Inseob Kim64c43952019-08-26 16:52:35 +09002809 vendorVariants = append(vendorVariants, platformVndkVersion)
Justin Yun5f7f7e82019-11-18 19:52:14 +09002810 productVariants = append(productVariants, platformVndkVersion)
Inseob Kimbc093672019-11-01 11:29:44 +09002811 // VNDK modules must not create BOARD_VNDK_VERSION variant because its
2812 // code is PLATFORM_VNDK_VERSION.
2813 // On the other hand, vendor_available modules which are not VNDK should
2814 // also build BOARD_VNDK_VERSION because it's installed in /vendor.
Justin Yun5f7f7e82019-11-18 19:52:14 +09002815 // vendor_available modules are also available to /product.
Inseob Kimbc093672019-11-01 11:29:44 +09002816 if !m.IsVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09002817 vendorVariants = append(vendorVariants, boardVndkVersion)
2818 productVariants = append(productVariants, productVndkVersion)
Inseob Kim64c43952019-08-26 16:52:35 +09002819 }
Logan Chienf3511742017-10-31 18:04:35 +08002820 } else if vendorSpecific && String(m.Properties.Sdk_version) == "" {
Jiyong Park2db76922017-11-08 16:03:48 +09002821 // This will be available in /vendor (or /odm) only
Justin Yun5f7f7e82019-11-18 19:52:14 +09002822 vendorVariants = append(vendorVariants, boardVndkVersion)
Dan Willemsen4416e5d2017-04-06 12:43:22 -07002823 } else {
2824 // This is either in /system (or similar: /data), or is a
2825 // modules built with the NDK. Modules built with the NDK
2826 // will be restricted using the existing link type checks.
Jiyong Parkf9332f12018-02-01 00:54:12 +09002827 coreVariantNeeded = true
2828 }
2829
Justin Yun5f7f7e82019-11-18 19:52:14 +09002830 if boardVndkVersion != "" && productVndkVersion != "" {
2831 if coreVariantNeeded && productSpecific && String(m.Properties.Sdk_version) == "" {
2832 // The module has "product_specific: true" that does not create core variant.
2833 coreVariantNeeded = false
2834 productVariants = append(productVariants, productVndkVersion)
2835 }
2836 } else {
2837 // Unless PRODUCT_PRODUCT_VNDK_VERSION is set, product partition has no
2838 // restriction to use system libs.
2839 // No product variants defined in this case.
2840 productVariants = []string{}
2841 }
2842
Yifan Hong1b3348d2020-01-21 15:53:22 -08002843 if Bool(m.Properties.Ramdisk_available) {
2844 ramdiskVariantNeeded = true
2845 }
2846
2847 if m.ModuleBase.InstallInRamdisk() {
2848 ramdiskVariantNeeded = true
2849 coreVariantNeeded = false
2850 }
2851
Jiyong Parkf9332f12018-02-01 00:54:12 +09002852 if Bool(m.Properties.Recovery_available) {
2853 recoveryVariantNeeded = true
2854 }
2855
2856 if m.ModuleBase.InstallInRecovery() {
2857 recoveryVariantNeeded = true
2858 coreVariantNeeded = false
2859 }
2860
Inseob Kim64c43952019-08-26 16:52:35 +09002861 for _, variant := range android.FirstUniqueStrings(vendorVariants) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09002862 m.Properties.ExtraVariants = append(m.Properties.ExtraVariants, VendorVariationPrefix+variant)
2863 }
2864
2865 for _, variant := range android.FirstUniqueStrings(productVariants) {
2866 m.Properties.ExtraVariants = append(m.Properties.ExtraVariants, ProductVariationPrefix+variant)
Jiyong Parkf9332f12018-02-01 00:54:12 +09002867 }
Colin Cross7228ecd2019-11-18 16:00:16 -08002868
Yifan Hong1b3348d2020-01-21 15:53:22 -08002869 m.Properties.RamdiskVariantNeeded = ramdiskVariantNeeded
Colin Cross7228ecd2019-11-18 16:00:16 -08002870 m.Properties.RecoveryVariantNeeded = recoveryVariantNeeded
2871 m.Properties.CoreVariantNeeded = coreVariantNeeded
2872}
2873
2874func (c *Module) CoreVariantNeeded(ctx android.BaseModuleContext) bool {
2875 return c.Properties.CoreVariantNeeded
2876}
2877
Yifan Hong1b3348d2020-01-21 15:53:22 -08002878func (c *Module) RamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
2879 return c.Properties.RamdiskVariantNeeded
2880}
2881
Colin Cross7228ecd2019-11-18 16:00:16 -08002882func (c *Module) RecoveryVariantNeeded(ctx android.BaseModuleContext) bool {
2883 return c.Properties.RecoveryVariantNeeded
2884}
2885
2886func (c *Module) ExtraImageVariations(ctx android.BaseModuleContext) []string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09002887 return c.Properties.ExtraVariants
Colin Cross7228ecd2019-11-18 16:00:16 -08002888}
2889
2890func (c *Module) SetImageVariation(ctx android.BaseModuleContext, variant string, module android.Module) {
2891 m := module.(*Module)
Yifan Hong1b3348d2020-01-21 15:53:22 -08002892 if variant == android.RamdiskVariation {
2893 m.MakeAsPlatform()
2894 } else if variant == android.RecoveryVariation {
Colin Cross7228ecd2019-11-18 16:00:16 -08002895 m.MakeAsPlatform()
2896 squashRecoverySrcs(m)
2897 } else if strings.HasPrefix(variant, VendorVariationPrefix) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09002898 m.Properties.ImageVariationPrefix = VendorVariationPrefix
Colin Cross7228ecd2019-11-18 16:00:16 -08002899 m.Properties.VndkVersion = strings.TrimPrefix(variant, VendorVariationPrefix)
2900 squashVendorSrcs(m)
Inseob Kimeec88e12020-01-22 11:11:29 +09002901
2902 // Makefile shouldn't know vendor modules other than BOARD_VNDK_VERSION.
2903 // Hide other vendor variants to avoid collision.
2904 vndkVersion := ctx.DeviceConfig().VndkVersion()
2905 if vndkVersion != "current" && vndkVersion != "" && vndkVersion != m.Properties.VndkVersion {
2906 m.Properties.HideFromMake = true
2907 m.SkipInstall()
2908 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09002909 } else if strings.HasPrefix(variant, ProductVariationPrefix) {
2910 m.Properties.ImageVariationPrefix = ProductVariationPrefix
2911 m.Properties.VndkVersion = strings.TrimPrefix(variant, ProductVariationPrefix)
2912 squashVendorSrcs(m)
Dan Willemsen4416e5d2017-04-06 12:43:22 -07002913 }
2914}
2915
Jayant Chowdhary6e8115a2017-05-09 10:21:52 -07002916func getCurrentNdkPrebuiltVersion(ctx DepsContext) string {
Colin Cross6510f912017-11-29 00:27:14 -08002917 if ctx.Config().PlatformSdkVersionInt() > config.NdkMaxPrebuiltVersionInt {
Jayant Chowdhary6e8115a2017-05-09 10:21:52 -07002918 return strconv.Itoa(config.NdkMaxPrebuiltVersionInt)
2919 }
Colin Cross6510f912017-11-29 00:27:14 -08002920 return ctx.Config().PlatformSdkVersion()
Jayant Chowdhary6e8115a2017-05-09 10:21:52 -07002921}
2922
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002923func kytheExtractAllFactory() android.Singleton {
2924 return &kytheExtractAllSingleton{}
2925}
2926
2927type kytheExtractAllSingleton struct {
2928}
2929
2930func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2931 var xrefTargets android.Paths
2932 ctx.VisitAllModules(func(module android.Module) {
2933 if ccModule, ok := module.(xref); ok {
2934 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
2935 }
2936 })
2937 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
2938 if len(xrefTargets) > 0 {
2939 ctx.Build(pctx, android.BuildParams{
2940 Rule: blueprint.Phony,
2941 Output: android.PathForPhony(ctx, "xref_cxx"),
2942 Inputs: xrefTargets,
2943 //Default: true,
2944 })
2945 }
2946}
2947
Colin Cross06a931b2015-10-28 17:23:31 -07002948var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002949var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08002950var BoolPtr = proptools.BoolPtr
2951var String = proptools.String
2952var StringPtr = proptools.StringPtr