blob: 0aa10145887f6289539c51ec331cb6ed52d5ee5b [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()
Colin Cross1e676be2016-10-12 14:38:15 -070053 })
Colin Cross16b23492016-01-06 14:41:07 -080054
Paul Duffin036e7002019-12-19 19:16:28 +000055 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Ivan Lozano3968d8f2020-12-14 11:27:52 -050056 ctx.TopDown("asan_deps", sanitizerDepsMutator(Asan))
57 ctx.BottomUp("asan", sanitizerMutator(Asan)).Parallel()
Colin Cross16b23492016-01-06 14:41:07 -080058
Tri Vo6eafc362021-04-01 11:29:09 -070059 ctx.TopDown("hwasan_deps", sanitizerDepsMutator(Hwasan))
60 ctx.BottomUp("hwasan", sanitizerMutator(Hwasan)).Parallel()
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070061
Ivan Lozano3968d8f2020-12-14 11:27:52 -050062 ctx.TopDown("fuzzer_deps", sanitizerDepsMutator(Fuzzer))
63 ctx.BottomUp("fuzzer", sanitizerMutator(Fuzzer)).Parallel()
Mitch Phillipsbfeade62019-05-01 14:42:05 -070064
Jiyong Park1d1119f2019-07-29 21:27:18 +090065 // cfi mutator shouldn't run before sanitizers that return true for
66 // incompatibleWithCfi()
Vishwath Mohanb743e9c2017-11-01 09:20:21 +000067 ctx.TopDown("cfi_deps", sanitizerDepsMutator(cfi))
68 ctx.BottomUp("cfi", sanitizerMutator(cfi)).Parallel()
69
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -080070 ctx.TopDown("scs_deps", sanitizerDepsMutator(scs))
71 ctx.BottomUp("scs", sanitizerMutator(scs)).Parallel()
72
Colin Cross1e676be2016-10-12 14:38:15 -070073 ctx.TopDown("tsan_deps", sanitizerDepsMutator(tsan))
74 ctx.BottomUp("tsan", sanitizerMutator(tsan)).Parallel()
Dan Willemsen581341d2017-02-09 16:16:31 -080075
Colin Cross0b908332019-06-19 23:00:20 -070076 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090077 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080078
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080079 ctx.BottomUp("coverage", coverageMutator).Parallel()
Stephen Craneba090d12017-05-09 15:44:35 -070080
81 ctx.TopDown("lto_deps", ltoDepsMutator)
82 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090083
Jooyung Han479ca172020-10-19 18:51:07 +090084 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090085 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070086 })
Colin Crossb98c8b02016-07-29 13:44:28 -070087
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080088 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
89 // sabi mutator needs to be run after apex mutator finishes.
90 ctx.TopDown("sabi_deps", sabiDepsMutator)
91 })
92
Colin Cross57898582020-10-29 18:25:19 -070093 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070094}
95
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050096// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
97// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
98// edges to these modules.
99// This object is constructed in DepsMutator, by calling to various module delegates to set
100// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
101// dependencies.
102// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
103// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800104type Deps struct {
105 SharedLibs, LateSharedLibs []string
106 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800107 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800108 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700109
Chris Parsons79d66a52020-06-05 17:26:16 -0400110 // Used for data dependencies adjacent to tests
111 DataLibs []string
112
Yo Chiang219968c2020-09-22 18:45:04 +0800113 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
114 SystemSharedLibs []string
115
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500116 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800117 StaticUnwinderIfLegacy bool
118
Colin Cross5950f382016-12-13 12:50:57 -0800119 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700120
Colin Cross81413472016-04-11 14:37:39 -0700121 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700122
Dan Willemsenb40aab62016-04-20 14:21:14 -0700123 GeneratedSources []string
124 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900125 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700126
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700127 ReexportGeneratedHeaders []string
128
Colin Crossc465efd2021-06-11 18:00:04 -0700129 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700130
131 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700132 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900133
134 // List of libs that need to be excluded for APEX variant
135 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700136}
137
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500138// PathDeps is a struct containing file paths to dependencies of a module.
139// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
140// It's used to construct flags for various build statements (such as for compiling and linking).
141// It is then passed to module decorator functions responsible for registering build statements
142// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800143type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700144 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900145 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700146 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900147 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700148 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700149 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700150
Colin Cross0de8a1e2020-09-18 14:15:30 -0700151 // Transitive static library dependencies of static libraries for use in ordering.
152 TranstiveStaticLibrariesForOrdering *android.DepSet
153
Colin Cross26c34ed2016-09-30 17:10:16 -0700154 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100155 Objs Objects
156 // Paths to .o files in dependencies that provide them. Note that these lists
157 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800158 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700159 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700160
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100161 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
162 // the libs from all whole_static_lib dependencies.
163 WholeStaticLibsFromPrebuilts android.Paths
164
Colin Cross26c34ed2016-09-30 17:10:16 -0700165 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700166 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900167 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700168
Inseob Kimd110f872019-12-06 13:15:38 +0900169 Flags []string
170 IncludeDirs android.Paths
171 SystemIncludeDirs android.Paths
172 ReexportedDirs android.Paths
173 ReexportedSystemDirs android.Paths
174 ReexportedFlags []string
175 ReexportedGeneratedHeaders android.Paths
176 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700177
Colin Cross26c34ed2016-09-30 17:10:16 -0700178 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700179 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700180
Dan Willemsena0790e32018-10-12 00:24:23 -0700181 // Path to the dynamic linker binary
182 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700183}
184
Colin Cross4af21ed2019-11-04 09:37:55 -0800185// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
186// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
187// command line so they can be overridden by the local module flags).
188type LocalOrGlobalFlags struct {
189 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700190 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800191 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700192 CFlags []string // Flags that apply to C and C++ source files
193 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
194 ConlyFlags []string // Flags that apply to C source files
195 CppFlags []string // Flags that apply to C++ source files
196 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700197 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800198}
199
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500200// Flags contains various types of command line flags (and settings) for use in building build
201// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800202type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500203 // Local flags (which individual modules are responsible for). These may override global flags.
204 Local LocalOrGlobalFlags
205 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800206 Global LocalOrGlobalFlags
207
208 aidlFlags []string // Flags that apply to aidl source files
209 rsFlags []string // Flags that apply to renderscript source files
210 libFlags []string // Flags to add libraries early to the link order
211 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
212 TidyFlags []string // Flags that apply to clang-tidy
213 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700214
Colin Crossc3199482017-03-30 15:03:04 -0700215 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800216 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700217 SystemIncludeFlags []string
218
Oliver Nguyen04526782020-04-21 12:40:27 -0700219 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500220 Tidy bool // True if clang-tidy is enabled.
221 GcovCoverage bool // True if coverage files should be generated.
222 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700223 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800224
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500225 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800226 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500227 // The target-device system path to the dynamic linker.
228 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800229
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700230 CFlagsDeps android.Paths // Files depended on by compiler flags
231 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800232
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500233 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700234 AssemblerWithCpp bool
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500235 // True if static libraries should be grouped (using `-Wl,--start-group` and `-Wl,--end-group`).
236 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800237
Colin Cross19878da2019-03-28 14:45:07 -0700238 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700239 protoC bool // Whether to use C instead of C++
240 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700241
242 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200243 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700244}
245
Colin Crossca860ac2016-01-04 14:34:37 -0800246// Properties used to compile all C or C++ modules
247type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700248 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800249 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700250
Jiyong Parkb35a8192020-08-10 15:59:36 +0900251 // The API level that this module is built against. The APIs of this API level will be
252 // visible at build time, but use of any APIs newer than min_sdk_version will render the
253 // module unloadable on older devices. In the future it will be possible to weakly-link new
254 // APIs, making the behavior match Java: such modules will load on older devices, but
255 // calling new APIs on devices that do not support them will result in a crash.
256 //
257 // This property has the same behavior as sdk_version does for Java modules. For those
258 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
259 // does for Java code.
260 //
261 // In addition, setting this property causes two variants to be built, one for the platform
262 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800263 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700264
Jiyong Parkb35a8192020-08-10 15:59:36 +0900265 // Minimum OS API level supported by this C or C++ module. This property becomes the value
266 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
267 // this property is also used to ensure that the min_sdk_version of the containing module is
268 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
269 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
270 // min_sdk_version of the containing APEX. When the module
271 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900272 Min_sdk_version *string
273
Colin Crossc511bc52020-04-07 16:50:32 +0000274 // If true, always create an sdk variant and don't create a platform variant.
275 Sdk_variant_only *bool
276
Jiyong Parkde866cb2018-12-07 23:08:36 +0900277 AndroidMkSharedLibs []string `blueprint:"mutated"`
278 AndroidMkStaticLibs []string `blueprint:"mutated"`
279 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
280 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700281 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900282 HideFromMake bool `blueprint:"mutated"`
283 PreventInstall bool `blueprint:"mutated"`
284 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700285
Yo Chiang219968c2020-09-22 18:45:04 +0800286 // Set by DepsMutator.
287 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
288
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200289 // The name of the image this module is built for, suffixed with a '.'
Justin Yun5f7f7e82019-11-18 19:52:14 +0900290 ImageVariationPrefix string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200291
292 // The VNDK version this module is built against. If empty, the module is not
293 // build against the VNDK.
294 VndkVersion string `blueprint:"mutated"`
295
296 // Suffix for the name of Android.mk entries generated by this module
297 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800298
299 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
300 // file
301 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900302
Yifan Hong39143a92020-10-26 12:43:12 -0700303 // Make this module available when building for ramdisk.
304 // On device without a dedicated recovery partition, the module is only
305 // available after switching root into
306 // /first_stage_ramdisk. To expose the module before switching root, install
307 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800308 Ramdisk_available *bool
309
Yifan Hong39143a92020-10-26 12:43:12 -0700310 // Make this module available when building for vendor ramdisk.
311 // On device without a dedicated recovery partition, the module is only
312 // available after switching root into
313 // /first_stage_ramdisk. To expose the module before switching root, install
314 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700315 Vendor_ramdisk_available *bool
316
Jiyong Parkf9332f12018-02-01 00:54:12 +0900317 // Make this module available when building for recovery
318 Recovery_available *bool
319
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200320 // Used by imageMutator, set by ImageMutatorBegin()
321 CoreVariantNeeded bool `blueprint:"mutated"`
322 RamdiskVariantNeeded bool `blueprint:"mutated"`
323 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
324 RecoveryVariantNeeded bool `blueprint:"mutated"`
325
326 // A list of variations for the "image" mutator of the form
327 //<image name> '.' <version char>, for example, 'vendor.S'
328 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900329
330 // Allows this module to use non-APEX version of libraries. Useful
331 // for building binaries that are started before APEXes are activated.
332 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900333
334 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
335 // see soong/cc/config/vndk.go
336 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900337
338 // Used by vendor snapshot to record dependencies from snapshot modules.
339 SnapshotSharedLibs []string `blueprint:"mutated"`
340 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000341
342 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000343
344 // Set by factories of module types that can only be referenced from variants compiled against
345 // the SDK.
346 AlwaysSdk bool `blueprint:"mutated"`
347
348 // Variant is an SDK variant created by sdkMutator
349 IsSdkVariant bool `blueprint:"mutated"`
350 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
351 // variant to have a ".sdk" suffix.
352 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700353
354 // Normally Soong uses the directory structure to decide which modules
355 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800356 // different snapshots (vendor, recovery, etc.), but this property
357 // allows a partner to exclude a module normally thought of as a
358 // framework module from the vendor snapshot.
359 Exclude_from_vendor_snapshot *bool
360
361 // Normally Soong uses the directory structure to decide which modules
362 // should be included (framework) or excluded (non-framework) from the
363 // different snapshots (vendor, recovery, etc.), but this property
364 // allows a partner to exclude a module normally thought of as a
365 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800366 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900367
368 // List of APEXes that this module has private access to for testing purpose. The module
369 // can depend on libraries that are not exported by the APEXes and use private symbols
370 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000371 Test_for []string `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700372}
373
374type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900375 // whether this module should be allowed to be directly depended by other
376 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900377 // If set to true, two variants will be built separately, one like
378 // normal, and the other limited to the set of libraries and headers
379 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700380 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900381 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700382 // so it shouldn't have any unversioned runtime dependencies, or
383 // make assumptions about the system that may not be true in the
384 // future.
385 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900386 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900387 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900388 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900389 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900390 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700391 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
392 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900393
Justin Yunebcf0c52021-01-08 18:00:19 +0900394 // This is the same as the "vendor_available" except that the install path
395 // of the vendor variant is /odm or /vendor/odm.
396 // By replacing "vendor_available: true" with "odm_available: true", the
397 // module will install its vendor variant to the /odm partition or /vendor/odm.
398 // As the modules with "odm_available: true" still create the vendor variants,
399 // they can link to the other vendor modules as the vendor_available modules do.
400 // Also, the vendor modules can link to odm_available modules.
401 //
402 // It may not be used for VNDK modules.
403 Odm_available *bool
404
Justin Yun63e9ec72020-10-29 16:49:43 +0900405 // whether this module should be allowed to be directly depended by other
406 // modules with `product_specific: true` or `product_available: true`.
407 // If set to true, an additional product variant will be built separately
408 // that is limited to the set of libraries and headers that are exposed to
409 // /product modules.
410 //
411 // The product variant may be used with a different (newer) /system,
412 // so it shouldn't have any unversioned runtime dependencies, or
413 // make assumptions about the system that may not be true in the
414 // future.
415 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900416 // If set to false, this module becomes inaccessible from /product modules.
417 //
418 // Different from the 'vendor_available' property, the modules with
419 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
420 // library without 'product_available' may not be depended on by any other
421 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900422 //
423 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
424 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
425 Product_available *bool
426
Jiyong Park5fb8c102018-04-09 12:03:06 +0900427 // whether this module is capable of being loaded with other instance
428 // (possibly an older version) of the same module in the same process.
429 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
430 // can be double loaded in a vendor process if the library is also a
431 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
432 // explicitly marked as `double_loadable: true` by the owner, or the dependency
433 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
434 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800435
436 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
437 IsLLNDK bool `blueprint:"mutated"`
438
Colin Cross78212242021-01-06 14:51:30 -0800439 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
440 // set and the module is not listed in VndkMustUseVendorVariantList.
441 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
442
443 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
444 IsVNDKCore bool `blueprint:"mutated"`
445
446 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
447 IsVNDKSP bool `blueprint:"mutated"`
448
449 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
450 // module sets the llndk.private property.
451 IsVNDKPrivate bool `blueprint:"mutated"`
452
453 // IsVNDKProduct is set if a VNDK module sets the product_available property.
454 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700455
456 // IsVendorPublicLibrary is set for the core and product variants of a library that has
457 // vendor_public_library stubs.
458 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800459}
460
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500461// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
462// to understanding details about the type of the current module.
463// For example, one might call these functions to determine whether the current module is a static
464// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800465type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800466 static() bool
467 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700468 testBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900469 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900470 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900471 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700472 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900473 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700474 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800475 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900476 minSdkVersion() string
477 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700478 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700479 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800480 IsLlndk() bool
481 IsLlndkPublic() bool
482 isImplementationForLLNDKPublic() bool
483 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900484 isVndk() bool
485 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500486 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700487 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900488 inProduct() bool
489 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800490 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700491 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900492 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700493 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700494 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800495 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800496 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800497 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800498 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800499 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700500 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700501 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900502 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800503 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700504 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700505 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800506 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800507 isCfiAssemblySupportEnabled() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800508}
509
510type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700511 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800512 ModuleContextIntf
513}
514
515type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700516 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800517 ModuleContextIntf
518}
519
Colin Cross37047f12016-12-13 17:06:13 -0800520type DepsContext interface {
521 android.BottomUpMutatorContext
522 ModuleContextIntf
523}
524
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500525// feature represents additional (optional) steps to building cc-related modules, such as invocation
526// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800527type feature interface {
528 begin(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800529 deps(ctx DepsContext, deps Deps) Deps
Colin Crossca860ac2016-01-04 14:34:37 -0800530 flags(ctx ModuleContext, flags Flags) Flags
531 props() []interface{}
532}
533
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500534// compiler is the interface for a compiler helper object. Different module decorators may implement
535// this helper differently. For example, compiling a `cc_library` may use a different build
536// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800537type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700538 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800539 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800540 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700541 compilerProps() []interface{}
542
Colin Cross76fada02016-07-27 10:31:13 -0700543 appendCflags([]string)
544 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700545 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800546}
547
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500548// linker is the interface for a linker decorator object. Individual module types can provide
549// their own implementation for this decorator, and thus specify custom logic regarding build
550// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800551type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700552 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800553 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700554 linkerFlags(ctx ModuleContext, flags Flags) Flags
555 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800556 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700557
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700558 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700559 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900560 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700561
562 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900563 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000564
565 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000566 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
567}
568
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500569// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000570type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500571 sharedLibs []string
572 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
573 // libc, libm, etc.)
Colin Cross9ecb42d2021-06-22 13:20:01 -0700574 systemSharedLibs []string
575 defaultSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800576}
577
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500578// installer is the interface for an installer helper object. This helper is responsible for
579// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800580type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700581 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700582 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000583 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800584 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700585 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700586 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900587 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100588 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900589 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800590}
591
Chris Parsons8d6e4332021-02-22 16:13:50 -0500592// bazelHandler is the interface for a helper object related to deferring to Bazel for
593// processing a module (during Bazel mixed builds). Individual module types should define
594// their own bazel handler if they support deferring to Bazel.
595type bazelHandler interface {
596 // Issue query to Bazel to retrieve information about Bazel's view of the current module.
597 // If Bazel returns this information, set module properties on the current module to reflect
598 // the returned information.
599 // Returns true if information was available from Bazel, false if bazel invocation still needs to occur.
600 generateBazelBuildActions(ctx android.ModuleContext, label string) bool
601}
602
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800603type xref interface {
604 XrefCcFiles() android.Paths
605}
606
Colin Cross6e511a92020-07-27 21:26:48 -0700607type libraryDependencyKind int
608
609const (
610 headerLibraryDependency = iota
611 sharedLibraryDependency
612 staticLibraryDependency
613)
614
615func (k libraryDependencyKind) String() string {
616 switch k {
617 case headerLibraryDependency:
618 return "headerLibraryDependency"
619 case sharedLibraryDependency:
620 return "sharedLibraryDependency"
621 case staticLibraryDependency:
622 return "staticLibraryDependency"
623 default:
624 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
625 }
626}
627
628type libraryDependencyOrder int
629
630const (
631 earlyLibraryDependency = -1
632 normalLibraryDependency = 0
633 lateLibraryDependency = 1
634)
635
636func (o libraryDependencyOrder) String() string {
637 switch o {
638 case earlyLibraryDependency:
639 return "earlyLibraryDependency"
640 case normalLibraryDependency:
641 return "normalLibraryDependency"
642 case lateLibraryDependency:
643 return "lateLibraryDependency"
644 default:
645 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
646 }
647}
648
649// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
650// tags that have a set of predefined tag objects that are reused for each dependency, a
651// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
652// That means that comparing a libraryDependencyTag for equality will only be equal if all
653// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
654// then check individual metadata fields instead.
655type libraryDependencyTag struct {
656 blueprint.BaseDependencyTag
657
658 // These are exported so that fmt.Printf("%#v") can call their String methods.
659 Kind libraryDependencyKind
660 Order libraryDependencyOrder
661
662 wholeStatic bool
663
664 reexportFlags bool
665 explicitlyVersioned bool
666 dataLib bool
667 ndk bool
668
669 staticUnwinder bool
670
671 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900672
Cindy Zhou18417cb2020-12-10 07:12:38 -0800673 // Whether or not this dependency should skip the apex dependency check
674 skipApexAllowedDependenciesCheck bool
675
Jiyong Parke3867542020-12-03 17:28:25 +0900676 // Whether or not this dependency has to be followed for the apex variants
677 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700678}
679
680// header returns true if the libraryDependencyTag is tagging a header lib dependency.
681func (d libraryDependencyTag) header() bool {
682 return d.Kind == headerLibraryDependency
683}
684
685// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
686func (d libraryDependencyTag) shared() bool {
687 return d.Kind == sharedLibraryDependency
688}
689
690// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
691func (d libraryDependencyTag) static() bool {
692 return d.Kind == staticLibraryDependency
693}
694
Colin Crosse9fe2942020-11-10 18:12:15 -0800695// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
696// binaries or other shared libraries are installed as dependencies.
697func (d libraryDependencyTag) InstallDepNeeded() bool {
698 return d.shared()
699}
700
701var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
702
703// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700704// libraryDependencyTag. Each tag object is created globally and reused for multiple
705// dependencies (although since the object contains no references, assigning a tag to a
706// variable and modifying it will not modify the original). Users can compare the tag
707// returned by ctx.OtherModuleDependencyTag against the global original
708type dependencyTag struct {
709 blueprint.BaseDependencyTag
710 name string
711}
712
Colin Crosse9fe2942020-11-10 18:12:15 -0800713// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
714// libraryDependencyTag, but where the dependency needs to be installed when the parent is
715// installed.
716type installDependencyTag struct {
717 blueprint.BaseDependencyTag
718 android.InstallAlwaysNeededDependencyTag
719 name string
720}
721
Colin Crossc99deeb2016-04-11 15:06:20 -0700722var (
Colin Cross6e511a92020-07-27 21:26:48 -0700723 genSourceDepTag = dependencyTag{name: "gen source"}
724 genHeaderDepTag = dependencyTag{name: "gen header"}
725 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
726 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900727 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700728 reuseObjTag = dependencyTag{name: "reuse objects"}
729 staticVariantTag = dependencyTag{name: "static variant"}
730 vndkExtDepTag = dependencyTag{name: "vndk extends"}
731 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800732 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700733 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700734 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700735)
736
Roland Levillainf89cd092019-07-29 16:22:59 +0100737func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700738 ccLibDepTag, ok := depTag.(libraryDependencyTag)
739 return ok && ccLibDepTag.shared()
740}
741
742func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
743 ccLibDepTag, ok := depTag.(libraryDependencyTag)
744 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100745}
746
Zach Johnson3df4e632020-11-06 11:56:27 -0800747func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
748 ccLibDepTag, ok := depTag.(libraryDependencyTag)
749 return ok && ccLibDepTag.header()
750}
751
Roland Levillainf89cd092019-07-29 16:22:59 +0100752func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800753 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100754}
755
756func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700757 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100758 return ok && ccDepTag == testPerSrcDepTag
759}
760
Colin Crossca860ac2016-01-04 14:34:37 -0800761// Module contains the properties and members used by all C/C++ module types, and implements
762// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500763// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
764// interface.
765//
766// To define a C/C++ related module, construct a new Module object and point its delegates to
767// type-specific structs. These delegates will be invoked to register module-specific build
768// statements which may be unique to the module type. For example, module.compiler.compile() should
769// be defined so as to register build statements which are responsible for compiling the module.
770//
771// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
772// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
773// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
774// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800775type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700776 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700777 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900778 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900779 android.SdkBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500780 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700781
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700782 Properties BaseProperties
783 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700784
Colin Crossca860ac2016-01-04 14:34:37 -0800785 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700786 hod android.HostOrDeviceSupported
787 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700788
Paul Duffina0843f62019-12-13 19:50:38 +0000789 // Allowable SdkMemberTypes of this module type.
790 sdkMemberTypes []android.SdkMemberType
791
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500792 // decorator delegates, initialize before calling Init
793 // these may contain module-specific implementations, and effectively allow for custom
794 // type-specific logic. These members may reference different objects or the same object.
795 // Functions of these decorators will be invoked to initialize and register type-specific
796 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500797 compiler compiler
798 linker linker
799 installer installer
800 bazelHandler bazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500801
802 features []feature
803 stl *stl
804 sanitize *sanitize
805 coverage *coverage
806 sabi *sabi
807 vndkdep *vndkdep
808 lto *lto
809 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800810
Colin Cross31076b32020-10-23 17:22:06 -0700811 library libraryInterface
812
Colin Cross635c3b02016-05-18 15:37:25 -0700813 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800814
Colin Crossb98c8b02016-07-29 13:44:28 -0700815 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700816
817 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800818
819 // Flags used to compile this module
820 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700821
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800822 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700823 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900824
825 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800826 // Kythe (source file indexer) paths for this compilation module
827 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900828
829 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700830 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700831
832 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700833}
834
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200835func (c *Module) AddJSONData(d *map[string]interface{}) {
836 c.AndroidModuleBase().AddJSONData(d)
837 (*d)["Cc"] = map[string]interface{}{
838 "SdkVersion": c.SdkVersion(),
839 "MinSdkVersion": c.MinSdkVersion(),
840 "VndkVersion": c.VndkVersion(),
841 "ProductSpecific": c.ProductSpecific(),
842 "SocSpecific": c.SocSpecific(),
843 "DeviceSpecific": c.DeviceSpecific(),
844 "InProduct": c.InProduct(),
845 "InVendor": c.InVendor(),
846 "InRamdisk": c.InRamdisk(),
847 "InVendorRamdisk": c.InVendorRamdisk(),
848 "InRecovery": c.InRecovery(),
849 "VendorAvailable": c.VendorAvailable(),
850 "ProductAvailable": c.ProductAvailable(),
851 "RamdiskAvailable": c.RamdiskAvailable(),
852 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
853 "RecoveryAvailable": c.RecoveryAvailable(),
854 "OdmAvailable": c.OdmAvailable(),
855 "InstallInData": c.InstallInData(),
856 "InstallInRamdisk": c.InstallInRamdisk(),
857 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
858 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
859 "InstallInRecovery": c.InstallInRecovery(),
860 "InstallInRoot": c.InstallInRoot(),
861 "IsVndk": c.IsVndk(),
862 "IsVndkExt": c.IsVndkExt(),
863 "IsVndkPrivate": c.IsVndkPrivate(),
864 "IsVndkSp": c.IsVndkSp(),
865 "IsLlndk": c.IsLlndk(),
866 "IsLlndkPublic": c.IsLlndkPublic(),
867 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
868 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
869 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
870 "ApexSdkVersion": c.apexSdkVersion,
871 "TestFor": c.TestFor(),
872 }
873}
874
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500875func (c *Module) SetPreventInstall() {
876 c.Properties.PreventInstall = true
877}
878
879func (c *Module) SetHideFromMake() {
880 c.Properties.HideFromMake = true
881}
882
Ivan Lozanod7586b62021-04-01 09:49:36 -0400883func (c *Module) HiddenFromMake() bool {
884 return c.Properties.HideFromMake
885}
886
Ivan Lozano52767be2019-10-18 14:49:46 -0700887func (c *Module) Toc() android.OptionalPath {
888 if c.linker != nil {
889 if library, ok := c.linker.(libraryInterface); ok {
890 return library.toc()
891 }
892 }
893 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
894}
895
896func (c *Module) ApiLevel() string {
897 if c.linker != nil {
898 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700899 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700900 }
901 }
902 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
903}
904
905func (c *Module) Static() bool {
906 if c.linker != nil {
907 if library, ok := c.linker.(libraryInterface); ok {
908 return library.static()
909 }
910 }
911 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
912}
913
914func (c *Module) Shared() bool {
915 if c.linker != nil {
916 if library, ok := c.linker.(libraryInterface); ok {
917 return library.shared()
918 }
919 }
920 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
921}
922
923func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000924 if c.stl != nil {
925 return c.stl.Properties.SelectedStl
926 }
927 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700928}
929
930func (c *Module) ToolchainLibrary() bool {
931 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
932 return true
933 }
934 return false
935}
936
937func (c *Module) NdkPrebuiltStl() bool {
938 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
939 return true
940 }
941 return false
942}
943
944func (c *Module) StubDecorator() bool {
945 if _, ok := c.linker.(*stubDecorator); ok {
946 return true
947 }
948 return false
949}
950
951func (c *Module) SdkVersion() string {
952 return String(c.Properties.Sdk_version)
953}
954
Artur Satayev480e25b2020-04-27 18:53:18 +0100955func (c *Module) MinSdkVersion() string {
956 return String(c.Properties.Min_sdk_version)
957}
958
Dan Albert92fe7402020-07-15 13:33:30 -0700959func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700960 if !c.canUseSdk() {
961 return false
962 }
Dan Albert92fe7402020-07-15 13:33:30 -0700963 if linker, ok := c.linker.(*objectLinker); ok {
964 return linker.isCrt()
965 }
966 return false
967}
968
Colin Crossc511bc52020-04-07 16:50:32 +0000969func (c *Module) AlwaysSdk() bool {
970 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
971}
972
Ivan Lozano183a3212019-10-18 14:18:45 -0700973func (c *Module) CcLibrary() bool {
974 if c.linker != nil {
975 if _, ok := c.linker.(*libraryDecorator); ok {
976 return true
977 }
Colin Crossd48fe732020-09-23 20:37:24 -0700978 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
979 return true
980 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700981 }
982 return false
983}
984
985func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700986 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700987 return true
988 }
989 return false
990}
991
Ivan Lozano2b262972019-11-21 12:30:50 -0800992func (c *Module) NonCcVariants() bool {
993 return false
994}
995
Ivan Lozano183a3212019-10-18 14:18:45 -0700996func (c *Module) SetStatic() {
997 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700998 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700999 library.setStatic()
1000 return
1001 }
1002 }
1003 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1004}
1005
1006func (c *Module) SetShared() {
1007 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001008 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001009 library.setShared()
1010 return
1011 }
1012 }
1013 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1014}
1015
1016func (c *Module) BuildStaticVariant() bool {
1017 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001018 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001019 return library.buildStatic()
1020 }
1021 }
1022 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1023}
1024
1025func (c *Module) BuildSharedVariant() bool {
1026 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001027 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001028 return library.buildShared()
1029 }
1030 }
1031 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1032}
1033
1034func (c *Module) Module() android.Module {
1035 return c
1036}
1037
Jiyong Parkc20eee32018-09-05 22:36:17 +09001038func (c *Module) OutputFile() android.OptionalPath {
1039 return c.outputFile
1040}
1041
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001042func (c *Module) CoverageFiles() android.Paths {
1043 if c.linker != nil {
1044 if library, ok := c.linker.(libraryInterface); ok {
1045 return library.objs().coverageFiles
1046 }
1047 }
1048 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1049}
1050
Ivan Lozano183a3212019-10-18 14:18:45 -07001051var _ LinkableInterface = (*Module)(nil)
1052
Jiyong Park719b4462019-01-13 00:39:51 +09001053func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001054 if c.linker != nil {
1055 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001056 }
1057 return nil
1058}
1059
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001060func (c *Module) CoverageOutputFile() android.OptionalPath {
1061 if c.linker != nil {
1062 return c.linker.coverageOutputFilePath()
1063 }
1064 return android.OptionalPath{}
1065}
1066
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001067func (c *Module) RelativeInstallPath() string {
1068 if c.installer != nil {
1069 return c.installer.relativeInstallPath()
1070 }
1071 return ""
1072}
1073
Jooyung Han344d5432019-08-23 11:17:39 +09001074func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001075 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001076}
1077
Colin Cross36242852017-06-23 15:06:31 -07001078func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001079 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001080 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001081 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001082 }
1083 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001084 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001085 }
1086 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001087 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001088 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001089 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001090 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001091 }
Colin Cross16b23492016-01-06 14:41:07 -08001092 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001093 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001094 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001095 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001096 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001097 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001098 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001099 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001100 }
Justin Yun8effde42017-06-23 19:24:43 +09001101 if c.vndkdep != nil {
1102 c.AddProperties(c.vndkdep.props()...)
1103 }
Stephen Craneba090d12017-05-09 15:44:35 -07001104 if c.lto != nil {
1105 c.AddProperties(c.lto.props()...)
1106 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001107 if c.pgo != nil {
1108 c.AddProperties(c.pgo.props()...)
1109 }
Colin Crossca860ac2016-01-04 14:34:37 -08001110 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001111 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001112 }
Colin Crossc472d572015-03-17 15:06:21 -07001113
Colin Cross36242852017-06-23 15:06:31 -07001114 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerea6666f2021-02-17 10:17:28 -05001115 android.InitBazelModule(c)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001116 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001117 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001118 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001119
Colin Cross36242852017-06-23 15:06:31 -07001120 return c
Colin Crossc472d572015-03-17 15:06:21 -07001121}
1122
Colin Crossb916a382016-07-29 17:28:03 -07001123// Returns true for dependency roots (binaries)
1124// TODO(ccross): also handle dlopenable libraries
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001125func (c *Module) IsDependencyRoot() bool {
Colin Crossb916a382016-07-29 17:28:03 -07001126 if root, ok := c.linker.(interface {
1127 isDependencyRoot() bool
1128 }); ok {
1129 return root.isDependencyRoot()
1130 }
1131 return false
1132}
1133
Ivan Lozano52767be2019-10-18 14:49:46 -07001134func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001135 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001136}
1137
Colin Crossc511bc52020-04-07 16:50:32 +00001138func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001139 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1140 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001141}
1142
1143func (c *Module) UseSdk() bool {
1144 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001145 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001146 }
1147 return false
1148}
1149
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001150func (c *Module) isCoverageVariant() bool {
1151 return c.coverage.Properties.IsCoverageVariant
1152}
1153
Colin Cross95f1ca02020-10-29 20:47:22 -07001154func (c *Module) IsNdk(config android.Config) bool {
1155 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001156}
1157
Colin Cross127bb8b2020-12-16 16:46:01 -08001158func (c *Module) IsLlndk() bool {
1159 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001160}
1161
Colin Cross127bb8b2020-12-16 16:46:01 -08001162func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001163 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001164}
1165
Colin Cross1f3f1302021-04-26 18:37:44 -07001166func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001167 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001168 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001169}
1170
Colin Cross5271fea2021-04-27 13:06:04 -07001171func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1172 lib := moduleLibraryInterface(m)
1173 return lib != nil && (lib.hasVendorPublicLibrary())
1174}
1175
1176// IsVendorPublicLibrary returns true for vendor public libraries.
1177func (c *Module) IsVendorPublicLibrary() bool {
1178 return c.VendorProperties.IsVendorPublicLibrary
1179}
1180
Ivan Lozanod7586b62021-04-01 09:49:36 -04001181func (c *Module) HasLlndkStubs() bool {
1182 lib := moduleLibraryInterface(c)
1183 return lib != nil && lib.hasLLNDKStubs()
1184}
1185
1186func (c *Module) StubsVersion() string {
1187 if lib, ok := c.linker.(versionedInterface); ok {
1188 return lib.stubsVersion()
1189 }
1190 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1191}
1192
Colin Cross127bb8b2020-12-16 16:46:01 -08001193// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1194// and does not set llndk.vendor_available: false.
1195func (c *Module) isImplementationForLLNDKPublic() bool {
1196 library, _ := c.library.(*libraryDecorator)
1197 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001198 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001199}
1200
Justin Yunfd9e8042020-12-23 18:23:14 +09001201// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001202func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001203 // Check if VNDK-core-private or VNDK-SP-private
1204 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001205 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001206 }
1207
1208 // Check if LLNDK-private
1209 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001210 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001211 }
1212
1213 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001214}
1215
Ivan Lozano52767be2019-10-18 14:49:46 -07001216func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001217 if vndkdep := c.vndkdep; vndkdep != nil {
1218 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001219 }
1220 return false
1221}
1222
Yi Kong7e53c572018-02-14 18:16:12 +08001223func (c *Module) isPgoCompile() bool {
1224 if pgo := c.pgo; pgo != nil {
1225 return pgo.Properties.PgoCompile
1226 }
1227 return false
1228}
1229
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001230func (c *Module) isNDKStubLibrary() bool {
1231 if _, ok := c.compiler.(*stubDecorator); ok {
1232 return true
1233 }
1234 return false
1235}
1236
Ivan Lozanod7586b62021-04-01 09:49:36 -04001237func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001238 if vndkdep := c.vndkdep; vndkdep != nil {
1239 return vndkdep.isVndkSp()
1240 }
1241 return false
1242}
1243
Ivan Lozanof9e21722020-12-02 09:00:51 -05001244func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001245 if vndkdep := c.vndkdep; vndkdep != nil {
1246 return vndkdep.isVndkExt()
1247 }
1248 return false
1249}
1250
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001251func (c *Module) SubName() string {
1252 return c.Properties.SubName
1253}
1254
Ivan Lozano52767be2019-10-18 14:49:46 -07001255func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001256 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001257}
1258
Logan Chienf3511742017-10-31 18:04:35 +08001259func (c *Module) getVndkExtendsModuleName() string {
1260 if vndkdep := c.vndkdep; vndkdep != nil {
1261 return vndkdep.getVndkExtendsModuleName()
1262 }
1263 return ""
1264}
1265
Jiyong Park25fc6a92018-11-18 18:02:45 +09001266func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001267 if lib := c.library; lib != nil {
1268 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001269 }
1270 return false
1271}
1272
1273func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001274 if lib := c.library; lib != nil {
1275 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001276 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001277 return false
1278}
1279
Colin Cross0477b422020-10-13 18:43:54 -07001280// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1281// the implementation. If it is an implementation library it returns its own name.
1282func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1283 name := ctx.OtherModuleName(c)
1284 if versioned, ok := c.linker.(versionedInterface); ok {
1285 name = versioned.implementationModuleName(name)
1286 }
1287 return name
1288}
1289
Martin Stjernholm2856c662020-12-02 15:03:42 +00001290// Similar to ImplementationModuleName, but uses the Make variant of the module
1291// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1292// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1293// under the premise that the prebuilt module overrides its source counterpart
1294// if it is exposed to Make).
1295func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1296 name := c.BaseModuleName()
1297 if versioned, ok := c.linker.(versionedInterface); ok {
1298 name = versioned.implementationModuleName(name)
1299 }
1300 return name
1301}
1302
Jiyong Park7d55b612021-06-11 17:22:09 +09001303func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001304 return Bool(c.Properties.Bootstrap)
1305}
1306
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001307func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001308 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1309 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1310 return false
1311 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001312 return c.linker != nil && c.linker.nativeCoverage()
1313}
1314
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001315func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001316 if p, ok := c.linker.(SnapshotInterface); ok {
1317 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001318 }
1319 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001320}
1321
Bill Peckham945441c2020-08-31 16:07:58 -07001322func (c *Module) ExcludeFromVendorSnapshot() bool {
1323 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1324}
1325
Jose Galmesf7294582020-11-13 12:07:36 -08001326func (c *Module) ExcludeFromRecoverySnapshot() bool {
1327 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1328}
1329
Jiyong Parkf1194352019-02-25 11:05:47 +09001330func isBionic(name string) bool {
1331 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001332 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001333 return true
1334 }
1335 return false
1336}
1337
Martin Stjernholm279de572019-09-10 23:18:20 +01001338func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001339 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001340 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001341 }
1342 return isBionic(name)
1343}
1344
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001345func (c *Module) XrefCcFiles() android.Paths {
1346 return c.kytheFiles
1347}
1348
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001349func (c *Module) isCfiAssemblySupportEnabled() bool {
1350 return c.sanitize != nil &&
1351 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1352}
1353
Inseob Kim800d1142021-06-14 12:03:51 +09001354func (c *Module) InstallInRoot() bool {
1355 return c.installer != nil && c.installer.installInRoot()
1356}
1357
Colin Crossca860ac2016-01-04 14:34:37 -08001358type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001359 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001360 moduleContextImpl
1361}
1362
Colin Cross37047f12016-12-13 17:06:13 -08001363type depsContext struct {
1364 android.BottomUpMutatorContext
1365 moduleContextImpl
1366}
1367
Colin Crossca860ac2016-01-04 14:34:37 -08001368type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001369 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001370 moduleContextImpl
1371}
1372
1373type moduleContextImpl struct {
1374 mod *Module
1375 ctx BaseModuleContext
1376}
1377
Colin Crossb98c8b02016-07-29 13:44:28 -07001378func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001379 return ctx.mod.toolchain(ctx.ctx)
1380}
1381
1382func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001383 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001384}
1385
1386func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001387 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001388}
1389
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001390func (ctx *moduleContextImpl) testBinary() bool {
1391 return ctx.mod.testBinary()
1392}
1393
Jiyong Park1d1119f2019-07-29 21:27:18 +09001394func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001395 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001396}
1397
Inseob Kim7f283f42020-06-01 21:53:49 +09001398func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001399 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001400}
1401
Inseob Kim1042d292020-06-01 23:23:05 +09001402func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001403 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001404}
1405
Jooyung Hanccce2f22020-03-07 03:45:53 +09001406func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001407 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001408}
1409
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001410func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001411 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001412}
1413
1414func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001415 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001416 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001417 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001418 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001419 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001420 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001421 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001422 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001423 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001424 }
1425 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001426}
1427
Jiyong Parkb35a8192020-08-10 15:59:36 +09001428func (ctx *moduleContextImpl) minSdkVersion() string {
1429 ver := ctx.mod.MinSdkVersion()
1430 if ver == "apex_inherit" && !ctx.isForPlatform() {
1431 ver = ctx.apexSdkVersion().String()
1432 }
1433 if ver == "apex_inherit" || ver == "" {
1434 ver = ctx.sdkVersion()
1435 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001436 // For crt objects, the meaning of min_sdk_version is very different from other types of
1437 // module. For them, min_sdk_version defines the oldest version that the build system will
1438 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1439 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1440 // and min_sdk_version properties of the variants are set to the corresponding version
1441 // numbers. However, the platform (non-sdk) variant of the crt object is left untouched.
1442 // min_sdk_version: 16 doesn't actually mean that the platform variant has to support such
1443 // an old version. Since the variant is for the platform, it's preferred to target the
1444 // latest version.
1445 if ctx.mod.SplitPerApiLevel() && !ctx.isSdkVariant() {
1446 ver = strconv.Itoa(android.FutureApiLevelInt)
1447 }
1448
Jiyong Parkb35a8192020-08-10 15:59:36 +09001449 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1450 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1451 minSdkVersionInt, err2 := strconv.Atoi(ver)
1452 if err == nil && err2 == nil {
1453 if sdkVersionInt < minSdkVersionInt {
1454 return strconv.Itoa(sdkVersionInt)
1455 }
1456 }
1457 return ver
1458}
1459
1460func (ctx *moduleContextImpl) isSdkVariant() bool {
1461 return ctx.mod.IsSdkVariant()
1462}
1463
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001464func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001465 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001466}
Justin Yun8effde42017-06-23 19:24:43 +09001467
Colin Cross95f1ca02020-10-29 20:47:22 -07001468func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1469 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001470}
1471
Colin Cross127bb8b2020-12-16 16:46:01 -08001472func (ctx *moduleContextImpl) IsLlndk() bool {
1473 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001474}
1475
Colin Cross127bb8b2020-12-16 16:46:01 -08001476func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1477 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001478}
1479
Colin Cross127bb8b2020-12-16 16:46:01 -08001480func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1481 return ctx.mod.isImplementationForLLNDKPublic()
1482}
1483
1484func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1485 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001486}
1487
Logan Chienf3511742017-10-31 18:04:35 +08001488func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001489 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001490}
1491
Yi Kong7e53c572018-02-14 18:16:12 +08001492func (ctx *moduleContextImpl) isPgoCompile() bool {
1493 return ctx.mod.isPgoCompile()
1494}
1495
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001496func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1497 return ctx.mod.isNDKStubLibrary()
1498}
1499
Justin Yun8effde42017-06-23 19:24:43 +09001500func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001501 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001502}
1503
Ivan Lozanof9e21722020-12-02 09:00:51 -05001504func (ctx *moduleContextImpl) IsVndkExt() bool {
1505 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001506}
1507
Colin Cross5271fea2021-04-27 13:06:04 -07001508func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1509 return ctx.mod.IsVendorPublicLibrary()
1510}
1511
Vic Yangefd249e2018-11-12 20:19:56 -08001512func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001513 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001514}
1515
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001516func (ctx *moduleContextImpl) selectedStl() string {
1517 if stl := ctx.mod.stl; stl != nil {
1518 return stl.Properties.SelectedStl
1519 }
1520 return ""
1521}
1522
Ivan Lozanobd721262018-11-27 14:33:03 -08001523func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1524 return ctx.mod.linker.useClangLld(actx)
1525}
1526
Colin Crossce75d2c2016-10-06 16:12:58 -07001527func (ctx *moduleContextImpl) baseModuleName() string {
1528 return ctx.mod.ModuleBase.BaseModuleName()
1529}
1530
Logan Chienf3511742017-10-31 18:04:35 +08001531func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1532 return ctx.mod.getVndkExtendsModuleName()
1533}
1534
Logan Chiene274fc92019-12-03 11:18:32 -08001535func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001536 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001537}
1538
Colin Crosse07f2312020-08-13 11:24:56 -07001539func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001540 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001541}
1542
Dan Albertc8060532020-07-22 22:32:17 -07001543func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001544 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001545}
1546
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001547func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001548 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001549}
1550
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001551func (ctx *moduleContextImpl) nativeCoverage() bool {
1552 return ctx.mod.nativeCoverage()
1553}
1554
Colin Cross56a83212020-09-15 18:30:11 -07001555func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1556 return ctx.mod.DirectlyInAnyApex()
1557}
1558
Colin Cross95b07f22020-12-16 11:06:50 -08001559func (ctx *moduleContextImpl) isPreventInstall() bool {
1560 return ctx.mod.Properties.PreventInstall
1561}
1562
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001563func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1564 return ctx.mod.isCfiAssemblySupportEnabled()
1565}
1566
Colin Cross635c3b02016-05-18 15:37:25 -07001567func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001568 return &Module{
1569 hod: hod,
1570 multilib: multilib,
1571 }
1572}
1573
Colin Cross635c3b02016-05-18 15:37:25 -07001574func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001575 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001576 module.features = []feature{
1577 &tidyFeature{},
1578 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001579 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001580 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001581 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001582 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001583 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001584 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001585 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001586 return module
1587}
1588
Colin Crossce75d2c2016-10-06 16:12:58 -07001589func (c *Module) Prebuilt() *android.Prebuilt {
1590 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1591 return p.prebuilt()
1592 }
1593 return nil
1594}
1595
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001596func (c *Module) IsPrebuilt() bool {
1597 return c.Prebuilt() != nil
1598}
1599
Colin Crossce75d2c2016-10-06 16:12:58 -07001600func (c *Module) Name() string {
1601 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001602 if p, ok := c.linker.(interface {
1603 Name(string) string
1604 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001605 name = p.Name(name)
1606 }
1607 return name
1608}
1609
Alex Light3d673592019-01-18 14:37:31 -08001610func (c *Module) Symlinks() []string {
1611 if p, ok := c.installer.(interface {
1612 symlinkList() []string
1613 }); ok {
1614 return p.symlinkList()
1615 }
1616 return nil
1617}
1618
Roland Levillainf89cd092019-07-29 16:22:59 +01001619func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1620 test, ok := c.linker.(testPerSrc)
1621 return ok && test.isAllTestsVariation()
1622}
1623
Chris Parsons216e10a2020-07-09 17:12:52 -04001624func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001625 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001626 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001627 }); ok {
1628 return p.dataPaths()
1629 }
1630 return nil
1631}
1632
Justin Yun5f7f7e82019-11-18 19:52:14 +09001633func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1634 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1635 // "current", it will append the VNDK version to the name suffix.
1636 var vndkVersion string
1637 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001638 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001639 if c.ProductSpecific() {
1640 // If the module is product specific with 'product_specific: true',
1641 // do not add a name suffix because it is a base module.
1642 return ""
1643 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001644 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1645 nameSuffix = productSuffix
1646 } else {
1647 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001648 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001649 }
1650 if vndkVersion == "current" {
1651 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1652 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001653 if c.Properties.VndkVersion != vndkVersion && c.Properties.VndkVersion != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001654 // add version suffix only if the module is using different vndk version than the
1655 // version in product or vendor partition.
1656 nameSuffix += "." + c.Properties.VndkVersion
1657 }
1658 return nameSuffix
1659}
1660
Chris Parsons8d6e4332021-02-22 16:13:50 -05001661func (c *Module) setSubnameProperty(actx android.ModuleContext) {
Inseob Kim64c43952019-08-26 16:52:35 +09001662 c.Properties.SubName = ""
1663
1664 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1665 c.Properties.SubName += nativeBridgeSuffix
1666 }
1667
Colin Cross127bb8b2020-12-16 16:46:01 -08001668 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001669 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001670 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1671 // added for product variant only when we have vendor and product variants with core
1672 // variant. The suffix is not added for vendor-only or product-only module.
1673 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
Colin Cross5271fea2021-04-27 13:06:04 -07001674 } else if c.IsVendorPublicLibrary() {
1675 c.Properties.SubName += vendorPublicLibrarySuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001676 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001677 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1678 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001679 c.Properties.SubName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001680 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1681 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001682 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001683 c.Properties.SubName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001684 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001685 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001686 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001687 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001688 if c.SplitPerApiLevel() {
1689 c.Properties.SubName += "." + c.SdkVersion()
1690 }
Inseob Kim64c43952019-08-26 16:52:35 +09001691 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001692}
1693
1694// Returns true if Bazel was successfully used for the analysis of this module.
1695func (c *Module) maybeGenerateBazelActions(actx android.ModuleContext) bool {
Liz Kammerbdc60992021-02-24 16:55:11 -05001696 bazelModuleLabel := c.GetBazelLabel(actx, c)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001697 bazelActionsUsed := false
Chris Parsonsbab4d7e2021-04-15 17:27:08 -04001698 if c.MixedBuildsEnabled(actx) && c.bazelHandler != nil {
Chris Parsons8d6e4332021-02-22 16:13:50 -05001699 bazelActionsUsed = c.bazelHandler.generateBazelBuildActions(actx, bazelModuleLabel)
1700 }
1701 return bazelActionsUsed
1702}
1703
1704func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1705 // TODO(cparsons): Any logic in this method occurring prior to querying Bazel should be
1706 // requested from Bazel instead.
1707
1708 // Handle the case of a test module split by `test_per_src` mutator.
1709 //
1710 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1711 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1712 // module and return early, as this module does not produce an output file per se.
1713 if c.IsTestPerSrcAllTestsVariation() {
1714 c.outputFile = android.OptionalPath{}
1715 return
1716 }
1717
1718 c.setSubnameProperty(actx)
1719 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1720 if !apexInfo.IsForPlatform() {
1721 c.hideApexVariantFromMake = true
1722 }
1723
Chris Parsonseefc9e62021-04-02 17:36:47 -04001724 c.makeLinkType = GetMakeLinkType(actx, c)
1725
Colin Crossca860ac2016-01-04 14:34:37 -08001726 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001727 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001728 moduleContextImpl: moduleContextImpl{
1729 mod: c,
1730 },
1731 }
1732 ctx.ctx = ctx
1733
Chris Parsons94a0bba2021-06-04 15:03:47 -04001734 if c.maybeGenerateBazelActions(actx) {
1735 c.maybeInstall(ctx, apexInfo)
1736 return
1737 }
1738
Colin Crossf18e1102017-11-16 14:33:08 -08001739 deps := c.depsToPaths(ctx)
1740 if ctx.Failed() {
1741 return
1742 }
1743
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001744 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1745 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1746 }
1747
Colin Crossca860ac2016-01-04 14:34:37 -08001748 flags := Flags{
1749 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001750 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001751 }
Colin Crossca860ac2016-01-04 14:34:37 -08001752 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001753 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001754 }
1755 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001756 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001757 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001758 if c.stl != nil {
1759 flags = c.stl.flags(ctx, flags)
1760 }
Colin Cross16b23492016-01-06 14:41:07 -08001761 if c.sanitize != nil {
1762 flags = c.sanitize.flags(ctx, flags)
1763 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001764 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001765 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001766 }
Stephen Craneba090d12017-05-09 15:44:35 -07001767 if c.lto != nil {
1768 flags = c.lto.flags(ctx, flags)
1769 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001770 if c.pgo != nil {
1771 flags = c.pgo.flags(ctx, flags)
1772 }
Colin Crossca860ac2016-01-04 14:34:37 -08001773 for _, feature := range c.features {
1774 flags = feature.flags(ctx, flags)
1775 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001776 if ctx.Failed() {
1777 return
1778 }
1779
Colin Cross4af21ed2019-11-04 09:37:55 -08001780 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1781 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1782 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001783
Colin Cross4af21ed2019-11-04 09:37:55 -08001784 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001785
1786 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001787 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001788 }
1789 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001790 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001791 }
1792
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001793 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001794 // We need access to all the flags seen by a source file.
1795 if c.sabi != nil {
1796 flags = c.sabi.flags(ctx, flags)
1797 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001798
Colin Cross4af21ed2019-11-04 09:37:55 -08001799 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001800
Colin Crossca860ac2016-01-04 14:34:37 -08001801 // Optimization to reduce size of build.ninja
1802 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001803 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1804 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1805 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1806 flags.Local.CFlags = []string{"$cflags"}
1807 flags.Local.CppFlags = []string{"$cppflags"}
1808 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001809
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001810 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001811 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001812 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001813 if ctx.Failed() {
1814 return
1815 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001816 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001817 }
1818
Colin Crossca860ac2016-01-04 14:34:37 -08001819 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001820 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001821 if ctx.Failed() {
1822 return
1823 }
Colin Cross635c3b02016-05-18 15:37:25 -07001824 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001825
Chris Parsons94a0bba2021-06-04 15:03:47 -04001826 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001827
Jose Galmes6f843bc2020-12-11 13:36:29 -08001828 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
1829 // RECOVERY_SNAPSHOT_VERSION is current.
1830 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001831 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001832 i.collectHeadersForSnapshot(ctx)
1833 }
1834 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001835 }
Colin Cross5049f022015-03-18 13:28:46 -07001836
Chris Parsons94a0bba2021-06-04 15:03:47 -04001837 c.maybeInstall(ctx, apexInfo)
1838}
1839
1840func (c *Module) maybeUnhideFromMake() {
1841 // If a lib is directly included in any of the APEXes or is not available to the
1842 // platform (which is often the case when the stub is provided as a prebuilt),
1843 // unhide the stubs variant having the latest version gets visible to make. In
1844 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1845 // force anything in the make world to link against the stubs library. (unless it
1846 // is explicitly referenced via .bootstrap suffix or the module is marked with
1847 // 'bootstrap: true').
1848 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
1849 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
1850 c.IsStubs() && !c.InVendorRamdisk() {
1851 c.Properties.HideFromMake = false // unhide
1852 // Note: this is still non-installable
1853 }
1854}
1855
1856func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001857 if !proptools.BoolDefault(c.Properties.Installable, true) {
1858 // If the module has been specifically configure to not be installed then
1859 // hide from make as otherwise it will break when running inside make
1860 // as the output path to install will not be specified. Not all uninstallable
1861 // modules can be hidden from make as some are needed for resolving make side
1862 // dependencies.
1863 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001864 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001865 c.SkipInstall()
1866 }
1867
1868 // Still call c.installer.install though, the installs will be stored as PackageSpecs
1869 // to allow using the outputs in a genrule.
1870 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001871 c.installer.install(ctx, c.outputFile.Path())
1872 if ctx.Failed() {
1873 return
Colin Crossca860ac2016-01-04 14:34:37 -08001874 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001875 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001876}
1877
Colin Cross0ea8ba82019-06-06 14:33:29 -07001878func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001879 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05001880 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08001881 }
Colin Crossca860ac2016-01-04 14:34:37 -08001882 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001883}
1884
Colin Crossca860ac2016-01-04 14:34:37 -08001885func (c *Module) begin(ctx BaseModuleContext) {
1886 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001887 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001888 }
Colin Crossca860ac2016-01-04 14:34:37 -08001889 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001890 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001891 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001892 if c.stl != nil {
1893 c.stl.begin(ctx)
1894 }
Colin Cross16b23492016-01-06 14:41:07 -08001895 if c.sanitize != nil {
1896 c.sanitize.begin(ctx)
1897 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001898 if c.coverage != nil {
1899 c.coverage.begin(ctx)
1900 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001901 if c.sabi != nil {
1902 c.sabi.begin(ctx)
1903 }
Justin Yun8effde42017-06-23 19:24:43 +09001904 if c.vndkdep != nil {
1905 c.vndkdep.begin(ctx)
1906 }
Stephen Craneba090d12017-05-09 15:44:35 -07001907 if c.lto != nil {
1908 c.lto.begin(ctx)
1909 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001910 if c.pgo != nil {
1911 c.pgo.begin(ctx)
1912 }
Colin Crossca860ac2016-01-04 14:34:37 -08001913 for _, feature := range c.features {
1914 feature.begin(ctx)
1915 }
Dan Albert92fe7402020-07-15 13:33:30 -07001916 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001917 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001918 if err != nil {
1919 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001920 c.Properties.Sdk_version = nil
1921 } else {
1922 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001923 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001924 }
Colin Crossca860ac2016-01-04 14:34:37 -08001925}
1926
Colin Cross37047f12016-12-13 17:06:13 -08001927func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001928 deps := Deps{}
1929
1930 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001931 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001932 }
1933 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001934 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001935 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001936 if c.stl != nil {
1937 deps = c.stl.deps(ctx, deps)
1938 }
Colin Cross16b23492016-01-06 14:41:07 -08001939 if c.sanitize != nil {
1940 deps = c.sanitize.deps(ctx, deps)
1941 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001942 if c.coverage != nil {
1943 deps = c.coverage.deps(ctx, deps)
1944 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001945 if c.sabi != nil {
1946 deps = c.sabi.deps(ctx, deps)
1947 }
Justin Yun8effde42017-06-23 19:24:43 +09001948 if c.vndkdep != nil {
1949 deps = c.vndkdep.deps(ctx, deps)
1950 }
Stephen Craneba090d12017-05-09 15:44:35 -07001951 if c.lto != nil {
1952 deps = c.lto.deps(ctx, deps)
1953 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001954 for _, feature := range c.features {
1955 deps = feature.deps(ctx, deps)
1956 }
1957
Colin Crossb6715442017-10-24 11:13:31 -07001958 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1959 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1960 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1961 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1962 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1963 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001964 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001965
Liz Kammer356f7d42021-01-26 09:18:53 -05001966 // In Bazel conversion mode, we dependency and build validations will occur in Bazel, so there is
1967 // no need to do so in Soong.
1968 if ctx.BazelConversionMode() {
1969 return deps
1970 }
1971
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001972 for _, lib := range deps.ReexportSharedLibHeaders {
1973 if !inList(lib, deps.SharedLibs) {
1974 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1975 }
1976 }
1977
1978 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00001979 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
1980 ctx.PropertyErrorf("export_static_lib_headers", "Static library not in static_libs or whole_static_libs: '%s'", lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001981 }
1982 }
1983
Colin Cross5950f382016-12-13 12:50:57 -08001984 for _, lib := range deps.ReexportHeaderLibHeaders {
1985 if !inList(lib, deps.HeaderLibs) {
1986 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1987 }
1988 }
1989
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001990 for _, gen := range deps.ReexportGeneratedHeaders {
1991 if !inList(gen, deps.GeneratedHeaders) {
1992 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1993 }
1994 }
1995
Colin Crossc99deeb2016-04-11 15:06:20 -07001996 return deps
1997}
1998
Dan Albert7e9d2952016-08-04 13:02:36 -07001999func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002000 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002001 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002002 moduleContextImpl: moduleContextImpl{
2003 mod: c,
2004 },
2005 }
2006 ctx.ctx = ctx
2007
Colin Crossca860ac2016-01-04 14:34:37 -08002008 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002009}
2010
Jiyong Park7ed9de32018-10-15 22:25:07 +09002011// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002012func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002013 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2014 version := name[sharp+1:]
2015 libname := name[:sharp]
2016 return libname, version
2017 }
2018 return name, ""
2019}
2020
Dan Albert92fe7402020-07-15 13:33:30 -07002021func GetCrtVariations(ctx android.BottomUpMutatorContext,
2022 m LinkableInterface) []blueprint.Variation {
2023 if ctx.Os() != android.Android {
2024 return nil
2025 }
2026 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002027 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2028 minSdkVersion := m.MinSdkVersion()
2029 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2030 minSdkVersion = m.SdkVersion()
2031 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002032 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2033 if err != nil {
2034 ctx.PropertyErrorf("min_sdk_version", err.Error())
2035 }
Dan Albert92fe7402020-07-15 13:33:30 -07002036 return []blueprint.Variation{
2037 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002038 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002039 }
2040 }
2041 return []blueprint.Variation{
2042 {Mutator: "sdk", Variation: ""},
2043 }
2044}
2045
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002046func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2047 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002048
2049 variations = append([]blueprint.Variation(nil), variations...)
2050
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002051 if version != "" && CanBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002052 // Version is explicitly specified. i.e. libFoo#30
2053 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002054 if tag, ok := depTag.(libraryDependencyTag); ok {
2055 tag.explicitlyVersioned = true
2056 } else {
2057 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2058 }
Colin Crosse7257d22020-09-24 09:56:18 -07002059 }
Colin Crosse7257d22020-09-24 09:56:18 -07002060
Colin Cross0de8a1e2020-09-18 14:15:30 -07002061 if far {
2062 ctx.AddFarVariationDependencies(variations, depTag, name)
2063 } else {
2064 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002065 }
2066}
2067
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002068func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
2069 // Only modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
2070 // SnapshotInfo, which provides no mappings.
2071 if *snapshotInfo == nil {
2072 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2073 // between the modules in the snapshot and the snapshot itself.
2074 var snapshotModule []blueprint.Module
2075 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2076 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2077 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2078 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2079 }
2080 if len(snapshotModule) > 0 {
2081 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2082 *snapshotInfo = &snapshot
2083 // republish the snapshot for use in later mutators on this module
2084 actx.SetProvider(SnapshotInfoProvider, snapshot)
2085 } else {
2086 *snapshotInfo = &SnapshotInfo{}
2087 }
2088 }
2089
2090 return **snapshotInfo
2091}
2092
2093func RewriteSnapshotLib(lib string, snapshotMap map[string]string) string {
2094 if snapshot, ok := snapshotMap[lib]; ok {
2095 return snapshot
2096 }
2097
2098 return lib
2099}
2100
2101// RewriteLibs takes a list of names of shared libraries and scans it for three types
2102// of names:
2103//
2104// 1. Name of an NDK library that refers to a prebuilt module.
2105// For each of these, it adds the name of the prebuilt module (which will be in
2106// prebuilts/ndk) to the list of nonvariant libs.
2107// 2. Name of an NDK library that refers to an ndk_library module.
2108// For each of these, it adds the name of the ndk_library module to the list of
2109// variant libs.
2110// 3. Anything else (so anything that isn't an NDK library).
2111// It adds these to the nonvariantLibs list.
2112//
2113// The caller can then know to add the variantLibs dependencies differently from the
2114// nonvariantLibs
2115func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2116 variantLibs = []string{}
2117
2118 nonvariantLibs = []string{}
2119 for _, entry := range list {
2120 // strip #version suffix out
2121 name, _ := StubsLibNameAndVersion(entry)
2122 if c.InRecovery() {
2123 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2124 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2125 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2126 } else if c.UseVndk() {
2127 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2128 } else {
2129 // put name#version back
2130 nonvariantLibs = append(nonvariantLibs, entry)
2131 }
2132 }
2133 return nonvariantLibs, variantLibs
2134}
2135
Colin Cross1e676be2016-10-12 14:38:15 -07002136func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002137 if !c.Enabled() {
2138 return
2139 }
2140
Colin Cross37047f12016-12-13 17:06:13 -08002141 ctx := &depsContext{
2142 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002143 moduleContextImpl: moduleContextImpl{
2144 mod: c,
2145 },
2146 }
2147 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002148
Colin Crossc99deeb2016-04-11 15:06:20 -07002149 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002150
Yo Chiang219968c2020-09-22 18:45:04 +08002151 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2152
Colin Crosse0edaf92021-01-11 17:31:17 -08002153 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002154
Dan Albert914449f2016-06-17 16:45:24 -07002155 variantNdkLibs := []string{}
2156 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002157 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002158 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2159 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2160 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002161
2162 for idx, lib := range deps.RuntimeLibs {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002163 deps.RuntimeLibs[idx] = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002164 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002165 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002166
Colin Cross32ec36c2016-12-15 07:39:51 -08002167 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002168 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002169 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002170 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002171 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002172
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002173 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002174
Jiyong Park1ad8e162020-12-01 23:40:09 +09002175 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002176 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002177 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002178 } else {
2179 actx.AddVariationDependencies(nil, depTag, lib)
2180 }
2181 }
2182
Dan Albertf1d14c72020-07-30 14:32:55 -07002183 if c.isNDKStubLibrary() {
2184 // NDK stubs depend on their implementation because the ABI dumps are
2185 // generated from the implementation library.
2186 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2187 c.ImageVariation(),
2188 blueprint.Variation{Mutator: "link", Variation: "shared"},
2189 ), stubImplementation, c.BaseModuleName())
2190 }
2191
Inseob Kim07def122020-11-23 14:43:02 +09002192 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
2193 // C++ implementation library and one Java implementation library. When a module links against
2194 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
2195 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
2196 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09002197 syspropImplLibraries := syspropImplLibraries(actx.Config())
2198
Jiyong Park5d1598f2019-02-25 22:14:17 +09002199 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002200 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09002201 if impl, ok := syspropImplLibraries[lib]; ok {
2202 lib = impl
2203 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002204
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002205 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002206
Jiyong Park5d1598f2019-02-25 22:14:17 +09002207 actx.AddVariationDependencies([]blueprint.Variation{
2208 {Mutator: "link", Variation: "static"},
2209 }, depTag, lib)
2210 }
2211
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002212 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002213 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002214 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002215 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002216 }
Jiyong Parke3867542020-12-03 17:28:25 +09002217 if inList(lib, deps.ExcludeLibsForApex) {
2218 depTag.excludeInApex = true
2219 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002220
2221 if impl, ok := syspropImplLibraries[lib]; ok {
2222 lib = impl
2223 }
2224
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002225 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002226
Dan Willemsen59339a22018-07-22 21:18:45 -07002227 actx.AddVariationDependencies([]blueprint.Variation{
2228 {Mutator: "link", Variation: "static"},
2229 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002230 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002231
Jooyung Han75568392020-03-20 04:29:24 +09002232 // staticUnwinderDep is treated as staticDep for Q apexes
2233 // so that native libraries/binaries are linked with static unwinder
2234 // because Q libc doesn't have unwinder APIs
2235 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002236 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002237 actx.AddVariationDependencies([]blueprint.Variation{
2238 {Mutator: "link", Variation: "static"},
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002239 }, depTag, RewriteSnapshotLib(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002240 }
2241
Jiyong Park7ed9de32018-10-15 22:25:07 +09002242 // shared lib names without the #version suffix
2243 var sharedLibNames []string
2244
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002245 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002246 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002247 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002248 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002249 }
Jiyong Parke3867542020-12-03 17:28:25 +09002250 if inList(lib, deps.ExcludeLibsForApex) {
2251 depTag.excludeInApex = true
2252 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002253
2254 if impl, ok := syspropImplLibraries[lib]; ok {
2255 lib = impl
2256 }
2257
Jiyong Park73c54ee2019-10-22 20:31:18 +09002258 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002259 sharedLibNames = append(sharedLibNames, name)
2260
Colin Crosse7257d22020-09-24 09:56:18 -07002261 variations := []blueprint.Variation{
2262 {Mutator: "link", Variation: "shared"},
2263 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002264 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002265 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002266
Colin Crossfe9acfe2021-06-14 16:13:03 -07002267 for _, lib := range deps.LateStaticLibs {
2268 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2269 actx.AddVariationDependencies([]blueprint.Variation{
2270 {Mutator: "link", Variation: "static"},
2271 }, depTag, RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
2272 }
2273
Jiyong Park7ed9de32018-10-15 22:25:07 +09002274 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002275 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002276 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2277 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2278 // linking against both the stubs lib and the non-stubs lib at the same time.
2279 continue
2280 }
Colin Cross6e511a92020-07-27 21:26:48 -07002281 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002282 variations := []blueprint.Variation{
2283 {Mutator: "link", Variation: "shared"},
2284 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002285 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002286 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002287
Dan Willemsen59339a22018-07-22 21:18:45 -07002288 actx.AddVariationDependencies([]blueprint.Variation{
2289 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002290 }, dataLibDepTag, deps.DataLibs...)
2291
2292 actx.AddVariationDependencies([]blueprint.Variation{
2293 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002294 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002295
Colin Cross68861832016-07-08 10:41:41 -07002296 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002297
2298 for _, gen := range deps.GeneratedHeaders {
2299 depTag := genHeaderDepTag
2300 if inList(gen, deps.ReexportGeneratedHeaders) {
2301 depTag = genHeaderExportDepTag
2302 }
2303 actx.AddDependency(c, depTag, gen)
2304 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002305
Dan Albert92fe7402020-07-15 13:33:30 -07002306 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002307 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002308 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002309 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002310 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002311 }
Colin Crossc465efd2021-06-11 18:00:04 -07002312 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002313 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002314 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002315 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002316 if deps.DynamicLinker != "" {
2317 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002318 }
Dan Albert914449f2016-06-17 16:45:24 -07002319
2320 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002321
2322 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002323 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002324 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002325 {Mutator: "link", Variation: "shared"},
2326 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002327
2328 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002329 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002330 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002331 {Mutator: "link", Variation: "shared"},
2332 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002333
2334 if vndkdep := c.vndkdep; vndkdep != nil {
2335 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002336 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002337 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002338 {Mutator: "link", Variation: "shared"},
2339 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002340 }
2341 }
Colin Cross6362e272015-10-29 15:25:03 -07002342}
Colin Cross21b9a242015-03-24 14:15:58 -07002343
Colin Crosse40b4ea2018-10-02 22:25:58 -07002344func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002345 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2346 c.beginMutator(ctx)
2347 }
2348}
2349
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002350// Whether a module can link to another module, taking into
2351// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002352func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002353 tag blueprint.DependencyTag) {
2354
2355 switch t := tag.(type) {
2356 case dependencyTag:
2357 if t != vndkExtDepTag {
2358 return
2359 }
2360 case libraryDependencyTag:
2361 default:
2362 return
2363 }
2364
Ivan Lozanof9e21722020-12-02 09:00:51 -05002365 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002366 // Host code is not restricted
2367 return
2368 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002369
2370 // VNDK is cc.Module supported only for now.
2371 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002372 // Though allowed dependency is limited by the image mutator,
2373 // each vendor and product module needs to check link-type
2374 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002375 if ccTo, ok := to.(*Module); ok {
2376 if ccFrom.vndkdep != nil {
2377 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2378 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002379 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002380 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002381 }
2382 return
2383 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002384 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002385 // Platform code can link to anything
2386 return
2387 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002388 if from.InRamdisk() {
2389 // Ramdisk code is not NDK
2390 return
2391 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002392 if from.InVendorRamdisk() {
2393 // Vendor ramdisk code is not NDK
2394 return
2395 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002396 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002397 // Recovery code is not NDK
2398 return
2399 }
Colin Cross31076b32020-10-23 17:22:06 -07002400 if c, ok := to.(*Module); ok {
2401 if c.ToolchainLibrary() {
2402 // These are always allowed
2403 return
2404 }
2405 if c.NdkPrebuiltStl() {
2406 // These are allowed, but they don't set sdk_version
2407 return
2408 }
2409 if c.StubDecorator() {
2410 // These aren't real libraries, but are the stub shared libraries that are included in
2411 // the NDK.
2412 return
2413 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002414 }
Logan Chien834b9a62019-01-14 15:39:03 +08002415
Ivan Lozano52767be2019-10-18 14:49:46 -07002416 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002417 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2418 // to link to libc++ (non-NDK and without sdk_version).
2419 return
2420 }
2421
Ivan Lozano52767be2019-10-18 14:49:46 -07002422 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002423 // NDK code linking to platform code is never okay.
2424 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002425 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002426 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002427 }
2428
2429 // At this point we know we have two NDK libraries, but we need to
2430 // check that we're not linking against anything built against a higher
2431 // API level, as it is only valid to link against older or equivalent
2432 // APIs.
2433
Inseob Kim01a28722018-04-11 09:48:45 +09002434 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002435 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002436 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002437 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002438 // Current can't be linked against by anything else.
2439 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002440 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002441 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002442 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002443 if err != nil {
2444 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002445 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002446 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002447 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002448 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002449 if err != nil {
2450 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002451 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002452 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002453 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002454
Inseob Kim01a28722018-04-11 09:48:45 +09002455 if toApi > fromApi {
2456 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002457 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002458 }
2459 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002460 }
Dan Albert202fe492017-12-15 13:56:59 -08002461
2462 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002463 fromStl := from.SelectedStl()
2464 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002465 if fromStl == "" || toStl == "" {
2466 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002467 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002468 // We can be permissive with the system "STL" since it is only the C++
2469 // ABI layer, but in the future we should make sure that everyone is
2470 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002471 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002472 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002473 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2474 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002475 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002476}
2477
Jooyung Han479ca172020-10-19 18:51:07 +09002478func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2479 if c, ok := ctx.Module().(*Module); ok {
2480 ctx.VisitDirectDeps(func(dep android.Module) {
2481 depTag := ctx.OtherModuleDependencyTag(dep)
2482 ccDep, ok := dep.(LinkableInterface)
2483 if ok {
2484 checkLinkType(ctx, c, ccDep, depTag)
2485 }
2486 })
2487 }
2488}
2489
Jiyong Park5fb8c102018-04-09 12:03:06 +09002490// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002491// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2492// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002493// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002494func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2495 check := func(child, parent android.Module) bool {
2496 to, ok := child.(*Module)
2497 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002498 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002499 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002500
Jooyung Hana70f0672019-01-18 15:20:43 +09002501 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2502 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002503 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002504
Jiyong Park0474e1f2021-01-14 14:26:06 +09002505 // These dependencies are not excercised at runtime. Tracking these will give us
2506 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002507 depTag := ctx.OtherModuleDependencyTag(child)
2508 if IsHeaderDepTag(depTag) {
2509 return false
2510 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002511 if depTag == staticVariantTag {
2512 return false
2513 }
2514 if depTag == stubImplDepTag {
2515 return false
2516 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002517
Justin Yun63e9ec72020-10-29 16:49:43 +09002518 // Even if target lib has no vendor variant, keep checking dependency
2519 // graph in case it depends on vendor_available or product_available
2520 // but not double_loadable transtively.
2521 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002522 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002523 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002524
Jiyong Park0474e1f2021-01-14 14:26:06 +09002525 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2526 // one.
2527 if Bool(to.VendorProperties.Double_loadable) {
2528 return true
2529 }
2530
Ivan Lozanod7586b62021-04-01 09:49:36 -04002531 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002532 return false
2533 }
2534
Jooyung Hana70f0672019-01-18 15:20:43 +09002535 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2536 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002537 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002538 return false
2539 }
2540 if module, ok := ctx.Module().(*Module); ok {
2541 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002542 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002543 ctx.WalkDeps(check)
2544 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002545 }
2546 }
2547}
2548
Colin Crossc99deeb2016-04-11 15:06:20 -07002549// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002550func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002551 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002552
Colin Cross0de8a1e2020-09-18 14:15:30 -07002553 var directStaticDeps []StaticLibraryInfo
2554 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002555
Colin Cross0de8a1e2020-09-18 14:15:30 -07002556 reexportExporter := func(exporter FlagExporterInfo) {
2557 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2558 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2559 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2560 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2561 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002562 }
2563
Jooyung Hande34d232020-07-23 13:04:15 +09002564 // For the dependency from platform to apex, use the latest stubs
2565 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002566 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2567 if !apexInfo.IsForPlatform() {
Jiyong Park4eab21d2021-04-15 15:17:54 +09002568 c.apexSdkVersion = apexInfo.MinSdkVersion
Jooyung Hande34d232020-07-23 13:04:15 +09002569 }
2570
2571 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2572 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2573 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2574 // (b/144430859)
2575 c.apexSdkVersion = android.FutureApiLevel
2576 }
2577
Colin Crossd11fcda2017-10-23 17:59:01 -07002578 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002579 depName := ctx.OtherModuleName(dep)
2580 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002581
Ivan Lozano52767be2019-10-18 14:49:46 -07002582 ccDep, ok := dep.(LinkableInterface)
2583 if !ok {
2584
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002585 // handling for a few module types that aren't cc Module but that are also supported
2586 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002587 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002588 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002589 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2590 genRule.GeneratedSourceFiles()...)
2591 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002592 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002593 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002594 // Support exported headers from a generated_sources dependency
2595 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002596 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002597 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002598 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002599 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002600 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002601 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002602 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002603 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002604 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2605 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002606 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002607 // 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 +09002608 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002609
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002610 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002611 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002612 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002613 }
Colin Crosscef792e2021-06-11 18:01:26 -07002614 case CrtBeginDepTag:
2615 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2616 case CrtEndDepTag:
2617 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002618 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002619 return
2620 }
2621
Colin Crossfe17f6f2019-03-28 19:30:56 -07002622 if depTag == android.ProtoPluginDepTag {
2623 return
2624 }
2625
Colin Crossd11fcda2017-10-23 17:59:01 -07002626 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002627 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2628 return
2629 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002630 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002631 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2632 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002633 return
2634 }
2635
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002636 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002637 // Skip reused objects for stub libraries, they use their own stub object file instead.
2638 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2639 // version mutator, so the stubs variant is created from the shared variant that
2640 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002641 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002642 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2643 objs := staticAnalogue.ReuseObjects
2644 depPaths.Objs = depPaths.Objs.Append(objs)
2645 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2646 reexportExporter(depExporterInfo)
2647 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002648 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002649 }
2650
Colin Cross6e511a92020-07-27 21:26:48 -07002651 linkFile := ccDep.OutputFile()
2652
2653 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2654 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002655 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002656 return
2657 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002658
Jiyong Parke3867542020-12-03 17:28:25 +09002659 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2660 return
2661 }
2662
Colin Cross0de8a1e2020-09-18 14:15:30 -07002663 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002664
Colin Cross6e511a92020-07-27 21:26:48 -07002665 var ptr *android.Paths
2666 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002667
Colin Cross6e511a92020-07-27 21:26:48 -07002668 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002669
Colin Cross6e511a92020-07-27 21:26:48 -07002670 switch {
2671 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002672 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2673 if !ctx.Config().AllowMissingDependencies() {
2674 ctx.ModuleErrorf("module %q is not a header library", depName)
2675 } else {
2676 ctx.AddMissingDependencies([]string{depName})
2677 }
2678 return
2679 }
Colin Cross6e511a92020-07-27 21:26:48 -07002680 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002681 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2682 if !ctx.Config().AllowMissingDependencies() {
2683 ctx.ModuleErrorf("module %q is not a shared library", depName)
2684 } else {
2685 ctx.AddMissingDependencies([]string{depName})
2686 }
2687 return
2688 }
Jiyong Parke3867542020-12-03 17:28:25 +09002689
Jiyong Park7d55b612021-06-11 17:22:09 +09002690 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
2691 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07002692
Jiyong Park1ad8e162020-12-01 23:40:09 +09002693 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2694 // linkFile, depFile, and ptr.
2695 if c.IsStubs() {
2696 break
2697 }
2698
Colin Cross0de8a1e2020-09-18 14:15:30 -07002699 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2700 depFile = sharedLibraryInfo.TableOfContents
2701
Colin Cross6e511a92020-07-27 21:26:48 -07002702 ptr = &depPaths.SharedLibs
2703 switch libDepTag.Order {
2704 case earlyLibraryDependency:
2705 ptr = &depPaths.EarlySharedLibs
2706 depPtr = &depPaths.EarlySharedLibsDeps
2707 case normalLibraryDependency:
2708 ptr = &depPaths.SharedLibs
2709 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002710 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002711 case lateLibraryDependency:
2712 ptr = &depPaths.LateSharedLibs
2713 depPtr = &depPaths.LateSharedLibsDeps
2714 default:
2715 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002716 }
Colin Cross6e511a92020-07-27 21:26:48 -07002717 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002718 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2719 if !ctx.Config().AllowMissingDependencies() {
2720 ctx.ModuleErrorf("module %q is not a static library", depName)
2721 } else {
2722 ctx.AddMissingDependencies([]string{depName})
2723 }
2724 return
2725 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002726
2727 // Stubs lib doesn't link to the static lib dependencies. Don't set
2728 // linkFile, depFile, and ptr.
2729 if c.IsStubs() {
2730 break
2731 }
2732
Colin Cross0de8a1e2020-09-18 14:15:30 -07002733 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2734 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002735 if libDepTag.wholeStatic {
2736 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002737 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2738 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002739 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002740 // This case normally catches prebuilt static
2741 // libraries, but it can also occur when
2742 // AllowMissingDependencies is on and the
2743 // dependencies has no sources of its own
2744 // but has a whole_static_libs dependency
2745 // on a missing library. We want to depend
2746 // on the .a file so that there is something
2747 // in the dependency tree that contains the
2748 // error rule for the missing transitive
2749 // dependency.
2750 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002751 }
Colin Cross6e511a92020-07-27 21:26:48 -07002752 } else {
2753 switch libDepTag.Order {
2754 case earlyLibraryDependency:
2755 panic(fmt.Errorf("early static libs not suppported"))
2756 case normalLibraryDependency:
2757 // static dependencies will be handled separately so they can be ordered
2758 // using transitive dependencies.
2759 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002760 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002761 case lateLibraryDependency:
2762 ptr = &depPaths.LateStaticLibs
2763 default:
2764 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002765 }
2766 }
2767 }
2768
Colin Cross6e511a92020-07-27 21:26:48 -07002769 if libDepTag.static() && !libDepTag.wholeStatic {
2770 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2771 ctx.ModuleErrorf("module %q not a static library", depName)
2772 return
2773 }
Logan Chien43d34c32017-12-20 01:17:32 +08002774
Colin Cross6e511a92020-07-27 21:26:48 -07002775 // When combining coverage files for shared libraries and executables, coverage files
2776 // in static libraries act as if they were whole static libraries. The same goes for
2777 // source based Abi dump files.
2778 if c, ok := ccDep.(*Module); ok {
2779 staticLib := c.linker.(libraryInterface)
2780 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2781 staticLib.objs().coverageFiles...)
2782 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2783 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002784 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002785 // Handle non-CC modules here
2786 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002787 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002788 }
2789 }
2790
Colin Cross6e511a92020-07-27 21:26:48 -07002791 if ptr != nil {
2792 if !linkFile.Valid() {
2793 if !ctx.Config().AllowMissingDependencies() {
2794 ctx.ModuleErrorf("module %q missing output file", depName)
2795 } else {
2796 ctx.AddMissingDependencies([]string{depName})
2797 }
2798 return
2799 }
2800 *ptr = append(*ptr, linkFile.Path())
2801 }
2802
2803 if depPtr != nil {
2804 dep := depFile
2805 if !dep.Valid() {
2806 dep = linkFile
2807 }
2808 *depPtr = append(*depPtr, dep.Path())
2809 }
2810
Colin Cross0de8a1e2020-09-18 14:15:30 -07002811 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2812 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2813 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2814 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2815
2816 if libDepTag.reexportFlags {
2817 reexportExporter(depExporterInfo)
2818 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2819 // Re-exported shared library headers must be included as well since they can help us with type information
2820 // about template instantiations (instantiated from their headers).
2821 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2822 // scripts.
2823 c.sabi.Properties.ReexportedIncludes = append(
2824 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2825 }
2826
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002827 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002828 switch {
2829 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002830 c.Properties.AndroidMkHeaderLibs = append(
2831 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002832 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002833 if lib := moduleLibraryInterface(dep); lib != nil {
2834 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002835 // Add the dependency to the APEX(es) providing the library so that
2836 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002837 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09002838 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07002839 c.Properties.ApexesProvidingSharedLibs = append(
2840 c.Properties.ApexesProvidingSharedLibs, an)
2841 }
2842 }
2843 }
2844
2845 // Note: the order of libs in this list is not important because
2846 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002847 c.Properties.AndroidMkSharedLibs = append(
2848 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002849 // Record BaseLibName for snapshots.
2850 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002851 case libDepTag.static():
2852 if libDepTag.wholeStatic {
2853 c.Properties.AndroidMkWholeStaticLibs = append(
2854 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2855 } else {
2856 c.Properties.AndroidMkStaticLibs = append(
2857 c.Properties.AndroidMkStaticLibs, makeLibName)
2858 }
2859 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002860 } else if !c.IsStubs() {
2861 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2862
Colin Cross6e511a92020-07-27 21:26:48 -07002863 switch depTag {
2864 case runtimeDepTag:
2865 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002866 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002867 // Record BaseLibName for snapshots.
2868 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002869 case objDepTag:
2870 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2871 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002872 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002873 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002874 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002875 case dynamicLinkerDepTag:
2876 depPaths.DynamicLinker = linkFile
2877 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002878 }
Colin Crossca860ac2016-01-04 14:34:37 -08002879 })
2880
Jeff Gaston294356f2017-09-27 17:05:30 -07002881 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002882 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2883 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2884 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002885
Colin Crossdd84e052017-05-17 13:44:16 -07002886 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002887 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002888 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2889 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002890 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002891 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2892 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002893 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002894 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002895 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002896
2897 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002898 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002899 }
Colin Crossdd84e052017-05-17 13:44:16 -07002900
Colin Crossca860ac2016-01-04 14:34:37 -08002901 return depPaths
2902}
2903
Jiyong Park7d55b612021-06-11 17:22:09 +09002904// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
2905// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
2906// dependency. The stub variant is selected when the dependency crosses a boundary where each side
2907// has different level of updatability. For example, if a library foo in an APEX depends on a
2908// library bar which provides stable interface and exists in the platform, foo uses the stub variant
2909// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
2910// same APEX as foo, the non-stub variant of bar is used.
2911func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
2912 depName := ctx.OtherModuleName(dep)
2913 depTag := ctx.OtherModuleDependencyTag(dep)
2914 libDepTag, ok := depTag.(libraryDependencyTag)
2915 if !ok || !libDepTag.shared() {
2916 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2917 }
2918
2919 thisModule, ok := ctx.Module().(android.ApexModule)
2920 if !ok {
2921 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
2922 }
2923
2924 useVndk := false
2925 bootstrap := false
2926 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
2927 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
2928 } else {
2929 useVndk = linkable.UseVndk()
2930 bootstrap = linkable.Bootstrap()
2931 }
2932
2933 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2934 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2935 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
2936 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2937
2938 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
2939 useStubs := false
2940
2941 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
2942 if !apexInfo.IsForPlatform() {
2943 // For platform libraries, use current version of LLNDK
2944 // If this is for use_vendor apex we will apply the same rules
2945 // of apex sdk enforcement below to choose right version.
2946 useStubs = true
2947 }
Jiyong Park9477c262021-06-22 20:23:05 +09002948 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
2949 // If not building for APEX or the containing APEX allows the use of
2950 // platform APIs, use stubs only when it is from an APEX (and not from
2951 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
2952 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09002953 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
2954 if useStubs {
2955 // Another exception: if this module is a test for an APEX, then
2956 // it is linked with the non-stub variant of a module in the APEX
2957 // as if this is part of the APEX.
2958 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2959 for _, apexContents := range testFor.ApexContents {
2960 if apexContents.DirectlyInApex(depName) {
2961 useStubs = false
2962 break
2963 }
2964 }
2965 }
2966 if useStubs {
2967 // Yet another exception: If this module and the dependency are
2968 // available to the same APEXes then skip stubs between their
2969 // platform variants. This complements the test_for case above,
2970 // which avoids the stubs on a direct APEX library dependency, by
2971 // avoiding stubs for indirect test dependencies as well.
2972 //
2973 // TODO(b/183882457): This doesn't work if the two libraries have
2974 // only partially overlapping apex_available. For that test_for
2975 // modules would need to be split into APEX variants and resolved
2976 // separately for each APEX they have access to.
2977 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
2978 useStubs = false
2979 }
2980 }
2981 } else {
2982 // If building for APEX, use stubs when the parent is in any APEX that
2983 // the child is not in.
2984 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2985 }
2986
2987 // when to use (unspecified) stubs, use the latest one.
2988 if useStubs {
2989 stubs := sharedLibraryStubsInfo.SharedStubLibraries
2990 toUse := stubs[len(stubs)-1]
2991 sharedLibraryInfo = toUse.SharedLibraryInfo
2992 depExporterInfo = toUse.FlagExporterInfo
2993 }
2994 }
2995 return sharedLibraryInfo, depExporterInfo
2996}
2997
Colin Cross0de8a1e2020-09-18 14:15:30 -07002998// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2999// to match the topological order of the dependency tree, including any static analogues of
3000// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3001// of the transitive dependencies.
3002func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
3003 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
3004 var staticPaths android.Paths
3005 for _, staticDep := range staticDeps {
3006 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3007 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3008 }
3009 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003010 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3011 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003012 }
3013 }
3014 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3015
3016 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3017
3018 // reorder the dependencies based on transitive dependencies
3019 staticPaths = android.FirstUniquePaths(staticPaths)
3020 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3021
3022 if len(orderedStaticPaths) != len(staticPaths) {
3023 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3024 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3025 }
3026
3027 return orderedStaticPaths, transitiveStaticLibs
3028}
3029
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003030// BaseLibName trims known prefixes and suffixes
3031func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003032 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3033 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003034 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003035 return libName
3036}
3037
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003038func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003039 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003040 ccDepModule, _ := ccDep.(*Module)
3041 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003042 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003043
Justin Yuncbca3732021-02-03 19:24:13 +09003044 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003045 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07003046 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003047 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003048 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003049
Ivan Lozanod1dec542021-05-26 15:33:11 -04003050 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003051 }
3052 }
3053
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003054 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3055 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003056 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3057 // core module instead.
3058 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003059 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003060 // The vendor and product modules in Make will have been renamed to not conflict with the
3061 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003062 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003063 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
3064 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003065 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003066 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003067 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
3068 return libName + recoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003069 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Colin Cross6e511a92020-07-27 21:26:48 -07003070 return libName + nativeBridgeSuffix
3071 } else {
3072 return libName
3073 }
3074}
3075
Colin Crossca860ac2016-01-04 14:34:37 -08003076func (c *Module) InstallInData() bool {
3077 if c.installer == nil {
3078 return false
3079 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003080 return c.installer.inData()
3081}
3082
3083func (c *Module) InstallInSanitizerDir() bool {
3084 if c.installer == nil {
3085 return false
3086 }
3087 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003088 return true
3089 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003090 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003091}
3092
Yifan Hong1b3348d2020-01-21 15:53:22 -08003093func (c *Module) InstallInRamdisk() bool {
3094 return c.InRamdisk()
3095}
3096
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003097func (c *Module) InstallInVendorRamdisk() bool {
3098 return c.InVendorRamdisk()
3099}
3100
Jiyong Parkf9332f12018-02-01 00:54:12 +09003101func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003102 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003103}
3104
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003105func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003106 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003107 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003108 return
3109 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003110 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003111}
3112
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003113func (c *Module) HostToolPath() android.OptionalPath {
3114 if c.installer == nil {
3115 return android.OptionalPath{}
3116 }
3117 return c.installer.hostToolPath()
3118}
3119
Nan Zhangd4e641b2017-07-12 12:55:28 -07003120func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3121 return c.outputFile
3122}
3123
Colin Cross41955e82019-05-29 14:40:35 -07003124func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3125 switch tag {
3126 case "":
3127 if c.outputFile.Valid() {
3128 return android.Paths{c.outputFile.Path()}, nil
3129 }
3130 return android.Paths{}, nil
3131 default:
3132 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003133 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003134}
3135
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003136func (c *Module) static() bool {
3137 if static, ok := c.linker.(interface {
3138 static() bool
3139 }); ok {
3140 return static.static()
3141 }
3142 return false
3143}
3144
Jiyong Park379de2f2018-12-19 02:47:14 +09003145func (c *Module) staticBinary() bool {
3146 if static, ok := c.linker.(interface {
3147 staticBinary() bool
3148 }); ok {
3149 return static.staticBinary()
3150 }
3151 return false
3152}
3153
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003154func (c *Module) testBinary() bool {
3155 if test, ok := c.linker.(interface {
3156 testBinary() bool
3157 }); ok {
3158 return test.testBinary()
3159 }
3160 return false
3161}
3162
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003163// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3164func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003165 if h, ok := c.linker.(interface {
3166 header() bool
3167 }); ok {
3168 return h.header()
3169 }
3170 return false
3171}
3172
Ivan Lozanod7586b62021-04-01 09:49:36 -04003173func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003174 if b, ok := c.linker.(interface {
3175 binary() bool
3176 }); ok {
3177 return b.binary()
3178 }
3179 return false
3180}
3181
Ivan Lozanod7586b62021-04-01 09:49:36 -04003182func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003183 if o, ok := c.linker.(interface {
3184 object() bool
3185 }); ok {
3186 return o.object()
3187 }
3188 return false
3189}
3190
Ivan Lozanof9e21722020-12-02 09:00:51 -05003191func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003192 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003193 if c.IsLlndk() {
3194 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003195 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003196 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003197 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003198 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003199 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003200 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003201 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003202 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003203 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003204 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003205 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003206 return "native:product"
3207 }
Jooyung Han38002912019-05-16 04:01:54 +09003208 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003209 } else if c.InRamdisk() {
3210 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003211 } else if c.InVendorRamdisk() {
3212 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003213 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003214 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003215 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003216 return "native:ndk:none:none"
3217 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3218 //family, link := getNdkStlFamilyAndLinkType(c)
3219 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003220 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003221 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003222 } else {
3223 return "native:platform"
3224 }
3225}
3226
Jiyong Park9d452992018-10-03 00:38:19 +09003227// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003228// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003229func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003230 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003231 // Stub libs and prebuilt libs in a versioned SDK are not
3232 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07003233 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01003234 } else if _, ok := c.linker.(testPerSrc); ok {
3235 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003236 }
3237 return false
3238}
3239
Jiyong Parka90ca002019-10-07 15:47:24 +09003240func (c *Module) AvailableFor(what string) bool {
3241 if linker, ok := c.linker.(interface {
3242 availableFor(string) bool
3243 }); ok {
3244 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3245 } else {
3246 return c.ApexModuleBase.AvailableFor(what)
3247 }
3248}
3249
Jiyong Park62304bb2020-04-13 16:19:48 +09003250func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003251 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003252}
3253
Colin Crossaede88c2020-08-11 12:17:01 -07003254func (c *Module) UniqueApexVariations() bool {
3255 if u, ok := c.compiler.(interface {
3256 uniqueApexVariations() bool
3257 }); ok {
3258 return u.uniqueApexVariations()
3259 } else {
3260 return false
3261 }
3262}
3263
Paul Duffin0cb37b92020-03-04 14:52:46 +00003264func (c *Module) EverInstallable() bool {
3265 return c.installer != nil &&
3266 // Check to see whether the module is actually ever installable.
3267 c.installer.everInstallable()
3268}
3269
Ivan Lozanod7586b62021-04-01 09:49:36 -04003270func (c *Module) PreventInstall() bool {
3271 return c.Properties.PreventInstall
3272}
3273
3274func (c *Module) Installable() *bool {
3275 return c.Properties.Installable
3276}
3277
3278func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003279 ret := c.EverInstallable() &&
3280 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003281 proptools.BoolDefault(c.Installable(), true) &&
3282 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003283
3284 // The platform variant doesn't need further condition. Apex variants however might not
3285 // be installable because it will likely to be included in the APEX and won't appear
3286 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003287 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003288 return ret
3289 }
3290
3291 // Special case for modules that are configured to be installed to /data, which includes
3292 // test modules. For these modules, both APEX and non-APEX variants are considered as
3293 // installable. This is because even the APEX variants won't be included in the APEX, but
3294 // will anyway be installed to /data/*.
3295 // See b/146995717
3296 if c.InstallInData() {
3297 return ret
3298 }
3299
3300 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003301}
3302
Logan Chien41eabe62019-04-10 13:33:58 +08003303func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3304 if c.linker != nil {
3305 if library, ok := c.linker.(*libraryDecorator); ok {
3306 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3307 }
3308 }
3309}
3310
Jiyong Park45bf82e2020-12-15 22:29:02 +09003311var _ android.ApexModule = (*Module)(nil)
3312
3313// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003314func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003315 depTag := ctx.OtherModuleDependencyTag(dep)
3316 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3317
3318 if cc, ok := dep.(*Module); ok {
3319 if cc.HasStubsVariants() {
3320 if isLibDepTag && libDepTag.shared() {
3321 // dynamic dep to a stubs lib crosses APEX boundary
3322 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003323 }
Colin Cross6e511a92020-07-27 21:26:48 -07003324 if IsRuntimeDepTag(depTag) {
3325 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003326 return false
3327 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003328 }
Zhijun Heec285872021-04-24 10:47:08 -07003329 if cc.IsLlndk() {
3330 return false
3331 }
Colin Crossaac32222020-07-29 12:51:56 -07003332 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003333 // shared_lib dependency from a static lib is considered as crossing
3334 // the APEX boundary because the dependency doesn't actually is
3335 // linked; the dependency is used only during the compilation phase.
3336 return false
3337 }
Jiyong Parke3867542020-12-03 17:28:25 +09003338
3339 if isLibDepTag && libDepTag.excludeInApex {
3340 return false
3341 }
Colin Cross6e511a92020-07-27 21:26:48 -07003342 }
Colin Crossc1b36442021-05-06 13:42:48 -07003343 if depTag == stubImplDepTag {
3344 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003345 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003346 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003347 if depTag == staticVariantTag {
3348 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3349 // actually mean that the static lib (and its dependencies) are copied into the
3350 // APEX.
3351 return false
3352 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003353 return true
3354}
3355
Jiyong Park45bf82e2020-12-15 22:29:02 +09003356// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003357func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3358 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003359 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3360 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3361 return nil
3362 }
3363 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3364 if c.ToolchainLibrary() {
3365 return nil
3366 }
3367 // We don't check for prebuilt modules
3368 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3369 return nil
3370 }
3371 minSdkVersion := c.MinSdkVersion()
3372 if minSdkVersion == "apex_inherit" {
3373 return nil
3374 }
3375 if minSdkVersion == "" {
3376 // JNI libs within APK-in-APEX fall into here
3377 // Those are okay to set sdk_version instead
3378 // We don't have to check if this is a SDK variant because
3379 // non-SDK variant resets sdk_version, which works too.
3380 minSdkVersion = c.SdkVersion()
3381 }
Dan Albertc8060532020-07-22 22:32:17 -07003382 if minSdkVersion == "" {
3383 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3384 }
3385 // Not using nativeApiLevelFromUser because the context here is not
3386 // necessarily a native context.
3387 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003388 if err != nil {
3389 return err
3390 }
Dan Albertc8060532020-07-22 22:32:17 -07003391
3392 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003393 return fmt.Errorf("newer SDK(%v)", ver)
3394 }
3395 return nil
3396}
3397
Paul Duffinb5769c12021-05-12 16:16:51 +01003398// Implements android.ApexModule
3399func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3400 // stub libraries and native bridge libraries are always available to platform
3401 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3402}
3403
Colin Cross2ba19d92015-05-07 15:44:20 -07003404//
Colin Crosscfad1192015-11-02 16:43:11 -08003405// Defaults
3406//
Colin Crossca860ac2016-01-04 14:34:37 -08003407type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003408 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003409 android.DefaultsModuleBase
Liz Kammer3cf52112021-03-31 15:42:03 -04003410 // Included to support setting bazel_module.label for multiple Soong modules to the same Bazel
3411 // target. This is primarily useful for modules that were architecture specific and instead are
3412 // handled in Bazel as a select().
3413 android.BazelModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003414 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003415}
3416
Patrice Arrudac249c712019-03-19 17:00:29 -07003417// cc_defaults provides a set of properties that can be inherited by other cc
3418// modules. A module can use the properties from a cc_defaults using
3419// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3420// merged (when possible) by prepending the default module's values to the
3421// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003422func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003423 return DefaultsFactory()
3424}
3425
Colin Cross36242852017-06-23 15:06:31 -07003426func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003427 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003428
Colin Cross36242852017-06-23 15:06:31 -07003429 module.AddProperties(props...)
3430 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003431 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003432 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003433 &BaseCompilerProperties{},
3434 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003435 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003436 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003437 &StaticProperties{},
3438 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003439 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003440 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003441 &TestProperties{},
3442 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003443 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003444 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003445 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003446 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003447 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003448 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003449 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003450 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003451 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003452 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003453 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003454 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003455 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003456 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3457 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003458 )
Colin Crosscfad1192015-11-02 16:43:11 -08003459
Liz Kammer3cf52112021-03-31 15:42:03 -04003460 // Bazel module must be initialized _before_ Defaults to be included in cc_defaults module.
3461 android.InitBazelModule(module)
Jooyung Hancc372c52019-09-25 15:18:44 +09003462 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003463
3464 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003465}
3466
Jiyong Park2286afd2020-06-16 21:58:53 +09003467func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003468 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003469}
3470
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003471func kytheExtractAllFactory() android.Singleton {
3472 return &kytheExtractAllSingleton{}
3473}
3474
3475type kytheExtractAllSingleton struct {
3476}
3477
3478func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3479 var xrefTargets android.Paths
3480 ctx.VisitAllModules(func(module android.Module) {
3481 if ccModule, ok := module.(xref); ok {
3482 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3483 }
3484 })
3485 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3486 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003487 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003488 }
3489}
3490
Colin Cross06a931b2015-10-28 17:23:31 -07003491var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003492var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003493var BoolPtr = proptools.BoolPtr
3494var String = proptools.String
3495var StringPtr = proptools.StringPtr