blob: 0e5843653871a5b00ffd703f751486332b1f9669 [file] [log] [blame]
Colin Cross5049f022015-03-18 13:28:46 -07001// Copyright 2015 Google Inc. All rights reserved.
Colin Cross3f40fa42015-01-30 17:27:36 -08002//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17// This file contains the module types for compiling C/C++ for Android, and converts the properties
18// into the flags and filenames necessary to pass to the compiler. The final creation of the rules
19// is handled in builder.go
20
21import (
Colin Cross41955e82019-05-29 14:40:35 -070022 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080023 "io"
Dan Albert9e10cd42016-08-03 14:12:14 -070024 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "strings"
26
Colin Cross97ba0732015-03-23 17:50:24 -070027 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070028 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070029
Colin Cross635c3b02016-05-18 15:37:25 -070030 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070031 "android/soong/cc/config"
Colin Cross5049f022015-03-18 13:28:46 -070032 "android/soong/genrule"
Colin Cross3f40fa42015-01-30 17:27:36 -080033)
34
Colin Cross463a90e2015-06-17 14:20:06 -070035func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000036 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070037
Paul Duffin036e7002019-12-19 19:16:28 +000038 pctx.Import("android/soong/cc/config")
39}
40
41func RegisterCCBuildComponents(ctx android.RegistrationContext) {
42 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
43
44 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000045 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090046 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070047 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010048 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070049 ctx.BottomUp("version_selector", versionSelectorMutator).Parallel()
50 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070051 ctx.BottomUp("begin", BeginMutator).Parallel()
Inseob Kimac1e9862019-12-09 18:15:47 +090052 ctx.BottomUp("sysprop_cc", SyspropMutator).Parallel()
Inseob Kimeec88e12020-01-22 11:11:29 +090053 ctx.BottomUp("vendor_snapshot", VendorSnapshotMutator).Parallel()
54 ctx.BottomUp("vendor_snapshot_source", VendorSnapshotSourceMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070055 })
Colin Cross16b23492016-01-06 14:41:07 -080056
Paul Duffin036e7002019-12-19 19:16:28 +000057 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Cross1e676be2016-10-12 14:38:15 -070058 ctx.TopDown("asan_deps", sanitizerDepsMutator(asan))
59 ctx.BottomUp("asan", sanitizerMutator(asan)).Parallel()
Colin Cross16b23492016-01-06 14:41:07 -080060
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070061 ctx.TopDown("hwasan_deps", sanitizerDepsMutator(hwasan))
62 ctx.BottomUp("hwasan", sanitizerMutator(hwasan)).Parallel()
63
Mitch Phillipsbfeade62019-05-01 14:42:05 -070064 ctx.TopDown("fuzzer_deps", sanitizerDepsMutator(fuzzer))
65 ctx.BottomUp("fuzzer", sanitizerMutator(fuzzer)).Parallel()
66
Jiyong Park1d1119f2019-07-29 21:27:18 +090067 // cfi mutator shouldn't run before sanitizers that return true for
68 // incompatibleWithCfi()
Vishwath Mohanb743e9c2017-11-01 09:20:21 +000069 ctx.TopDown("cfi_deps", sanitizerDepsMutator(cfi))
70 ctx.BottomUp("cfi", sanitizerMutator(cfi)).Parallel()
71
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -080072 ctx.TopDown("scs_deps", sanitizerDepsMutator(scs))
73 ctx.BottomUp("scs", sanitizerMutator(scs)).Parallel()
74
Colin Cross1e676be2016-10-12 14:38:15 -070075 ctx.TopDown("tsan_deps", sanitizerDepsMutator(tsan))
76 ctx.BottomUp("tsan", sanitizerMutator(tsan)).Parallel()
Dan Willemsen581341d2017-02-09 16:16:31 -080077
Colin Cross0b908332019-06-19 23:00:20 -070078 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090079 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080080
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080081 ctx.BottomUp("coverage", coverageMutator).Parallel()
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -080082 ctx.TopDown("vndk_deps", sabiDepsMutator)
Stephen Craneba090d12017-05-09 15:44:35 -070083
84 ctx.TopDown("lto_deps", ltoDepsMutator)
85 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090086
Jooyung Han479ca172020-10-19 18:51:07 +090087 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090088 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070089 })
Colin Crossb98c8b02016-07-29 13:44:28 -070090
Colin Cross57898582020-10-29 18:25:19 -070091 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070092}
93
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050094// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
95// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
96// edges to these modules.
97// This object is constructed in DepsMutator, by calling to various module delegates to set
98// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
99// dependencies.
100// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
101// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800102type Deps struct {
103 SharedLibs, LateSharedLibs []string
104 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800105 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800106 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700107
Chris Parsons79d66a52020-06-05 17:26:16 -0400108 // Used for data dependencies adjacent to tests
109 DataLibs []string
110
Yo Chiang219968c2020-09-22 18:45:04 +0800111 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
112 SystemSharedLibs []string
113
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500114 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800115 StaticUnwinderIfLegacy bool
116
Colin Cross5950f382016-12-13 12:50:57 -0800117 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700118
Colin Cross81413472016-04-11 14:37:39 -0700119 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700120
Dan Willemsenb40aab62016-04-20 14:21:14 -0700121 GeneratedSources []string
122 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900123 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700124
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700125 ReexportGeneratedHeaders []string
126
Colin Cross97ba0732015-03-23 17:50:24 -0700127 CrtBegin, CrtEnd string
Dan Willemsena0790e32018-10-12 00:24:23 -0700128
129 // Used for host bionic
130 LinkerFlagsFile string
131 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900132
133 // List of libs that need to be excluded for APEX variant
134 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700135}
136
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500137// PathDeps is a struct containing file paths to dependencies of a module.
138// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
139// It's used to construct flags for various build statements (such as for compiling and linking).
140// It is then passed to module decorator functions responsible for registering build statements
141// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800142type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700143 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900144 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700145 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900146 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700147 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700148 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700149
Colin Cross0de8a1e2020-09-18 14:15:30 -0700150 // Transitive static library dependencies of static libraries for use in ordering.
151 TranstiveStaticLibrariesForOrdering *android.DepSet
152
Colin Cross26c34ed2016-09-30 17:10:16 -0700153 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100154 Objs Objects
155 // Paths to .o files in dependencies that provide them. Note that these lists
156 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800157 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700158 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700159
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100160 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
161 // the libs from all whole_static_lib dependencies.
162 WholeStaticLibsFromPrebuilts android.Paths
163
Colin Cross26c34ed2016-09-30 17:10:16 -0700164 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700165 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900166 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700167
Inseob Kimd110f872019-12-06 13:15:38 +0900168 Flags []string
169 IncludeDirs android.Paths
170 SystemIncludeDirs android.Paths
171 ReexportedDirs android.Paths
172 ReexportedSystemDirs android.Paths
173 ReexportedFlags []string
174 ReexportedGeneratedHeaders android.Paths
175 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700176
Colin Cross26c34ed2016-09-30 17:10:16 -0700177 // Paths to crt*.o files
Colin Cross635c3b02016-05-18 15:37:25 -0700178 CrtBegin, CrtEnd android.OptionalPath
Dan Willemsena0790e32018-10-12 00:24:23 -0700179
180 // Path to the file container flags to use with the linker
181 LinkerFlagsFile android.OptionalPath
182
183 // Path to the dynamic linker binary
184 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700185}
186
Colin Cross4af21ed2019-11-04 09:37:55 -0800187// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
188// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
189// command line so they can be overridden by the local module flags).
190type LocalOrGlobalFlags struct {
191 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700192 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800193 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700194 CFlags []string // Flags that apply to C and C++ source files
195 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
196 ConlyFlags []string // Flags that apply to C source files
197 CppFlags []string // Flags that apply to C++ source files
198 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700199 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800200}
201
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500202// Flags contains various types of command line flags (and settings) for use in building build
203// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800204type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500205 // Local flags (which individual modules are responsible for). These may override global flags.
206 Local LocalOrGlobalFlags
207 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800208 Global LocalOrGlobalFlags
209
210 aidlFlags []string // Flags that apply to aidl source files
211 rsFlags []string // Flags that apply to renderscript source files
212 libFlags []string // Flags to add libraries early to the link order
213 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
214 TidyFlags []string // Flags that apply to clang-tidy
215 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700216
Colin Crossc3199482017-03-30 15:03:04 -0700217 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800218 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700219 SystemIncludeFlags []string
220
Oliver Nguyen04526782020-04-21 12:40:27 -0700221 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500222 Tidy bool // True if clang-tidy is enabled.
223 GcovCoverage bool // True if coverage files should be generated.
224 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700225 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800226
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500227 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800228 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500229 // The target-device system path to the dynamic linker.
230 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800231
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700232 CFlagsDeps android.Paths // Files depended on by compiler flags
233 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800234
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500235 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700236 AssemblerWithCpp bool
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500237 // True if static libraries should be grouped (using `-Wl,--start-group` and `-Wl,--end-group`).
238 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800239
Colin Cross19878da2019-03-28 14:45:07 -0700240 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700241 protoC bool // Whether to use C instead of C++
242 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700243
244 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200245 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700246}
247
Colin Crossca860ac2016-01-04 14:34:37 -0800248// Properties used to compile all C or C++ modules
249type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700250 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800251 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700252
Colin Crossc511bc52020-04-07 16:50:32 +0000253 // Minimum sdk version supported when compiling against the ndk. Setting this property causes
254 // two variants to be built, one for the platform and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800255 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700256
Jooyung Han379660c2020-04-21 15:24:00 +0900257 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
258 Min_sdk_version *string
259
Colin Crossc511bc52020-04-07 16:50:32 +0000260 // If true, always create an sdk variant and don't create a platform variant.
261 Sdk_variant_only *bool
262
Jiyong Parkde866cb2018-12-07 23:08:36 +0900263 AndroidMkSharedLibs []string `blueprint:"mutated"`
264 AndroidMkStaticLibs []string `blueprint:"mutated"`
265 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
266 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700267 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900268 HideFromMake bool `blueprint:"mutated"`
269 PreventInstall bool `blueprint:"mutated"`
270 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700271
Yo Chiang219968c2020-09-22 18:45:04 +0800272 // Set by DepsMutator.
273 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
274
Justin Yun5f7f7e82019-11-18 19:52:14 +0900275 ImageVariationPrefix string `blueprint:"mutated"`
276 VndkVersion string `blueprint:"mutated"`
277 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800278
279 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
280 // file
281 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900282
Yifan Hong39143a92020-10-26 12:43:12 -0700283 // Make this module available when building for ramdisk.
284 // On device without a dedicated recovery partition, the module is only
285 // available after switching root into
286 // /first_stage_ramdisk. To expose the module before switching root, install
287 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800288 Ramdisk_available *bool
289
Yifan Hong39143a92020-10-26 12:43:12 -0700290 // Make this module available when building for vendor ramdisk.
291 // On device without a dedicated recovery partition, the module is only
292 // available after switching root into
293 // /first_stage_ramdisk. To expose the module before switching root, install
294 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700295 Vendor_ramdisk_available *bool
296
Jiyong Parkf9332f12018-02-01 00:54:12 +0900297 // Make this module available when building for recovery
298 Recovery_available *bool
299
Colin Crossae6c5202019-11-20 13:35:50 -0800300 // Set by imageMutator
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700301 CoreVariantNeeded bool `blueprint:"mutated"`
302 RamdiskVariantNeeded bool `blueprint:"mutated"`
303 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
304 RecoveryVariantNeeded bool `blueprint:"mutated"`
305 ExtraVariants []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900306
307 // Allows this module to use non-APEX version of libraries. Useful
308 // for building binaries that are started before APEXes are activated.
309 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900310
311 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
312 // see soong/cc/config/vndk.go
313 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900314
315 // Used by vendor snapshot to record dependencies from snapshot modules.
316 SnapshotSharedLibs []string `blueprint:"mutated"`
317 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000318
319 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000320
321 // Set by factories of module types that can only be referenced from variants compiled against
322 // the SDK.
323 AlwaysSdk bool `blueprint:"mutated"`
324
325 // Variant is an SDK variant created by sdkMutator
326 IsSdkVariant bool `blueprint:"mutated"`
327 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
328 // variant to have a ".sdk" suffix.
329 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700330
331 // Normally Soong uses the directory structure to decide which modules
332 // should be included (framework) or excluded (non-framework) from the
Jose Galmesf7294582020-11-13 12:07:36 -0800333 // different snapshots (vendor, recovery, etc.), but these properties
334 // allow a partner to exclude a module normally thought of as a
335 // framework module from a snapshot.
336 Exclude_from_vendor_snapshot *bool
337 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900338
339 // List of APEXes that this module has private access to for testing purpose. The module
340 // can depend on libraries that are not exported by the APEXes and use private symbols
341 // from the exported libraries.
342 Test_for []string
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700343}
344
345type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900346 // whether this module should be allowed to be directly depended by other
347 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900348 // If set to true, two variants will be built separately, one like
349 // normal, and the other limited to the set of libraries and headers
350 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700351 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900352 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700353 // so it shouldn't have any unversioned runtime dependencies, or
354 // make assumptions about the system that may not be true in the
355 // future.
356 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900357 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900358 //
359 // Default value is true when vndk: {enabled: true} or vendor: true.
360 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700361 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
362 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900363
Justin Yun63e9ec72020-10-29 16:49:43 +0900364 // whether this module should be allowed to be directly depended by other
365 // modules with `product_specific: true` or `product_available: true`.
366 // If set to true, an additional product variant will be built separately
367 // that is limited to the set of libraries and headers that are exposed to
368 // /product modules.
369 //
370 // The product variant may be used with a different (newer) /system,
371 // so it shouldn't have any unversioned runtime dependencies, or
372 // make assumptions about the system that may not be true in the
373 // future.
374 //
375 // It must be set to true by default for vndk: {enabled: true} modules.
376 //
377 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
378 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
379 Product_available *bool
380
Jiyong Park5fb8c102018-04-09 12:03:06 +0900381 // whether this module is capable of being loaded with other instance
382 // (possibly an older version) of the same module in the same process.
383 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
384 // can be double loaded in a vendor process if the library is also a
385 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
386 // explicitly marked as `double_loadable: true` by the owner, or the dependency
387 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
388 Double_loadable *bool
Colin Crossca860ac2016-01-04 14:34:37 -0800389}
390
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500391// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
392// to understanding details about the type of the current module.
393// For example, one might call these functions to determine whether the current module is a static
394// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800395type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800396 static() bool
397 staticBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900398 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900399 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900400 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700401 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900402 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700403 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800404 sdkVersion() string
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700405 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700406 isNdk(config android.Config) bool
Inseob Kim9516ee92019-05-09 10:56:13 +0900407 isLlndk(config android.Config) bool
408 isLlndkPublic(config android.Config) bool
409 isVndkPrivate(config android.Config) bool
Justin Yun8effde42017-06-23 19:24:43 +0900410 isVndk() bool
411 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500412 IsVndkExt() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900413 inProduct() bool
414 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800415 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700416 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900417 inRecovery() bool
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +0800418 shouldCreateSourceAbiDump() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700419 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700420 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800421 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800422 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800423 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800424 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800425 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700426 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700427 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900428 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800429 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700430 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700431 directlyInAnyApex() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800432}
433
434type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700435 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800436 ModuleContextIntf
437}
438
439type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700440 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800441 ModuleContextIntf
442}
443
Colin Cross37047f12016-12-13 17:06:13 -0800444type DepsContext interface {
445 android.BottomUpMutatorContext
446 ModuleContextIntf
447}
448
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500449// feature represents additional (optional) steps to building cc-related modules, such as invocation
450// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800451type feature interface {
452 begin(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800453 deps(ctx DepsContext, deps Deps) Deps
Colin Crossca860ac2016-01-04 14:34:37 -0800454 flags(ctx ModuleContext, flags Flags) Flags
455 props() []interface{}
456}
457
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500458// compiler is the interface for a compiler helper object. Different module decorators may implement
459// this helper differently. For example, compiling a `cc_library` may use a different build
460// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800461type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700462 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800463 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800464 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700465 compilerProps() []interface{}
466
Colin Cross76fada02016-07-27 10:31:13 -0700467 appendCflags([]string)
468 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700469 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800470}
471
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500472// linker is the interface for a linker decorator object. Individual module types can provide
473// their own implementation for this decorator, and thus specify custom logic regarding build
474// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800475type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700476 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800477 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700478 linkerFlags(ctx ModuleContext, flags Flags) Flags
479 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800480 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700481
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700482 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700483 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900484 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700485
486 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900487 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000488
489 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000490 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
491}
492
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500493// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000494type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500495 sharedLibs []string
496 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
497 // libc, libm, etc.)
498 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800499}
500
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500501// installer is the interface for an installer helper object. This helper is responsible for
502// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800503type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700504 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700505 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000506 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800507 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700508 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700509 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900510 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100511 makeUninstallable(mod *Module)
Colin Crossca860ac2016-01-04 14:34:37 -0800512}
513
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800514type xref interface {
515 XrefCcFiles() android.Paths
516}
517
Colin Cross6e511a92020-07-27 21:26:48 -0700518type libraryDependencyKind int
519
520const (
521 headerLibraryDependency = iota
522 sharedLibraryDependency
523 staticLibraryDependency
524)
525
526func (k libraryDependencyKind) String() string {
527 switch k {
528 case headerLibraryDependency:
529 return "headerLibraryDependency"
530 case sharedLibraryDependency:
531 return "sharedLibraryDependency"
532 case staticLibraryDependency:
533 return "staticLibraryDependency"
534 default:
535 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
536 }
537}
538
539type libraryDependencyOrder int
540
541const (
542 earlyLibraryDependency = -1
543 normalLibraryDependency = 0
544 lateLibraryDependency = 1
545)
546
547func (o libraryDependencyOrder) String() string {
548 switch o {
549 case earlyLibraryDependency:
550 return "earlyLibraryDependency"
551 case normalLibraryDependency:
552 return "normalLibraryDependency"
553 case lateLibraryDependency:
554 return "lateLibraryDependency"
555 default:
556 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
557 }
558}
559
560// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
561// tags that have a set of predefined tag objects that are reused for each dependency, a
562// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
563// That means that comparing a libraryDependencyTag for equality will only be equal if all
564// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
565// then check individual metadata fields instead.
566type libraryDependencyTag struct {
567 blueprint.BaseDependencyTag
568
569 // These are exported so that fmt.Printf("%#v") can call their String methods.
570 Kind libraryDependencyKind
571 Order libraryDependencyOrder
572
573 wholeStatic bool
574
575 reexportFlags bool
576 explicitlyVersioned bool
577 dataLib bool
578 ndk bool
579
580 staticUnwinder bool
581
582 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900583
584 // Whether or not this dependency has to be followed for the apex variants
585 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700586}
587
588// header returns true if the libraryDependencyTag is tagging a header lib dependency.
589func (d libraryDependencyTag) header() bool {
590 return d.Kind == headerLibraryDependency
591}
592
593// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
594func (d libraryDependencyTag) shared() bool {
595 return d.Kind == sharedLibraryDependency
596}
597
598// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
599func (d libraryDependencyTag) static() bool {
600 return d.Kind == staticLibraryDependency
601}
602
Colin Crosse9fe2942020-11-10 18:12:15 -0800603// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
604// binaries or other shared libraries are installed as dependencies.
605func (d libraryDependencyTag) InstallDepNeeded() bool {
606 return d.shared()
607}
608
609var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
610
611// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700612// libraryDependencyTag. Each tag object is created globally and reused for multiple
613// dependencies (although since the object contains no references, assigning a tag to a
614// variable and modifying it will not modify the original). Users can compare the tag
615// returned by ctx.OtherModuleDependencyTag against the global original
616type dependencyTag struct {
617 blueprint.BaseDependencyTag
618 name string
619}
620
Colin Crosse9fe2942020-11-10 18:12:15 -0800621// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
622// libraryDependencyTag, but where the dependency needs to be installed when the parent is
623// installed.
624type installDependencyTag struct {
625 blueprint.BaseDependencyTag
626 android.InstallAlwaysNeededDependencyTag
627 name string
628}
629
Colin Crossc99deeb2016-04-11 15:06:20 -0700630var (
Colin Cross6e511a92020-07-27 21:26:48 -0700631 genSourceDepTag = dependencyTag{name: "gen source"}
632 genHeaderDepTag = dependencyTag{name: "gen header"}
633 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
634 objDepTag = dependencyTag{name: "obj"}
635 linkerFlagsDepTag = dependencyTag{name: "linker flags file"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900636 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700637 reuseObjTag = dependencyTag{name: "reuse objects"}
638 staticVariantTag = dependencyTag{name: "static variant"}
639 vndkExtDepTag = dependencyTag{name: "vndk extends"}
640 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800641 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700642 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700643 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700644)
645
Colin Cross56a83212020-09-15 18:30:11 -0700646type copyDirectlyInAnyApexDependencyTag dependencyTag
647
648func (copyDirectlyInAnyApexDependencyTag) CopyDirectlyInAnyApex() {}
649
650var _ android.CopyDirectlyInAnyApexTag = copyDirectlyInAnyApexDependencyTag{}
651
Roland Levillainf89cd092019-07-29 16:22:59 +0100652func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700653 ccLibDepTag, ok := depTag.(libraryDependencyTag)
654 return ok && ccLibDepTag.shared()
655}
656
657func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
658 ccLibDepTag, ok := depTag.(libraryDependencyTag)
659 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100660}
661
Zach Johnson3df4e632020-11-06 11:56:27 -0800662func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
663 ccLibDepTag, ok := depTag.(libraryDependencyTag)
664 return ok && ccLibDepTag.header()
665}
666
Roland Levillainf89cd092019-07-29 16:22:59 +0100667func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800668 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100669}
670
671func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700672 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100673 return ok && ccDepTag == testPerSrcDepTag
674}
675
Colin Crossca860ac2016-01-04 14:34:37 -0800676// Module contains the properties and members used by all C/C++ module types, and implements
677// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500678// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
679// interface.
680//
681// To define a C/C++ related module, construct a new Module object and point its delegates to
682// type-specific structs. These delegates will be invoked to register module-specific build
683// statements which may be unique to the module type. For example, module.compiler.compile() should
684// be defined so as to register build statements which are responsible for compiling the module.
685//
686// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
687// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
688// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
689// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800690type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700691 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700692 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900693 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900694 android.SdkBase
Colin Crossc472d572015-03-17 15:06:21 -0700695
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700696 Properties BaseProperties
697 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700698
Colin Crossca860ac2016-01-04 14:34:37 -0800699 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700700 hod android.HostOrDeviceSupported
701 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700702
Paul Duffina0843f62019-12-13 19:50:38 +0000703 // Allowable SdkMemberTypes of this module type.
704 sdkMemberTypes []android.SdkMemberType
705
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500706 // decorator delegates, initialize before calling Init
707 // these may contain module-specific implementations, and effectively allow for custom
708 // type-specific logic. These members may reference different objects or the same object.
709 // Functions of these decorators will be invoked to initialize and register type-specific
710 // build statements.
Colin Crossb4ce0ec2016-09-13 13:41:39 -0700711 compiler compiler
712 linker linker
713 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500714
715 features []feature
716 stl *stl
717 sanitize *sanitize
718 coverage *coverage
719 sabi *sabi
720 vndkdep *vndkdep
721 lto *lto
722 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800723
Colin Cross31076b32020-10-23 17:22:06 -0700724 library libraryInterface
725
Colin Cross635c3b02016-05-18 15:37:25 -0700726 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800727
Colin Crossb98c8b02016-07-29 13:44:28 -0700728 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700729
730 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800731
732 // Flags used to compile this module
733 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700734
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800735 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700736 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900737
738 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800739 // Kythe (source file indexer) paths for this compilation module
740 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900741
742 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700743 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700744
745 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700746}
747
Ivan Lozano52767be2019-10-18 14:49:46 -0700748func (c *Module) Toc() android.OptionalPath {
749 if c.linker != nil {
750 if library, ok := c.linker.(libraryInterface); ok {
751 return library.toc()
752 }
753 }
754 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
755}
756
757func (c *Module) ApiLevel() string {
758 if c.linker != nil {
759 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700760 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700761 }
762 }
763 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
764}
765
766func (c *Module) Static() bool {
767 if c.linker != nil {
768 if library, ok := c.linker.(libraryInterface); ok {
769 return library.static()
770 }
771 }
772 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
773}
774
775func (c *Module) Shared() bool {
776 if c.linker != nil {
777 if library, ok := c.linker.(libraryInterface); ok {
778 return library.shared()
779 }
780 }
781 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
782}
783
784func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000785 if c.stl != nil {
786 return c.stl.Properties.SelectedStl
787 }
788 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700789}
790
791func (c *Module) ToolchainLibrary() bool {
792 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
793 return true
794 }
795 return false
796}
797
798func (c *Module) NdkPrebuiltStl() bool {
799 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
800 return true
801 }
802 return false
803}
804
805func (c *Module) StubDecorator() bool {
806 if _, ok := c.linker.(*stubDecorator); ok {
807 return true
808 }
809 return false
810}
811
812func (c *Module) SdkVersion() string {
813 return String(c.Properties.Sdk_version)
814}
815
Artur Satayev480e25b2020-04-27 18:53:18 +0100816func (c *Module) MinSdkVersion() string {
817 return String(c.Properties.Min_sdk_version)
818}
819
Dan Albert92fe7402020-07-15 13:33:30 -0700820func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700821 if !c.canUseSdk() {
822 return false
823 }
Dan Albert92fe7402020-07-15 13:33:30 -0700824 if linker, ok := c.linker.(*objectLinker); ok {
825 return linker.isCrt()
826 }
827 return false
828}
829
Colin Crossc511bc52020-04-07 16:50:32 +0000830func (c *Module) AlwaysSdk() bool {
831 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
832}
833
Ivan Lozano183a3212019-10-18 14:18:45 -0700834func (c *Module) CcLibrary() bool {
835 if c.linker != nil {
836 if _, ok := c.linker.(*libraryDecorator); ok {
837 return true
838 }
Colin Crossd48fe732020-09-23 20:37:24 -0700839 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
840 return true
841 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700842 }
843 return false
844}
845
846func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700847 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700848 return true
849 }
850 return false
851}
852
Ivan Lozano2b262972019-11-21 12:30:50 -0800853func (c *Module) NonCcVariants() bool {
854 return false
855}
856
Ivan Lozano183a3212019-10-18 14:18:45 -0700857func (c *Module) SetStatic() {
858 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700859 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700860 library.setStatic()
861 return
862 }
863 }
864 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
865}
866
867func (c *Module) SetShared() {
868 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700869 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700870 library.setShared()
871 return
872 }
873 }
874 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
875}
876
877func (c *Module) BuildStaticVariant() bool {
878 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700879 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700880 return library.buildStatic()
881 }
882 }
883 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
884}
885
886func (c *Module) BuildSharedVariant() bool {
887 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700888 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700889 return library.buildShared()
890 }
891 }
892 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
893}
894
895func (c *Module) Module() android.Module {
896 return c
897}
898
Jiyong Parkc20eee32018-09-05 22:36:17 +0900899func (c *Module) OutputFile() android.OptionalPath {
900 return c.outputFile
901}
902
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400903func (c *Module) CoverageFiles() android.Paths {
904 if c.linker != nil {
905 if library, ok := c.linker.(libraryInterface); ok {
906 return library.objs().coverageFiles
907 }
908 }
909 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
910}
911
Ivan Lozano183a3212019-10-18 14:18:45 -0700912var _ LinkableInterface = (*Module)(nil)
913
Jiyong Park719b4462019-01-13 00:39:51 +0900914func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900915 if c.linker != nil {
916 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +0900917 }
918 return nil
919}
920
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900921func (c *Module) CoverageOutputFile() android.OptionalPath {
922 if c.linker != nil {
923 return c.linker.coverageOutputFilePath()
924 }
925 return android.OptionalPath{}
926}
927
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900928func (c *Module) RelativeInstallPath() string {
929 if c.installer != nil {
930 return c.installer.relativeInstallPath()
931 }
932 return ""
933}
934
Jooyung Han344d5432019-08-23 11:17:39 +0900935func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +0900936 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +0900937}
938
Colin Cross36242852017-06-23 15:06:31 -0700939func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -0700940 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -0800941 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -0700942 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800943 }
944 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -0700945 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800946 }
947 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -0700948 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800949 }
Colin Crossa8e07cc2016-04-04 15:07:06 -0700950 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -0700951 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -0700952 }
Colin Cross16b23492016-01-06 14:41:07 -0800953 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -0700954 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -0800955 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800956 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -0700957 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -0800958 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800959 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -0700960 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800961 }
Justin Yun8effde42017-06-23 19:24:43 +0900962 if c.vndkdep != nil {
963 c.AddProperties(c.vndkdep.props()...)
964 }
Stephen Craneba090d12017-05-09 15:44:35 -0700965 if c.lto != nil {
966 c.AddProperties(c.lto.props()...)
967 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700968 if c.pgo != nil {
969 c.AddProperties(c.pgo.props()...)
970 }
Colin Crossca860ac2016-01-04 14:34:37 -0800971 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -0700972 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -0800973 }
Colin Crossc472d572015-03-17 15:06:21 -0700974
Jiyong Park1613e552020-09-14 19:43:17 +0900975 c.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, os android.OsType) bool {
Elliott Hughes79ae3412020-04-17 15:49:49 -0700976 // Windows builds always prefer 32-bit
Jiyong Park1613e552020-09-14 19:43:17 +0900977 return os == android.Windows
Colin Crossa9d8bee2018-10-02 13:59:46 -0700978 })
Colin Cross36242852017-06-23 15:06:31 -0700979 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +0900980 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900981 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +0900982 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +0900983
Colin Cross36242852017-06-23 15:06:31 -0700984 return c
Colin Crossc472d572015-03-17 15:06:21 -0700985}
986
Colin Crossb916a382016-07-29 17:28:03 -0700987// Returns true for dependency roots (binaries)
988// TODO(ccross): also handle dlopenable libraries
989func (c *Module) isDependencyRoot() bool {
990 if root, ok := c.linker.(interface {
991 isDependencyRoot() bool
992 }); ok {
993 return root.isDependencyRoot()
994 }
995 return false
996}
997
Justin Yun5f7f7e82019-11-18 19:52:14 +0900998// Returns true if the module is using VNDK libraries instead of the libraries in /system/lib or /system/lib64.
999// "product" and "vendor" variant modules return true for this function.
1000// When BOARD_VNDK_VERSION is set, vendor variants of "vendor_available: true", "vendor: true",
1001// "soc_specific: true" and more vendor installed modules are included here.
Justin Yun63e9ec72020-10-29 16:49:43 +09001002// When PRODUCT_PRODUCT_VNDK_VERSION is set, product variants of "product_available: true" or
Justin Yun5f7f7e82019-11-18 19:52:14 +09001003// "product_specific: true" modules are included here.
Ivan Lozano52767be2019-10-18 14:49:46 -07001004func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001005 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001006}
1007
Colin Crossc511bc52020-04-07 16:50:32 +00001008func (c *Module) canUseSdk() bool {
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001009 return c.Os() == android.Android && !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001010}
1011
1012func (c *Module) UseSdk() bool {
1013 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001014 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001015 }
1016 return false
1017}
1018
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001019func (c *Module) isCoverageVariant() bool {
1020 return c.coverage.Properties.IsCoverageVariant
1021}
1022
Colin Cross95f1ca02020-10-29 20:47:22 -07001023func (c *Module) IsNdk(config android.Config) bool {
1024 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001025}
1026
Inseob Kim9516ee92019-05-09 10:56:13 +09001027func (c *Module) isLlndk(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001028 // Returns true for both LLNDK (public) and LLNDK-private libs.
Jooyung Han0302a842019-10-30 18:43:49 +09001029 return isLlndkLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001030}
1031
Inseob Kim9516ee92019-05-09 10:56:13 +09001032func (c *Module) isLlndkPublic(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001033 // Returns true only for LLNDK (public) libs.
Jooyung Han0302a842019-10-30 18:43:49 +09001034 name := c.BaseModuleName()
1035 return isLlndkLibrary(name, config) && !isVndkPrivateLibrary(name, config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001036}
1037
Ivan Lozanof9e21722020-12-02 09:00:51 -05001038func (c *Module) IsVndkPrivate(config android.Config) bool {
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001039 // Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Jooyung Han0302a842019-10-30 18:43:49 +09001040 return isVndkPrivateLibrary(c.BaseModuleName(), config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001041}
1042
Ivan Lozano52767be2019-10-18 14:49:46 -07001043func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001044 if vndkdep := c.vndkdep; vndkdep != nil {
1045 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001046 }
1047 return false
1048}
1049
Yi Kong7e53c572018-02-14 18:16:12 +08001050func (c *Module) isPgoCompile() bool {
1051 if pgo := c.pgo; pgo != nil {
1052 return pgo.Properties.PgoCompile
1053 }
1054 return false
1055}
1056
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001057func (c *Module) isNDKStubLibrary() bool {
1058 if _, ok := c.compiler.(*stubDecorator); ok {
1059 return true
1060 }
1061 return false
1062}
1063
Logan Chienf3511742017-10-31 18:04:35 +08001064func (c *Module) isVndkSp() bool {
1065 if vndkdep := c.vndkdep; vndkdep != nil {
1066 return vndkdep.isVndkSp()
1067 }
1068 return false
1069}
1070
Ivan Lozanof9e21722020-12-02 09:00:51 -05001071func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001072 if vndkdep := c.vndkdep; vndkdep != nil {
1073 return vndkdep.isVndkExt()
1074 }
1075 return false
1076}
1077
Ivan Lozano52767be2019-10-18 14:49:46 -07001078func (c *Module) MustUseVendorVariant() bool {
Jooyung Han097087b2019-10-22 19:32:18 +09001079 return c.isVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001080}
1081
Logan Chienf3511742017-10-31 18:04:35 +08001082func (c *Module) getVndkExtendsModuleName() string {
1083 if vndkdep := c.vndkdep; vndkdep != nil {
1084 return vndkdep.getVndkExtendsModuleName()
1085 }
1086 return ""
1087}
1088
Jiyong Park25fc6a92018-11-18 18:02:45 +09001089func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001090 if lib := c.library; lib != nil {
1091 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001092 }
1093 return false
1094}
1095
1096func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001097 if lib := c.library; lib != nil {
1098 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001099 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001100 return false
1101}
1102
Colin Cross0477b422020-10-13 18:43:54 -07001103// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1104// the implementation. If it is an implementation library it returns its own name.
1105func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1106 name := ctx.OtherModuleName(c)
1107 if versioned, ok := c.linker.(versionedInterface); ok {
1108 name = versioned.implementationModuleName(name)
1109 }
1110 return name
1111}
1112
Martin Stjernholm2856c662020-12-02 15:03:42 +00001113// Similar to ImplementationModuleName, but uses the Make variant of the module
1114// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1115// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1116// under the premise that the prebuilt module overrides its source counterpart
1117// if it is exposed to Make).
1118func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1119 name := c.BaseModuleName()
1120 if versioned, ok := c.linker.(versionedInterface); ok {
1121 name = versioned.implementationModuleName(name)
1122 }
1123 return name
1124}
1125
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001126func (c *Module) bootstrap() bool {
1127 return Bool(c.Properties.Bootstrap)
1128}
1129
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001130func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001131 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1132 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1133 return false
1134 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001135 return c.linker != nil && c.linker.nativeCoverage()
1136}
1137
Inseob Kim8471cda2019-11-15 09:59:12 +09001138func (c *Module) isSnapshotPrebuilt() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09001139 if p, ok := c.linker.(interface{ isSnapshotPrebuilt() bool }); ok {
1140 return p.isSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001141 }
1142 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001143}
1144
Bill Peckham945441c2020-08-31 16:07:58 -07001145func (c *Module) ExcludeFromVendorSnapshot() bool {
1146 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1147}
1148
Jose Galmesf7294582020-11-13 12:07:36 -08001149func (c *Module) ExcludeFromRecoverySnapshot() bool {
1150 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1151}
1152
Jiyong Parkf1194352019-02-25 11:05:47 +09001153func isBionic(name string) bool {
1154 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001155 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001156 return true
1157 }
1158 return false
1159}
1160
Martin Stjernholm279de572019-09-10 23:18:20 +01001161func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001162 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001163 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001164 }
1165 return isBionic(name)
1166}
1167
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001168func (c *Module) XrefCcFiles() android.Paths {
1169 return c.kytheFiles
1170}
1171
Colin Crossca860ac2016-01-04 14:34:37 -08001172type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001173 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001174 moduleContextImpl
1175}
1176
Colin Cross37047f12016-12-13 17:06:13 -08001177type depsContext struct {
1178 android.BottomUpMutatorContext
1179 moduleContextImpl
1180}
1181
Colin Crossca860ac2016-01-04 14:34:37 -08001182type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001183 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001184 moduleContextImpl
1185}
1186
1187type moduleContextImpl struct {
1188 mod *Module
1189 ctx BaseModuleContext
1190}
1191
Colin Crossb98c8b02016-07-29 13:44:28 -07001192func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001193 return ctx.mod.toolchain(ctx.ctx)
1194}
1195
1196func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001197 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001198}
1199
1200func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001201 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001202}
1203
Jiyong Park1d1119f2019-07-29 21:27:18 +09001204func (ctx *moduleContextImpl) header() bool {
1205 return ctx.mod.header()
1206}
1207
Inseob Kim7f283f42020-06-01 21:53:49 +09001208func (ctx *moduleContextImpl) binary() bool {
1209 return ctx.mod.binary()
1210}
1211
Inseob Kim1042d292020-06-01 23:23:05 +09001212func (ctx *moduleContextImpl) object() bool {
1213 return ctx.mod.object()
1214}
1215
Jooyung Hanccce2f22020-03-07 03:45:53 +09001216func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001217 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001218}
1219
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001220func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001221 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001222}
1223
1224func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001225 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001226 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001227 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001228 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001229 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001230 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001231 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001232 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001233 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001234 }
1235 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001236}
1237
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001238func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001239 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001240}
Justin Yun8effde42017-06-23 19:24:43 +09001241
Colin Cross95f1ca02020-10-29 20:47:22 -07001242func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1243 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001244}
1245
Inseob Kim9516ee92019-05-09 10:56:13 +09001246func (ctx *moduleContextImpl) isLlndk(config android.Config) bool {
1247 return ctx.mod.isLlndk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001248}
1249
Inseob Kim9516ee92019-05-09 10:56:13 +09001250func (ctx *moduleContextImpl) isLlndkPublic(config android.Config) bool {
1251 return ctx.mod.isLlndkPublic(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001252}
1253
Inseob Kim9516ee92019-05-09 10:56:13 +09001254func (ctx *moduleContextImpl) isVndkPrivate(config android.Config) bool {
Ivan Lozanof9e21722020-12-02 09:00:51 -05001255 return ctx.mod.IsVndkPrivate(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001256}
1257
Logan Chienf3511742017-10-31 18:04:35 +08001258func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001259 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001260}
1261
Yi Kong7e53c572018-02-14 18:16:12 +08001262func (ctx *moduleContextImpl) isPgoCompile() bool {
1263 return ctx.mod.isPgoCompile()
1264}
1265
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001266func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1267 return ctx.mod.isNDKStubLibrary()
1268}
1269
Justin Yun8effde42017-06-23 19:24:43 +09001270func (ctx *moduleContextImpl) isVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001271 return ctx.mod.isVndkSp()
1272}
1273
Ivan Lozanof9e21722020-12-02 09:00:51 -05001274func (ctx *moduleContextImpl) IsVndkExt() bool {
1275 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001276}
1277
Vic Yangefd249e2018-11-12 20:19:56 -08001278func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001279 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001280}
1281
Logan Chien2f2b8902018-07-10 15:01:19 +08001282// Check whether ABI dumps should be created for this module.
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001283func (ctx *moduleContextImpl) shouldCreateSourceAbiDump() bool {
Logan Chien2f2b8902018-07-10 15:01:19 +08001284 if ctx.ctx.Config().IsEnvTrue("SKIP_ABI_CHECKS") {
1285 return false
Jayant Chowdharyea0a2e12018-03-01 19:12:16 -08001286 }
Doug Hornc32c6b02019-01-17 14:44:05 -08001287
Hsin-Yi Chenf81bb652020-04-07 21:42:19 +08001288 // Coverage builds have extra symbols.
1289 if ctx.mod.isCoverageVariant() {
1290 return false
1291 }
1292
Doug Hornc32c6b02019-01-17 14:44:05 -08001293 if ctx.ctx.Fuchsia() {
1294 return false
1295 }
1296
Logan Chien2f2b8902018-07-10 15:01:19 +08001297 if sanitize := ctx.mod.sanitize; sanitize != nil {
1298 if !sanitize.isVariantOnProductionDevice() {
1299 return false
1300 }
1301 }
1302 if !ctx.ctx.Device() {
1303 // Host modules do not need ABI dumps.
1304 return false
1305 }
Colin Cross31076b32020-10-23 17:22:06 -07001306 if ctx.isNDKStubLibrary() {
Hsin-Yi Chenf6a95462019-06-25 14:46:52 +08001307 // Stubs do not need ABI dumps.
1308 return false
1309 }
Colin Cross31076b32020-10-23 17:22:06 -07001310 if lib := ctx.mod.library; lib != nil && lib.buildStubs() {
1311 // Stubs do not need ABI dumps.
1312 return false
1313 }
1314
Hsin-Yi Chenaf17d742019-07-29 17:46:59 +08001315 return true
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001316}
1317
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001318func (ctx *moduleContextImpl) selectedStl() string {
1319 if stl := ctx.mod.stl; stl != nil {
1320 return stl.Properties.SelectedStl
1321 }
1322 return ""
1323}
1324
Ivan Lozanobd721262018-11-27 14:33:03 -08001325func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1326 return ctx.mod.linker.useClangLld(actx)
1327}
1328
Colin Crossce75d2c2016-10-06 16:12:58 -07001329func (ctx *moduleContextImpl) baseModuleName() string {
1330 return ctx.mod.ModuleBase.BaseModuleName()
1331}
1332
Logan Chienf3511742017-10-31 18:04:35 +08001333func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1334 return ctx.mod.getVndkExtendsModuleName()
1335}
1336
Logan Chiene274fc92019-12-03 11:18:32 -08001337func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001338 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001339}
1340
Colin Crosse07f2312020-08-13 11:24:56 -07001341func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001342 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001343}
1344
Dan Albertc8060532020-07-22 22:32:17 -07001345func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001346 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001347}
1348
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001349func (ctx *moduleContextImpl) bootstrap() bool {
1350 return ctx.mod.bootstrap()
1351}
1352
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001353func (ctx *moduleContextImpl) nativeCoverage() bool {
1354 return ctx.mod.nativeCoverage()
1355}
1356
Colin Cross56a83212020-09-15 18:30:11 -07001357func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1358 return ctx.mod.DirectlyInAnyApex()
1359}
1360
Colin Cross635c3b02016-05-18 15:37:25 -07001361func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001362 return &Module{
1363 hod: hod,
1364 multilib: multilib,
1365 }
1366}
1367
Colin Cross635c3b02016-05-18 15:37:25 -07001368func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001369 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001370 module.features = []feature{
1371 &tidyFeature{},
1372 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001373 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001374 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001375 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001376 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001377 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001378 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001379 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001380 return module
1381}
1382
Colin Crossce75d2c2016-10-06 16:12:58 -07001383func (c *Module) Prebuilt() *android.Prebuilt {
1384 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1385 return p.prebuilt()
1386 }
1387 return nil
1388}
1389
1390func (c *Module) Name() string {
1391 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001392 if p, ok := c.linker.(interface {
1393 Name(string) string
1394 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001395 name = p.Name(name)
1396 }
1397 return name
1398}
1399
Alex Light3d673592019-01-18 14:37:31 -08001400func (c *Module) Symlinks() []string {
1401 if p, ok := c.installer.(interface {
1402 symlinkList() []string
1403 }); ok {
1404 return p.symlinkList()
1405 }
1406 return nil
1407}
1408
Roland Levillainf89cd092019-07-29 16:22:59 +01001409func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1410 test, ok := c.linker.(testPerSrc)
1411 return ok && test.isAllTestsVariation()
1412}
1413
Chris Parsons216e10a2020-07-09 17:12:52 -04001414func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001415 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001416 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001417 }); ok {
1418 return p.dataPaths()
1419 }
1420 return nil
1421}
1422
Justin Yun5f7f7e82019-11-18 19:52:14 +09001423func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1424 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1425 // "current", it will append the VNDK version to the name suffix.
1426 var vndkVersion string
1427 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001428 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001429 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1430 nameSuffix = productSuffix
1431 } else {
1432 vndkVersion = ctx.DeviceConfig().VndkVersion()
1433 nameSuffix = vendorSuffix
1434 }
1435 if vndkVersion == "current" {
1436 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1437 }
1438 if c.Properties.VndkVersion != vndkVersion {
1439 // add version suffix only if the module is using different vndk version than the
1440 // version in product or vendor partition.
1441 nameSuffix += "." + c.Properties.VndkVersion
1442 }
1443 return nameSuffix
1444}
1445
Colin Cross635c3b02016-05-18 15:37:25 -07001446func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Roland Levillainf2fad972019-06-28 15:41:19 +01001447 // Handle the case of a test module split by `test_per_src` mutator.
Roland Levillainf89cd092019-07-29 16:22:59 +01001448 //
1449 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1450 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1451 // module and return early, as this module does not produce an output file per se.
1452 if c.IsTestPerSrcAllTestsVariation() {
1453 c.outputFile = android.OptionalPath{}
1454 return
Roland Levillainf2fad972019-06-28 15:41:19 +01001455 }
1456
Colin Cross56a83212020-09-15 18:30:11 -07001457 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1458 if !apexInfo.IsForPlatform() {
1459 c.hideApexVariantFromMake = true
1460 }
1461
Ivan Lozanof9e21722020-12-02 09:00:51 -05001462 c.makeLinkType = GetMakeLinkType(actx, c)
Inseob Kim9516ee92019-05-09 10:56:13 +09001463
Inseob Kim64c43952019-08-26 16:52:35 +09001464 c.Properties.SubName = ""
1465
1466 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1467 c.Properties.SubName += nativeBridgeSuffix
1468 }
1469
Justin Yun5f7f7e82019-11-18 19:52:14 +09001470 _, llndk := c.linker.(*llndkStubDecorator)
1471 _, llndkHeader := c.linker.(*llndkHeadersDecorator)
Justin Yun63e9ec72020-10-29 16:49:43 +09001472 if llndk || llndkHeader || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001473 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1474 // added for product variant only when we have vendor and product variants with core
1475 // variant. The suffix is not added for vendor-only or product-only module.
1476 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
1477 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001478 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1479 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
1480 c.Properties.SubName += vendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001481 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1482 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001483 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
1484 c.Properties.SubName += vendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001485 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001486 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001487 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001488 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001489 if c.SplitPerApiLevel() {
1490 c.Properties.SubName += "." + c.SdkVersion()
1491 }
Inseob Kim64c43952019-08-26 16:52:35 +09001492 }
1493
Colin Crossca860ac2016-01-04 14:34:37 -08001494 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001495 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001496 moduleContextImpl: moduleContextImpl{
1497 mod: c,
1498 },
1499 }
1500 ctx.ctx = ctx
1501
Colin Crossf18e1102017-11-16 14:33:08 -08001502 deps := c.depsToPaths(ctx)
1503 if ctx.Failed() {
1504 return
1505 }
1506
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001507 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1508 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1509 }
1510
Colin Crossca860ac2016-01-04 14:34:37 -08001511 flags := Flags{
1512 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001513 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001514 }
Colin Crossca860ac2016-01-04 14:34:37 -08001515 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001516 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001517 }
1518 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001519 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001520 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001521 if c.stl != nil {
1522 flags = c.stl.flags(ctx, flags)
1523 }
Colin Cross16b23492016-01-06 14:41:07 -08001524 if c.sanitize != nil {
1525 flags = c.sanitize.flags(ctx, flags)
1526 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001527 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001528 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001529 }
Stephen Craneba090d12017-05-09 15:44:35 -07001530 if c.lto != nil {
1531 flags = c.lto.flags(ctx, flags)
1532 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001533 if c.pgo != nil {
1534 flags = c.pgo.flags(ctx, flags)
1535 }
Colin Crossca860ac2016-01-04 14:34:37 -08001536 for _, feature := range c.features {
1537 flags = feature.flags(ctx, flags)
1538 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001539 if ctx.Failed() {
1540 return
1541 }
1542
Colin Cross4af21ed2019-11-04 09:37:55 -08001543 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1544 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1545 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001546
Colin Cross4af21ed2019-11-04 09:37:55 -08001547 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001548
1549 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001550 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001551 }
1552 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001553 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001554 }
1555
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001556 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001557 // We need access to all the flags seen by a source file.
1558 if c.sabi != nil {
1559 flags = c.sabi.flags(ctx, flags)
1560 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001561
Colin Cross4af21ed2019-11-04 09:37:55 -08001562 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001563
Colin Crossca860ac2016-01-04 14:34:37 -08001564 // Optimization to reduce size of build.ninja
1565 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001566 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1567 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1568 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1569 flags.Local.CFlags = []string{"$cflags"}
1570 flags.Local.CppFlags = []string{"$cppflags"}
1571 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001572
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001573 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001574 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001575 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001576 if ctx.Failed() {
1577 return
1578 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001579 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001580 }
1581
Colin Crossca860ac2016-01-04 14:34:37 -08001582 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001583 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001584 if ctx.Failed() {
1585 return
1586 }
Colin Cross635c3b02016-05-18 15:37:25 -07001587 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001588
Jiyong Parkf7c3bbe2020-12-09 21:18:56 +09001589 // If a lib is directly included in any of the APEXes or is not available to the
1590 // platform (which is often the case when the stub is provided as a prebuilt),
1591 // unhide the stubs variant having the latest version gets visible to make. In
1592 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1593 // force anything in the make world to link against the stubs library. (unless it
1594 // is explicitly referenced via .bootstrap suffix or the module is marked with
1595 // 'bootstrap: true').
1596 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Ivan Lozano52767be2019-10-18 14:49:46 -07001597 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001598 c.IsStubs() && !c.InVendorRamdisk() {
Jiyong Parkb0788572018-12-20 22:10:17 +09001599 c.Properties.HideFromMake = false // unhide
1600 // Note: this is still non-installable
1601 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001602
1603 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current.
1604 if i, ok := c.linker.(snapshotLibraryInterface); ok && ctx.DeviceConfig().VndkVersion() == "current" {
Inseob Kimde5744a2020-12-02 13:14:28 +09001605 if shouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001606 i.collectHeadersForSnapshot(ctx)
1607 }
1608 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001609 }
Colin Cross5049f022015-03-18 13:28:46 -07001610
Colin Cross56a83212020-09-15 18:30:11 -07001611 if c.installable(apexInfo) {
Colin Crossce75d2c2016-10-06 16:12:58 -07001612 c.installer.install(ctx, c.outputFile.Path())
1613 if ctx.Failed() {
1614 return
Colin Crossca860ac2016-01-04 14:34:37 -08001615 }
Paul Duffin0cb37b92020-03-04 14:52:46 +00001616 } else if !proptools.BoolDefault(c.Properties.Installable, true) {
1617 // If the module has been specifically configure to not be installed then
1618 // skip the installation as otherwise it will break when running inside make
1619 // as the output path to install will not be specified. Not all uninstallable
1620 // modules can skip installation as some are needed for resolving make side
1621 // dependencies.
1622 c.SkipInstall()
Dan Albertc403f7c2015-03-18 14:01:18 -07001623 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001624}
1625
Colin Cross0ea8ba82019-06-06 14:33:29 -07001626func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001627 if c.cachedToolchain == nil {
Colin Crossb98c8b02016-07-29 13:44:28 -07001628 c.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
Colin Cross3f40fa42015-01-30 17:27:36 -08001629 }
Colin Crossca860ac2016-01-04 14:34:37 -08001630 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001631}
1632
Colin Crossca860ac2016-01-04 14:34:37 -08001633func (c *Module) begin(ctx BaseModuleContext) {
1634 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001635 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001636 }
Colin Crossca860ac2016-01-04 14:34:37 -08001637 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001638 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001639 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001640 if c.stl != nil {
1641 c.stl.begin(ctx)
1642 }
Colin Cross16b23492016-01-06 14:41:07 -08001643 if c.sanitize != nil {
1644 c.sanitize.begin(ctx)
1645 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001646 if c.coverage != nil {
1647 c.coverage.begin(ctx)
1648 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001649 if c.sabi != nil {
1650 c.sabi.begin(ctx)
1651 }
Justin Yun8effde42017-06-23 19:24:43 +09001652 if c.vndkdep != nil {
1653 c.vndkdep.begin(ctx)
1654 }
Stephen Craneba090d12017-05-09 15:44:35 -07001655 if c.lto != nil {
1656 c.lto.begin(ctx)
1657 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001658 if c.pgo != nil {
1659 c.pgo.begin(ctx)
1660 }
Colin Crossca860ac2016-01-04 14:34:37 -08001661 for _, feature := range c.features {
1662 feature.begin(ctx)
1663 }
Dan Albert92fe7402020-07-15 13:33:30 -07001664 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001665 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001666 if err != nil {
1667 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001668 c.Properties.Sdk_version = nil
1669 } else {
1670 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001671 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001672 }
Colin Crossca860ac2016-01-04 14:34:37 -08001673}
1674
Colin Cross37047f12016-12-13 17:06:13 -08001675func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001676 deps := Deps{}
1677
1678 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001679 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001680 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001681 // Add the PGO dependency (the clang_rt.profile runtime library), which
1682 // sometimes depends on symbols from libgcc, before libgcc gets added
1683 // in linkerDeps().
Pirama Arumuga Nainar49b53d52017-10-04 16:47:29 -07001684 if c.pgo != nil {
1685 deps = c.pgo.deps(ctx, deps)
1686 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001687 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001688 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001689 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001690 if c.stl != nil {
1691 deps = c.stl.deps(ctx, deps)
1692 }
Colin Cross16b23492016-01-06 14:41:07 -08001693 if c.sanitize != nil {
1694 deps = c.sanitize.deps(ctx, deps)
1695 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001696 if c.coverage != nil {
1697 deps = c.coverage.deps(ctx, deps)
1698 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001699 if c.sabi != nil {
1700 deps = c.sabi.deps(ctx, deps)
1701 }
Justin Yun8effde42017-06-23 19:24:43 +09001702 if c.vndkdep != nil {
1703 deps = c.vndkdep.deps(ctx, deps)
1704 }
Stephen Craneba090d12017-05-09 15:44:35 -07001705 if c.lto != nil {
1706 deps = c.lto.deps(ctx, deps)
1707 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001708 for _, feature := range c.features {
1709 deps = feature.deps(ctx, deps)
1710 }
1711
Colin Crossb6715442017-10-24 11:13:31 -07001712 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1713 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1714 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1715 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1716 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1717 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001718 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001719
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001720 for _, lib := range deps.ReexportSharedLibHeaders {
1721 if !inList(lib, deps.SharedLibs) {
1722 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1723 }
1724 }
1725
1726 for _, lib := range deps.ReexportStaticLibHeaders {
1727 if !inList(lib, deps.StaticLibs) {
1728 ctx.PropertyErrorf("export_static_lib_headers", "Static library not in static_libs: '%s'", lib)
1729 }
1730 }
1731
Colin Cross5950f382016-12-13 12:50:57 -08001732 for _, lib := range deps.ReexportHeaderLibHeaders {
1733 if !inList(lib, deps.HeaderLibs) {
1734 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1735 }
1736 }
1737
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001738 for _, gen := range deps.ReexportGeneratedHeaders {
1739 if !inList(gen, deps.GeneratedHeaders) {
1740 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1741 }
1742 }
1743
Colin Crossc99deeb2016-04-11 15:06:20 -07001744 return deps
1745}
1746
Dan Albert7e9d2952016-08-04 13:02:36 -07001747func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001748 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001749 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001750 moduleContextImpl: moduleContextImpl{
1751 mod: c,
1752 },
1753 }
1754 ctx.ctx = ctx
1755
Colin Crossca860ac2016-01-04 14:34:37 -08001756 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001757}
1758
Jiyong Park7ed9de32018-10-15 22:25:07 +09001759// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001760func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001761 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1762 version := name[sharp+1:]
1763 libname := name[:sharp]
1764 return libname, version
1765 }
1766 return name, ""
1767}
1768
Dan Albert92fe7402020-07-15 13:33:30 -07001769func GetCrtVariations(ctx android.BottomUpMutatorContext,
1770 m LinkableInterface) []blueprint.Variation {
1771 if ctx.Os() != android.Android {
1772 return nil
1773 }
1774 if m.UseSdk() {
1775 return []blueprint.Variation{
1776 {Mutator: "sdk", Variation: "sdk"},
Colin Crossbbc941b2020-09-30 12:27:01 -07001777 {Mutator: "version", Variation: m.SdkVersion()},
Dan Albert92fe7402020-07-15 13:33:30 -07001778 }
1779 }
1780 return []blueprint.Variation{
1781 {Mutator: "sdk", Variation: ""},
1782 }
1783}
1784
Colin Crosse7257d22020-09-24 09:56:18 -07001785func (c *Module) addSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext,
1786 variations []blueprint.Variation, depTag libraryDependencyTag, name, version string, far bool) {
1787
1788 variations = append([]blueprint.Variation(nil), variations...)
1789
Colin Cross3146c5c2020-09-30 15:34:40 -07001790 if version != "" && CanBeOrLinkAgainstVersionVariants(c) {
Colin Crosse7257d22020-09-24 09:56:18 -07001791 // Version is explicitly specified. i.e. libFoo#30
1792 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
1793 depTag.explicitlyVersioned = true
1794 }
Colin Crosse7257d22020-09-24 09:56:18 -07001795
Colin Cross0de8a1e2020-09-18 14:15:30 -07001796 if far {
1797 ctx.AddFarVariationDependencies(variations, depTag, name)
1798 } else {
1799 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07001800 }
1801}
1802
Colin Cross1e676be2016-10-12 14:38:15 -07001803func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09001804 if !c.Enabled() {
1805 return
1806 }
1807
Colin Cross37047f12016-12-13 17:06:13 -08001808 ctx := &depsContext{
1809 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07001810 moduleContextImpl: moduleContextImpl{
1811 mod: c,
1812 },
1813 }
1814 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08001815
Colin Crossc99deeb2016-04-11 15:06:20 -07001816 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001817
Yo Chiang219968c2020-09-22 18:45:04 +08001818 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
1819
Dan Albert914449f2016-06-17 16:45:24 -07001820 variantNdkLibs := []string{}
1821 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07001822 if ctx.Os() == android.Android {
Inseob Kimeec88e12020-01-22 11:11:29 +09001823 // rewriteLibs takes a list of names of shared libraries and scans it for three types
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001824 // of names:
Dan Albert914449f2016-06-17 16:45:24 -07001825 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001826 // 1. Name of an NDK library that refers to a prebuilt module.
1827 // For each of these, it adds the name of the prebuilt module (which will be in
1828 // prebuilts/ndk) to the list of nonvariant libs.
1829 // 2. Name of an NDK library that refers to an ndk_library module.
1830 // For each of these, it adds the name of the ndk_library module to the list of
1831 // variant libs.
1832 // 3. Anything else (so anything that isn't an NDK library).
1833 // It adds these to the nonvariantLibs list.
Dan Albert914449f2016-06-17 16:45:24 -07001834 //
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001835 // The caller can then know to add the variantLibs dependencies differently from the
1836 // nonvariantLibs
Inseob Kim9516ee92019-05-09 10:56:13 +09001837
Inseob Kim9516ee92019-05-09 10:56:13 +09001838 vendorPublicLibraries := vendorPublicLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001839 vendorSnapshotSharedLibs := vendorSnapshotSharedLibs(actx.Config())
1840
1841 rewriteVendorLibs := func(lib string) string {
1842 if isLlndkLibrary(lib, ctx.Config()) {
1843 return lib + llndkLibrarySuffix
1844 }
1845
1846 // only modules with BOARD_VNDK_VERSION uses snapshot.
1847 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1848 return lib
1849 }
1850
1851 if snapshot, ok := vendorSnapshotSharedLibs.get(lib, actx.Arch().ArchType); ok {
1852 return snapshot
1853 }
1854
1855 return lib
1856 }
1857
1858 rewriteLibs := func(list []string) (nonvariantLibs []string, variantLibs []string) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001859 variantLibs = []string{}
1860 nonvariantLibs = []string{}
Dan Albert914449f2016-06-17 16:45:24 -07001861 for _, entry := range list {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001862 // strip #version suffix out
Jiyong Park73c54ee2019-10-22 20:31:18 +09001863 name, _ := StubsLibNameAndVersion(entry)
Colin Cross95f1ca02020-10-29 20:47:22 -07001864 if ctx.useSdk() && inList(name, *getNDKKnownLibs(ctx.Config())) {
Dan Albertde5aade2020-06-30 12:32:51 -07001865 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Inseob Kimeec88e12020-01-22 11:11:29 +09001866 } else if ctx.useVndk() {
1867 nonvariantLibs = append(nonvariantLibs, rewriteVendorLibs(entry))
Inseob Kim9516ee92019-05-09 10:56:13 +09001868 } else if (ctx.Platform() || ctx.ProductSpecific()) && inList(name, *vendorPublicLibraries) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001869 vendorPublicLib := name + vendorPublicLibrarySuffix
Jiyong Park374510b2018-03-19 18:23:01 +09001870 if actx.OtherModuleExists(vendorPublicLib) {
1871 nonvariantLibs = append(nonvariantLibs, vendorPublicLib)
1872 } else {
1873 // This can happen if vendor_public_library module is defined in a
1874 // namespace that isn't visible to the current module. In that case,
1875 // link to the original library.
Jiyong Park7ed9de32018-10-15 22:25:07 +09001876 nonvariantLibs = append(nonvariantLibs, name)
Jiyong Park374510b2018-03-19 18:23:01 +09001877 }
Dan Albert914449f2016-06-17 16:45:24 -07001878 } else {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001879 // put name#version back
Dan Willemsen7cbf5f82017-03-28 00:08:30 -07001880 nonvariantLibs = append(nonvariantLibs, entry)
Dan Willemsen72d39932016-07-08 23:23:48 -07001881 }
1882 }
Dan Albert914449f2016-06-17 16:45:24 -07001883 return nonvariantLibs, variantLibs
Dan Willemsen72d39932016-07-08 23:23:48 -07001884 }
1885
Inseob Kimeec88e12020-01-22 11:11:29 +09001886 deps.SharedLibs, variantNdkLibs = rewriteLibs(deps.SharedLibs)
1887 deps.LateSharedLibs, variantLateNdkLibs = rewriteLibs(deps.LateSharedLibs)
1888 deps.ReexportSharedLibHeaders, _ = rewriteLibs(deps.ReexportSharedLibHeaders)
1889 if ctx.useVndk() {
1890 for idx, lib := range deps.RuntimeLibs {
1891 deps.RuntimeLibs[idx] = rewriteVendorLibs(lib)
1892 }
1893 }
Dan Willemsen72d39932016-07-08 23:23:48 -07001894 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001895
Inseob Kimeec88e12020-01-22 11:11:29 +09001896 rewriteSnapshotLibs := func(lib string, snapshotMap *snapshotMap) string {
1897 // only modules with BOARD_VNDK_VERSION uses snapshot.
1898 if c.VndkVersion() != actx.DeviceConfig().VndkVersion() {
1899 return lib
1900 }
1901
1902 if snapshot, ok := snapshotMap.get(lib, actx.Arch().ArchType); ok {
1903 return snapshot
1904 }
1905
1906 return lib
1907 }
1908
1909 vendorSnapshotHeaderLibs := vendorSnapshotHeaderLibs(actx.Config())
Colin Cross32ec36c2016-12-15 07:39:51 -08001910 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001911 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08001912 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001913 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08001914 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001915
1916 lib = rewriteSnapshotLibs(lib, vendorSnapshotHeaderLibs)
1917
Jiyong Park1ad8e162020-12-01 23:40:09 +09001918 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08001919 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001920 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09001921 } else {
1922 actx.AddVariationDependencies(nil, depTag, lib)
1923 }
1924 }
1925
Inseob Kim07def122020-11-23 14:43:02 +09001926 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
1927 // C++ implementation library and one Java implementation library. When a module links against
1928 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
1929 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
1930 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09001931 syspropImplLibraries := syspropImplLibraries(actx.Config())
Inseob Kimeec88e12020-01-22 11:11:29 +09001932 vendorSnapshotStaticLibs := vendorSnapshotStaticLibs(actx.Config())
Inseob Kimc0907f12019-02-08 21:00:45 +09001933
Jiyong Park5d1598f2019-02-25 22:14:17 +09001934 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001935 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09001936 if impl, ok := syspropImplLibraries[lib]; ok {
1937 lib = impl
1938 }
Inseob Kimeec88e12020-01-22 11:11:29 +09001939
1940 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1941
Jiyong Park5d1598f2019-02-25 22:14:17 +09001942 actx.AddVariationDependencies([]blueprint.Variation{
1943 {Mutator: "link", Variation: "static"},
1944 }, depTag, lib)
1945 }
1946
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001947 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001948 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001949 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001950 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001951 }
Jiyong Parke3867542020-12-03 17:28:25 +09001952 if inList(lib, deps.ExcludeLibsForApex) {
1953 depTag.excludeInApex = true
1954 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001955
1956 if impl, ok := syspropImplLibraries[lib]; ok {
1957 lib = impl
1958 }
1959
Inseob Kimeec88e12020-01-22 11:11:29 +09001960 lib = rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs)
1961
Dan Willemsen59339a22018-07-22 21:18:45 -07001962 actx.AddVariationDependencies([]blueprint.Variation{
1963 {Mutator: "link", Variation: "static"},
1964 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001965 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001966
Jooyung Han75568392020-03-20 04:29:24 +09001967 // staticUnwinderDep is treated as staticDep for Q apexes
1968 // so that native libraries/binaries are linked with static unwinder
1969 // because Q libc doesn't have unwinder APIs
1970 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07001971 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001972 actx.AddVariationDependencies([]blueprint.Variation{
1973 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001974 }, depTag, rewriteSnapshotLibs(staticUnwinder(actx), vendorSnapshotStaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08001975 }
1976
Inseob Kimeec88e12020-01-22 11:11:29 +09001977 for _, lib := range deps.LateStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001978 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Inseob Kimeec88e12020-01-22 11:11:29 +09001979 actx.AddVariationDependencies([]blueprint.Variation{
1980 {Mutator: "link", Variation: "static"},
Colin Cross6e511a92020-07-27 21:26:48 -07001981 }, depTag, rewriteSnapshotLibs(lib, vendorSnapshotStaticLibs))
Inseob Kimeec88e12020-01-22 11:11:29 +09001982 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001983
Jiyong Park7ed9de32018-10-15 22:25:07 +09001984 // shared lib names without the #version suffix
1985 var sharedLibNames []string
1986
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001987 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07001988 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001989 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07001990 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001991 }
Jiyong Parke3867542020-12-03 17:28:25 +09001992 if inList(lib, deps.ExcludeLibsForApex) {
1993 depTag.excludeInApex = true
1994 }
Inseob Kimc0907f12019-02-08 21:00:45 +09001995
1996 if impl, ok := syspropImplLibraries[lib]; ok {
1997 lib = impl
1998 }
1999
Jiyong Park73c54ee2019-10-22 20:31:18 +09002000 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002001 sharedLibNames = append(sharedLibNames, name)
2002
Colin Crosse7257d22020-09-24 09:56:18 -07002003 variations := []blueprint.Variation{
2004 {Mutator: "link", Variation: "shared"},
2005 }
2006 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002007 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002008
Jiyong Park7ed9de32018-10-15 22:25:07 +09002009 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002010 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002011 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2012 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2013 // linking against both the stubs lib and the non-stubs lib at the same time.
2014 continue
2015 }
Colin Cross6e511a92020-07-27 21:26:48 -07002016 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002017 variations := []blueprint.Variation{
2018 {Mutator: "link", Variation: "shared"},
2019 }
2020 c.addSharedLibDependenciesWithVersions(ctx, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002021 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002022
Dan Willemsen59339a22018-07-22 21:18:45 -07002023 actx.AddVariationDependencies([]blueprint.Variation{
2024 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002025 }, dataLibDepTag, deps.DataLibs...)
2026
2027 actx.AddVariationDependencies([]blueprint.Variation{
2028 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002029 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002030
Colin Cross68861832016-07-08 10:41:41 -07002031 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002032
2033 for _, gen := range deps.GeneratedHeaders {
2034 depTag := genHeaderDepTag
2035 if inList(gen, deps.ReexportGeneratedHeaders) {
2036 depTag = genHeaderExportDepTag
2037 }
2038 actx.AddDependency(c, depTag, gen)
2039 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002040
Inseob Kim1042d292020-06-01 23:23:05 +09002041 vendorSnapshotObjects := vendorSnapshotObjects(actx.Config())
2042
Dan Albert92fe7402020-07-15 13:33:30 -07002043 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002044 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc99deeb2016-04-11 15:06:20 -07002045 if deps.CrtBegin != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07002046 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
2047 rewriteSnapshotLibs(deps.CrtBegin, vendorSnapshotObjects))
Colin Crossca860ac2016-01-04 14:34:37 -08002048 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002049 if deps.CrtEnd != "" {
Dan Albert92fe7402020-07-15 13:33:30 -07002050 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
2051 rewriteSnapshotLibs(deps.CrtEnd, vendorSnapshotObjects))
Colin Cross21b9a242015-03-24 14:15:58 -07002052 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002053 if deps.LinkerFlagsFile != "" {
2054 actx.AddDependency(c, linkerFlagsDepTag, deps.LinkerFlagsFile)
2055 }
2056 if deps.DynamicLinker != "" {
2057 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002058 }
Dan Albert914449f2016-06-17 16:45:24 -07002059
2060 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002061
2062 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002063 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002064 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002065 {Mutator: "link", Variation: "shared"},
2066 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002067
2068 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002069 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002070 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002071 {Mutator: "link", Variation: "shared"},
2072 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002073
2074 if vndkdep := c.vndkdep; vndkdep != nil {
2075 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002076 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002077 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002078 {Mutator: "link", Variation: "shared"},
2079 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002080 }
2081 }
Colin Cross6362e272015-10-29 15:25:03 -07002082}
Colin Cross21b9a242015-03-24 14:15:58 -07002083
Colin Crosse40b4ea2018-10-02 22:25:58 -07002084func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002085 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2086 c.beginMutator(ctx)
2087 }
2088}
2089
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002090// Whether a module can link to another module, taking into
2091// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002092func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002093 tag blueprint.DependencyTag) {
2094
2095 switch t := tag.(type) {
2096 case dependencyTag:
2097 if t != vndkExtDepTag {
2098 return
2099 }
2100 case libraryDependencyTag:
2101 default:
2102 return
2103 }
2104
Ivan Lozanof9e21722020-12-02 09:00:51 -05002105 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002106 // Host code is not restricted
2107 return
2108 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002109
2110 // VNDK is cc.Module supported only for now.
2111 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002112 // Though allowed dependency is limited by the image mutator,
2113 // each vendor and product module needs to check link-type
2114 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002115 if ccTo, ok := to.(*Module); ok {
2116 if ccFrom.vndkdep != nil {
2117 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2118 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05002119 } else if linkableMod, ok := to.(LinkableInterface); ok {
2120 // Static libraries from other languages can be linked
2121 if !linkableMod.Static() {
2122 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
2123 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002124 } else {
2125 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002126 }
2127 return
2128 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002129 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002130 // Platform code can link to anything
2131 return
2132 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002133 if from.InRamdisk() {
2134 // Ramdisk code is not NDK
2135 return
2136 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002137 if from.InVendorRamdisk() {
2138 // Vendor ramdisk code is not NDK
2139 return
2140 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002141 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002142 // Recovery code is not NDK
2143 return
2144 }
Colin Cross31076b32020-10-23 17:22:06 -07002145 if c, ok := to.(*Module); ok {
2146 if c.ToolchainLibrary() {
2147 // These are always allowed
2148 return
2149 }
2150 if c.NdkPrebuiltStl() {
2151 // These are allowed, but they don't set sdk_version
2152 return
2153 }
2154 if c.StubDecorator() {
2155 // These aren't real libraries, but are the stub shared libraries that are included in
2156 // the NDK.
2157 return
2158 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002159 }
Logan Chien834b9a62019-01-14 15:39:03 +08002160
Ivan Lozano52767be2019-10-18 14:49:46 -07002161 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002162 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2163 // to link to libc++ (non-NDK and without sdk_version).
2164 return
2165 }
2166
Ivan Lozano52767be2019-10-18 14:49:46 -07002167 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002168 // NDK code linking to platform code is never okay.
2169 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002170 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002171 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002172 }
2173
2174 // At this point we know we have two NDK libraries, but we need to
2175 // check that we're not linking against anything built against a higher
2176 // API level, as it is only valid to link against older or equivalent
2177 // APIs.
2178
Inseob Kim01a28722018-04-11 09:48:45 +09002179 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002180 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002181 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002182 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002183 // Current can't be linked against by anything else.
2184 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002185 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002186 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002187 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002188 if err != nil {
2189 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002190 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002191 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002192 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002193 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002194 if err != nil {
2195 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002196 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002197 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002198 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002199
Inseob Kim01a28722018-04-11 09:48:45 +09002200 if toApi > fromApi {
2201 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002202 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002203 }
2204 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002205 }
Dan Albert202fe492017-12-15 13:56:59 -08002206
2207 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002208 fromStl := from.SelectedStl()
2209 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002210 if fromStl == "" || toStl == "" {
2211 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002212 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002213 // We can be permissive with the system "STL" since it is only the C++
2214 // ABI layer, but in the future we should make sure that everyone is
2215 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002216 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002217 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002218 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2219 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002220 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002221}
2222
Jooyung Han479ca172020-10-19 18:51:07 +09002223func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2224 if c, ok := ctx.Module().(*Module); ok {
2225 ctx.VisitDirectDeps(func(dep android.Module) {
2226 depTag := ctx.OtherModuleDependencyTag(dep)
2227 ccDep, ok := dep.(LinkableInterface)
2228 if ok {
2229 checkLinkType(ctx, c, ccDep, depTag)
2230 }
2231 })
2232 }
2233}
2234
Jiyong Park5fb8c102018-04-09 12:03:06 +09002235// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002236// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2237// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002238// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002239func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2240 check := func(child, parent android.Module) bool {
2241 to, ok := child.(*Module)
2242 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002243 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002244 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002245
Jooyung Hana70f0672019-01-18 15:20:43 +09002246 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2247 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002248 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002249
Jiyong Park1ad8e162020-12-01 23:40:09 +09002250 depTag := ctx.OtherModuleDependencyTag(child)
2251 if IsHeaderDepTag(depTag) {
2252 return false
2253 }
2254
Justin Yun63e9ec72020-10-29 16:49:43 +09002255 // Even if target lib has no vendor variant, keep checking dependency
2256 // graph in case it depends on vendor_available or product_available
2257 // but not double_loadable transtively.
2258 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002259 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002260 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002261
Jooyung Han0302a842019-10-30 18:43:49 +09002262 if to.isVndkSp() || to.isLlndk(ctx.Config()) || Bool(to.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002263 return false
2264 }
2265
2266 var stringPath []string
2267 for _, m := range ctx.GetWalkPath() {
2268 stringPath = append(stringPath, m.Name())
2269 }
2270 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2271 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
2272 "(dependency: %s)", ctx.OtherModuleName(to), strings.Join(stringPath, " -> "))
2273 return false
2274 }
2275 if module, ok := ctx.Module().(*Module); ok {
2276 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jooyung Han0302a842019-10-30 18:43:49 +09002277 if module.isLlndk(ctx.Config()) || Bool(module.VendorProperties.Double_loadable) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002278 ctx.WalkDeps(check)
2279 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002280 }
2281 }
2282}
2283
Colin Cross0de8a1e2020-09-18 14:15:30 -07002284// Returns the highest version which is <= maxSdkVersion.
2285// For example, with maxSdkVersion is 10 and versionList is [9,11]
2286// it returns 9 as string. The list of stubs must be in order from
2287// oldest to newest.
Chris Parsons3c27ca32020-11-20 12:42:07 -05002288func (c *Module) chooseSdkVersion(ctx android.PathContext, stubsInfo []SharedStubLibrary,
2289 maxSdkVersion android.ApiLevel) (SharedStubLibrary, error) {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002290
2291 for i := range stubsInfo {
2292 stubInfo := stubsInfo[len(stubsInfo)-i-1]
2293 var ver android.ApiLevel
2294 if stubInfo.Version == "" {
2295 ver = android.FutureApiLevel
2296 } else {
2297 var err error
2298 ver, err = android.ApiLevelFromUser(ctx, stubInfo.Version)
2299 if err != nil {
Chris Parsons3c27ca32020-11-20 12:42:07 -05002300 return SharedStubLibrary{}, err
Colin Cross0de8a1e2020-09-18 14:15:30 -07002301 }
2302 }
2303 if ver.LessThanOrEqualTo(maxSdkVersion) {
2304 return stubInfo, nil
2305 }
2306 }
2307 var versionList []string
2308 for _, stubInfo := range stubsInfo {
2309 versionList = append(versionList, stubInfo.Version)
2310 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05002311 return SharedStubLibrary{}, fmt.Errorf("not found a version(<=%s) in versionList: %v", maxSdkVersion.String(), versionList)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002312}
2313
Colin Crossc99deeb2016-04-11 15:06:20 -07002314// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002315func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002316 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002317
Colin Cross0de8a1e2020-09-18 14:15:30 -07002318 var directStaticDeps []StaticLibraryInfo
2319 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002320
Colin Cross0de8a1e2020-09-18 14:15:30 -07002321 reexportExporter := func(exporter FlagExporterInfo) {
2322 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2323 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2324 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2325 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2326 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002327 }
2328
Jooyung Hande34d232020-07-23 13:04:15 +09002329 // For the dependency from platform to apex, use the latest stubs
2330 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002331 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2332 if !apexInfo.IsForPlatform() {
2333 c.apexSdkVersion = apexInfo.MinSdkVersion(ctx)
Jooyung Hande34d232020-07-23 13:04:15 +09002334 }
2335
2336 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2337 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2338 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2339 // (b/144430859)
2340 c.apexSdkVersion = android.FutureApiLevel
2341 }
2342
Colin Crossd11fcda2017-10-23 17:59:01 -07002343 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002344 depName := ctx.OtherModuleName(dep)
2345 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002346
Ivan Lozano52767be2019-10-18 14:49:46 -07002347 ccDep, ok := dep.(LinkableInterface)
2348 if !ok {
2349
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002350 // handling for a few module types that aren't cc Module but that are also supported
2351 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002352 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002353 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002354 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2355 genRule.GeneratedSourceFiles()...)
2356 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002357 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002358 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002359 // Support exported headers from a generated_sources dependency
2360 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002361 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002362 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002363 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002364 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002365 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002366 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002367 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002368 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002369 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2370 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002371 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002372 // 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 +09002373 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002374
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002375 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002376 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002377 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002378 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002379 case linkerFlagsDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002380 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002381 files := genRule.GeneratedSourceFiles()
2382 if len(files) == 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002383 depPaths.LinkerFlagsFile = android.OptionalPathForPath(files[0])
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002384 } else if len(files) > 1 {
Dan Willemsena0790e32018-10-12 00:24:23 -07002385 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 -07002386 }
2387 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002388 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002389 }
Colin Crossca860ac2016-01-04 14:34:37 -08002390 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002391 return
2392 }
2393
Colin Crossfe17f6f2019-03-28 19:30:56 -07002394 if depTag == android.ProtoPluginDepTag {
2395 return
2396 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002397 if depTag == llndkImplDep {
2398 return
2399 }
Colin Crossfe17f6f2019-03-28 19:30:56 -07002400
Colin Crossd11fcda2017-10-23 17:59:01 -07002401 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002402 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2403 return
2404 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002405 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002406 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2407 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002408 return
2409 }
2410
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002411 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002412 // Skip reused objects for stub libraries, they use their own stub object file instead.
2413 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2414 // version mutator, so the stubs variant is created from the shared variant that
2415 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002416 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002417 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2418 objs := staticAnalogue.ReuseObjects
2419 depPaths.Objs = depPaths.Objs.Append(objs)
2420 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2421 reexportExporter(depExporterInfo)
2422 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002423 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002424 }
2425
Colin Cross6e511a92020-07-27 21:26:48 -07002426 linkFile := ccDep.OutputFile()
2427
2428 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2429 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002430 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002431 return
2432 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002433
Jiyong Parke3867542020-12-03 17:28:25 +09002434 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2435 return
2436 }
2437
Colin Cross0de8a1e2020-09-18 14:15:30 -07002438 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002439
Colin Cross6e511a92020-07-27 21:26:48 -07002440 var ptr *android.Paths
2441 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002442
Colin Cross6e511a92020-07-27 21:26:48 -07002443 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002444
Colin Cross6e511a92020-07-27 21:26:48 -07002445 switch {
2446 case libDepTag.header():
2447 // nothing
2448 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002449 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2450 if !ctx.Config().AllowMissingDependencies() {
2451 ctx.ModuleErrorf("module %q is not a shared library", depName)
2452 } else {
2453 ctx.AddMissingDependencies([]string{depName})
2454 }
2455 return
2456 }
Jiyong Parke3867542020-12-03 17:28:25 +09002457
Colin Cross0de8a1e2020-09-18 14:15:30 -07002458 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05002459 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002460
Chris Parsons3c27ca32020-11-20 12:42:07 -05002461 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002462 useStubs := false
Colin Cross31076b32020-10-23 17:22:06 -07002463
2464 if lib := moduleLibraryInterface(dep); lib.buildStubs() && c.UseVndk() { // LLNDK
Colin Cross0de8a1e2020-09-18 14:15:30 -07002465 if !apexInfo.IsForPlatform() {
2466 // For platform libraries, use current version of LLNDK
2467 // If this is for use_vendor apex we will apply the same rules
2468 // of apex sdk enforcement below to choose right version.
2469 useStubs = true
2470 }
2471 } else if apexInfo.IsForPlatform() {
2472 // If not building for APEX, use stubs only when it is from
2473 // an APEX (and not from platform)
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002474 // However, for host, ramdisk, vendor_ramdisk, recovery or bootstrap modules,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002475 // always link to non-stub variant
Jiyong Parkf7c3bbe2020-12-09 21:18:56 +09002476 useStubs = dep.(android.ApexModule).NotInPlatform() && !c.bootstrap()
Colin Cross0de8a1e2020-09-18 14:15:30 -07002477 // Another exception: if this module is bundled with an APEX, then
2478 // it is linked with the non-stub variant of a module in the APEX
2479 // as if this is part of the APEX.
2480 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2481 for _, apexContents := range testFor.ApexContents {
2482 if apexContents.DirectlyInApex(depName) {
2483 useStubs = false
2484 break
2485 }
2486 }
2487 } else {
2488 // If building for APEX, use stubs when the parent is in any APEX that
2489 // the child is not in.
2490 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2491 }
2492
2493 // when to use (unspecified) stubs, check min_sdk_version and choose the right one
2494 if useStubs {
2495 sharedLibraryStubsInfo, err :=
Chris Parsons3c27ca32020-11-20 12:42:07 -05002496 c.chooseSdkVersion(ctx, sharedLibraryStubsInfo.SharedStubLibraries, c.apexSdkVersion)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002497 if err != nil {
2498 ctx.OtherModuleErrorf(dep, err.Error())
2499 return
2500 }
2501 sharedLibraryInfo = sharedLibraryStubsInfo.SharedLibraryInfo
2502 depExporterInfo = sharedLibraryStubsInfo.FlagExporterInfo
2503 }
2504 }
2505
Jiyong Park1ad8e162020-12-01 23:40:09 +09002506 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2507 // linkFile, depFile, and ptr.
2508 if c.IsStubs() {
2509 break
2510 }
2511
Colin Cross0de8a1e2020-09-18 14:15:30 -07002512 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2513 depFile = sharedLibraryInfo.TableOfContents
2514
Colin Cross6e511a92020-07-27 21:26:48 -07002515 ptr = &depPaths.SharedLibs
2516 switch libDepTag.Order {
2517 case earlyLibraryDependency:
2518 ptr = &depPaths.EarlySharedLibs
2519 depPtr = &depPaths.EarlySharedLibsDeps
2520 case normalLibraryDependency:
2521 ptr = &depPaths.SharedLibs
2522 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002523 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002524 case lateLibraryDependency:
2525 ptr = &depPaths.LateSharedLibs
2526 depPtr = &depPaths.LateSharedLibsDeps
2527 default:
2528 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002529 }
Colin Cross6e511a92020-07-27 21:26:48 -07002530 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002531 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2532 if !ctx.Config().AllowMissingDependencies() {
2533 ctx.ModuleErrorf("module %q is not a static library", depName)
2534 } else {
2535 ctx.AddMissingDependencies([]string{depName})
2536 }
2537 return
2538 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002539
2540 // Stubs lib doesn't link to the static lib dependencies. Don't set
2541 // linkFile, depFile, and ptr.
2542 if c.IsStubs() {
2543 break
2544 }
2545
Colin Cross0de8a1e2020-09-18 14:15:30 -07002546 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2547 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002548 if libDepTag.wholeStatic {
2549 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002550 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2551 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002552 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002553 // This case normally catches prebuilt static
2554 // libraries, but it can also occur when
2555 // AllowMissingDependencies is on and the
2556 // dependencies has no sources of its own
2557 // but has a whole_static_libs dependency
2558 // on a missing library. We want to depend
2559 // on the .a file so that there is something
2560 // in the dependency tree that contains the
2561 // error rule for the missing transitive
2562 // dependency.
2563 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002564 }
Colin Cross6e511a92020-07-27 21:26:48 -07002565 } else {
2566 switch libDepTag.Order {
2567 case earlyLibraryDependency:
2568 panic(fmt.Errorf("early static libs not suppported"))
2569 case normalLibraryDependency:
2570 // static dependencies will be handled separately so they can be ordered
2571 // using transitive dependencies.
2572 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002573 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002574 case lateLibraryDependency:
2575 ptr = &depPaths.LateStaticLibs
2576 default:
2577 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002578 }
2579 }
2580 }
2581
Colin Cross6e511a92020-07-27 21:26:48 -07002582 if libDepTag.static() && !libDepTag.wholeStatic {
2583 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2584 ctx.ModuleErrorf("module %q not a static library", depName)
2585 return
2586 }
Logan Chien43d34c32017-12-20 01:17:32 +08002587
Colin Cross6e511a92020-07-27 21:26:48 -07002588 // When combining coverage files for shared libraries and executables, coverage files
2589 // in static libraries act as if they were whole static libraries. The same goes for
2590 // source based Abi dump files.
2591 if c, ok := ccDep.(*Module); ok {
2592 staticLib := c.linker.(libraryInterface)
2593 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2594 staticLib.objs().coverageFiles...)
2595 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2596 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002597 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002598 // Handle non-CC modules here
2599 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002600 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002601 }
2602 }
2603
Colin Cross6e511a92020-07-27 21:26:48 -07002604 if ptr != nil {
2605 if !linkFile.Valid() {
2606 if !ctx.Config().AllowMissingDependencies() {
2607 ctx.ModuleErrorf("module %q missing output file", depName)
2608 } else {
2609 ctx.AddMissingDependencies([]string{depName})
2610 }
2611 return
2612 }
2613 *ptr = append(*ptr, linkFile.Path())
2614 }
2615
2616 if depPtr != nil {
2617 dep := depFile
2618 if !dep.Valid() {
2619 dep = linkFile
2620 }
2621 *depPtr = append(*depPtr, dep.Path())
2622 }
2623
Colin Cross0de8a1e2020-09-18 14:15:30 -07002624 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2625 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2626 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2627 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2628
2629 if libDepTag.reexportFlags {
2630 reexportExporter(depExporterInfo)
2631 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2632 // Re-exported shared library headers must be included as well since they can help us with type information
2633 // about template instantiations (instantiated from their headers).
2634 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2635 // scripts.
2636 c.sabi.Properties.ReexportedIncludes = append(
2637 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2638 }
2639
Colin Cross6e511a92020-07-27 21:26:48 -07002640 makeLibName := c.makeLibName(ctx, ccDep, depName) + libDepTag.makeSuffix
2641 switch {
2642 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002643 c.Properties.AndroidMkHeaderLibs = append(
2644 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002645 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002646 if lib := moduleLibraryInterface(dep); lib != nil {
2647 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002648 // Add the dependency to the APEX(es) providing the library so that
2649 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002650 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
2651 for _, an := range depApexInfo.InApexes {
Colin Cross6e511a92020-07-27 21:26:48 -07002652 c.Properties.ApexesProvidingSharedLibs = append(
2653 c.Properties.ApexesProvidingSharedLibs, an)
2654 }
2655 }
2656 }
2657
2658 // Note: the order of libs in this list is not important because
2659 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002660 c.Properties.AndroidMkSharedLibs = append(
2661 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002662 // Record baseLibName for snapshots.
2663 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, baseLibName(depName))
2664 case libDepTag.static():
2665 if libDepTag.wholeStatic {
2666 c.Properties.AndroidMkWholeStaticLibs = append(
2667 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2668 } else {
2669 c.Properties.AndroidMkStaticLibs = append(
2670 c.Properties.AndroidMkStaticLibs, makeLibName)
2671 }
2672 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002673 } else if !c.IsStubs() {
2674 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2675
Colin Cross6e511a92020-07-27 21:26:48 -07002676 switch depTag {
2677 case runtimeDepTag:
2678 c.Properties.AndroidMkRuntimeLibs = append(
2679 c.Properties.AndroidMkRuntimeLibs, c.makeLibName(ctx, ccDep, depName)+libDepTag.makeSuffix)
2680 // Record baseLibName for snapshots.
2681 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, baseLibName(depName))
2682 case objDepTag:
2683 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2684 case CrtBeginDepTag:
2685 depPaths.CrtBegin = linkFile
2686 case CrtEndDepTag:
2687 depPaths.CrtEnd = linkFile
2688 case dynamicLinkerDepTag:
2689 depPaths.DynamicLinker = linkFile
2690 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002691 }
Colin Crossca860ac2016-01-04 14:34:37 -08002692 })
2693
Jeff Gaston294356f2017-09-27 17:05:30 -07002694 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002695 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2696 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2697 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002698
Colin Crossdd84e052017-05-17 13:44:16 -07002699 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002700 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002701 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2702 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002703 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002704 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2705 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002706 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002707 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002708 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002709
2710 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002711 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002712 }
Colin Crossdd84e052017-05-17 13:44:16 -07002713
Colin Crossca860ac2016-01-04 14:34:37 -08002714 return depPaths
2715}
2716
Colin Cross0de8a1e2020-09-18 14:15:30 -07002717// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2718// to match the topological order of the dependency tree, including any static analogues of
2719// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2720// of the transitive dependencies.
2721func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2722 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2723 var staticPaths android.Paths
2724 for _, staticDep := range staticDeps {
2725 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2726 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2727 }
2728 for _, sharedDep := range sharedDeps {
2729 if sharedDep.StaticAnalogue != nil {
2730 transitiveStaticLibsBuilder.Transitive(sharedDep.StaticAnalogue.TransitiveStaticLibrariesForOrdering)
2731 }
2732 }
2733 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2734
2735 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2736
2737 // reorder the dependencies based on transitive dependencies
2738 staticPaths = android.FirstUniquePaths(staticPaths)
2739 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2740
2741 if len(orderedStaticPaths) != len(staticPaths) {
2742 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2743 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2744 }
2745
2746 return orderedStaticPaths, transitiveStaticLibs
2747}
2748
Colin Cross6e511a92020-07-27 21:26:48 -07002749// baseLibName trims known prefixes and suffixes
2750func baseLibName(depName string) string {
2751 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
2752 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
2753 libName = strings.TrimPrefix(libName, "prebuilt_")
2754 return libName
2755}
2756
2757func (c *Module) makeLibName(ctx android.ModuleContext, ccDep LinkableInterface, depName string) string {
2758 vendorSuffixModules := vendorSuffixModules(ctx.Config())
2759 vendorPublicLibraries := vendorPublicLibraries(ctx.Config())
2760
2761 libName := baseLibName(depName)
2762 isLLndk := isLlndkLibrary(libName, ctx.Config())
2763 isVendorPublicLib := inList(libName, *vendorPublicLibraries)
2764 bothVendorAndCoreVariantsExist := ccDep.HasVendorVariant() || isLLndk
2765
2766 if c, ok := ccDep.(*Module); ok {
2767 // Use base module name for snapshots when exporting to Makefile.
2768 if c.isSnapshotPrebuilt() {
2769 baseName := c.BaseModuleName()
2770
2771 if c.IsVndk() {
2772 return baseName + ".vendor"
2773 }
2774
2775 if vendorSuffixModules[baseName] {
2776 return baseName + ".vendor"
2777 } else {
2778 return baseName
2779 }
2780 }
2781 }
2782
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002783 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
2784 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07002785 // The vendor module is a no-vendor-variant VNDK library. Depend on the
2786 // core module instead.
2787 return libName
2788 } else if c.UseVndk() && bothVendorAndCoreVariantsExist {
2789 // The vendor module in Make will have been renamed to not conflict with the core
2790 // module, so update the dependency name here accordingly.
2791 return libName + c.getNameSuffixWithVndkVersion(ctx)
2792 } else if (ctx.Platform() || ctx.ProductSpecific()) && isVendorPublicLib {
2793 return libName + vendorPublicLibrarySuffix
2794 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
2795 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002796 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
2797 return libName + vendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002798 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
2799 return libName + recoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05002800 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Colin Cross6e511a92020-07-27 21:26:48 -07002801 return libName + nativeBridgeSuffix
2802 } else {
2803 return libName
2804 }
2805}
2806
Colin Crossca860ac2016-01-04 14:34:37 -08002807func (c *Module) InstallInData() bool {
2808 if c.installer == nil {
2809 return false
2810 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002811 return c.installer.inData()
2812}
2813
2814func (c *Module) InstallInSanitizerDir() bool {
2815 if c.installer == nil {
2816 return false
2817 }
2818 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07002819 return true
2820 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07002821 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08002822}
2823
Yifan Hong1b3348d2020-01-21 15:53:22 -08002824func (c *Module) InstallInRamdisk() bool {
2825 return c.InRamdisk()
2826}
2827
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002828func (c *Module) InstallInVendorRamdisk() bool {
2829 return c.InVendorRamdisk()
2830}
2831
Jiyong Parkf9332f12018-02-01 00:54:12 +09002832func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07002833 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09002834}
2835
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002836func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002837 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002838 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002839 return
2840 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002841 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002842}
2843
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07002844func (c *Module) HostToolPath() android.OptionalPath {
2845 if c.installer == nil {
2846 return android.OptionalPath{}
2847 }
2848 return c.installer.hostToolPath()
2849}
2850
Nan Zhangd4e641b2017-07-12 12:55:28 -07002851func (c *Module) IntermPathForModuleOut() android.OptionalPath {
2852 return c.outputFile
2853}
2854
Colin Cross41955e82019-05-29 14:40:35 -07002855func (c *Module) OutputFiles(tag string) (android.Paths, error) {
2856 switch tag {
2857 case "":
2858 if c.outputFile.Valid() {
2859 return android.Paths{c.outputFile.Path()}, nil
2860 }
2861 return android.Paths{}, nil
2862 default:
2863 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002864 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07002865}
2866
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00002867func (c *Module) static() bool {
2868 if static, ok := c.linker.(interface {
2869 static() bool
2870 }); ok {
2871 return static.static()
2872 }
2873 return false
2874}
2875
Jiyong Park379de2f2018-12-19 02:47:14 +09002876func (c *Module) staticBinary() bool {
2877 if static, ok := c.linker.(interface {
2878 staticBinary() bool
2879 }); ok {
2880 return static.staticBinary()
2881 }
2882 return false
2883}
2884
Jiyong Park1d1119f2019-07-29 21:27:18 +09002885func (c *Module) header() bool {
2886 if h, ok := c.linker.(interface {
2887 header() bool
2888 }); ok {
2889 return h.header()
2890 }
2891 return false
2892}
2893
Inseob Kim7f283f42020-06-01 21:53:49 +09002894func (c *Module) binary() bool {
2895 if b, ok := c.linker.(interface {
2896 binary() bool
2897 }); ok {
2898 return b.binary()
2899 }
2900 return false
2901}
2902
Inseob Kim1042d292020-06-01 23:23:05 +09002903func (c *Module) object() bool {
2904 if o, ok := c.linker.(interface {
2905 object() bool
2906 }); ok {
2907 return o.object()
2908 }
2909 return false
2910}
2911
Ivan Lozanof9e21722020-12-02 09:00:51 -05002912func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07002913 if c.UseVndk() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05002914 if ccModule, ok := c.Module().(*Module); ok {
2915 // Only CC modules provide stubs at the moment.
2916 if lib, ok := ccModule.linker.(*llndkStubDecorator); ok {
2917 if Bool(lib.Properties.Vendor_available) {
2918 return "native:vndk"
2919 }
2920 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07002921 }
Colin Crossb60190a2018-09-04 16:28:17 -07002922 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05002923 if c.IsVndk() && !c.IsVndkExt() {
2924 if c.IsVndkPrivate(actx.Config()) {
2925 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09002926 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05002927 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09002928 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05002929 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09002930 return "native:product"
2931 }
Jooyung Han38002912019-05-16 04:01:54 +09002932 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08002933 } else if c.InRamdisk() {
2934 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002935 } else if c.InVendorRamdisk() {
2936 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07002937 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07002938 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05002939 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07002940 return "native:ndk:none:none"
2941 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
2942 //family, link := getNdkStlFamilyAndLinkType(c)
2943 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07002944 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08002945 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07002946 } else {
2947 return "native:platform"
2948 }
2949}
2950
Jiyong Park9d452992018-10-03 00:38:19 +09002951// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01002952// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09002953func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07002954 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09002955 // Stub libs and prebuilt libs in a versioned SDK are not
2956 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07002957 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01002958 } else if _, ok := c.linker.(testPerSrc); ok {
2959 return true
Jiyong Park9d452992018-10-03 00:38:19 +09002960 }
2961 return false
2962}
2963
Jiyong Parka90ca002019-10-07 15:47:24 +09002964func (c *Module) AvailableFor(what string) bool {
2965 if linker, ok := c.linker.(interface {
2966 availableFor(string) bool
2967 }); ok {
2968 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
2969 } else {
2970 return c.ApexModuleBase.AvailableFor(what)
2971 }
2972}
2973
Jiyong Park62304bb2020-04-13 16:19:48 +09002974func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09002975 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09002976}
2977
Colin Crossaede88c2020-08-11 12:17:01 -07002978func (c *Module) UniqueApexVariations() bool {
2979 if u, ok := c.compiler.(interface {
2980 uniqueApexVariations() bool
2981 }); ok {
2982 return u.uniqueApexVariations()
2983 } else {
2984 return false
2985 }
2986}
2987
Paul Duffin0cb37b92020-03-04 14:52:46 +00002988// Return true if the module is ever installable.
2989func (c *Module) EverInstallable() bool {
2990 return c.installer != nil &&
2991 // Check to see whether the module is actually ever installable.
2992 c.installer.everInstallable()
2993}
2994
Colin Cross56a83212020-09-15 18:30:11 -07002995func (c *Module) installable(apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00002996 ret := c.EverInstallable() &&
2997 // Check to see whether the module has been configured to not be installed.
2998 proptools.BoolDefault(c.Properties.Installable, true) &&
2999 !c.Properties.PreventInstall && c.outputFile.Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003000
3001 // The platform variant doesn't need further condition. Apex variants however might not
3002 // be installable because it will likely to be included in the APEX and won't appear
3003 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003004 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003005 return ret
3006 }
3007
3008 // Special case for modules that are configured to be installed to /data, which includes
3009 // test modules. For these modules, both APEX and non-APEX variants are considered as
3010 // installable. This is because even the APEX variants won't be included in the APEX, but
3011 // will anyway be installed to /data/*.
3012 // See b/146995717
3013 if c.InstallInData() {
3014 return ret
3015 }
3016
3017 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003018}
3019
Logan Chien41eabe62019-04-10 13:33:58 +08003020func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3021 if c.linker != nil {
3022 if library, ok := c.linker.(*libraryDecorator); ok {
3023 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3024 }
3025 }
3026}
3027
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003028func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003029 depTag := ctx.OtherModuleDependencyTag(dep)
3030 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3031
3032 if cc, ok := dep.(*Module); ok {
3033 if cc.HasStubsVariants() {
3034 if isLibDepTag && libDepTag.shared() {
3035 // dynamic dep to a stubs lib crosses APEX boundary
3036 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003037 }
Colin Cross6e511a92020-07-27 21:26:48 -07003038 if IsRuntimeDepTag(depTag) {
3039 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003040 return false
3041 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003042 }
Colin Crossaac32222020-07-29 12:51:56 -07003043 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003044 // shared_lib dependency from a static lib is considered as crossing
3045 // the APEX boundary because the dependency doesn't actually is
3046 // linked; the dependency is used only during the compilation phase.
3047 return false
3048 }
Jiyong Parke3867542020-12-03 17:28:25 +09003049
3050 if isLibDepTag && libDepTag.excludeInApex {
3051 return false
3052 }
Colin Cross6e511a92020-07-27 21:26:48 -07003053 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003054 if depTag == stubImplDepTag || depTag == llndkImplDep {
3055 // We don't track beyond LLNDK or from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003056 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003057 }
3058 return true
3059}
3060
Dan Albertc8060532020-07-22 22:32:17 -07003061func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3062 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003063 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3064 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3065 return nil
3066 }
3067 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3068 if c.ToolchainLibrary() {
3069 return nil
3070 }
3071 // We don't check for prebuilt modules
3072 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3073 return nil
3074 }
3075 minSdkVersion := c.MinSdkVersion()
3076 if minSdkVersion == "apex_inherit" {
3077 return nil
3078 }
3079 if minSdkVersion == "" {
3080 // JNI libs within APK-in-APEX fall into here
3081 // Those are okay to set sdk_version instead
3082 // We don't have to check if this is a SDK variant because
3083 // non-SDK variant resets sdk_version, which works too.
3084 minSdkVersion = c.SdkVersion()
3085 }
Dan Albertc8060532020-07-22 22:32:17 -07003086 if minSdkVersion == "" {
3087 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3088 }
3089 // Not using nativeApiLevelFromUser because the context here is not
3090 // necessarily a native context.
3091 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003092 if err != nil {
3093 return err
3094 }
Dan Albertc8060532020-07-22 22:32:17 -07003095
3096 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003097 return fmt.Errorf("newer SDK(%v)", ver)
3098 }
3099 return nil
3100}
3101
Colin Cross2ba19d92015-05-07 15:44:20 -07003102//
Colin Crosscfad1192015-11-02 16:43:11 -08003103// Defaults
3104//
Colin Crossca860ac2016-01-04 14:34:37 -08003105type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003106 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003107 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003108 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003109}
3110
Patrice Arrudac249c712019-03-19 17:00:29 -07003111// cc_defaults provides a set of properties that can be inherited by other cc
3112// modules. A module can use the properties from a cc_defaults using
3113// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3114// merged (when possible) by prepending the default module's values to the
3115// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003116func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003117 return DefaultsFactory()
3118}
3119
Colin Cross36242852017-06-23 15:06:31 -07003120func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003121 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003122
Colin Cross36242852017-06-23 15:06:31 -07003123 module.AddProperties(props...)
3124 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003125 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003126 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003127 &BaseCompilerProperties{},
3128 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003129 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003130 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003131 &StaticProperties{},
3132 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003133 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003134 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003135 &TestProperties{},
3136 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003137 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003138 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003139 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003140 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003141 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003142 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003143 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003144 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003145 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003146 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003147 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003148 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003149 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003150 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3151 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003152 )
Colin Crosscfad1192015-11-02 16:43:11 -08003153
Jooyung Hancc372c52019-09-25 15:18:44 +09003154 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003155
3156 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003157}
3158
Jiyong Park2286afd2020-06-16 21:58:53 +09003159func (c *Module) IsSdkVariant() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07003160 return c.Properties.IsSdkVariant || c.AlwaysSdk()
Jiyong Park2286afd2020-06-16 21:58:53 +09003161}
3162
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003163func kytheExtractAllFactory() android.Singleton {
3164 return &kytheExtractAllSingleton{}
3165}
3166
3167type kytheExtractAllSingleton struct {
3168}
3169
3170func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3171 var xrefTargets android.Paths
3172 ctx.VisitAllModules(func(module android.Module) {
3173 if ccModule, ok := module.(xref); ok {
3174 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3175 }
3176 })
3177 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3178 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003179 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003180 }
3181}
3182
Colin Cross06a931b2015-10-28 17:23:31 -07003183var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003184var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003185var BoolPtr = proptools.BoolPtr
3186var String = proptools.String
3187var StringPtr = proptools.StringPtr