blob: e3ca4d70b1691cd0a6313e5f036368aeee83ebc2 [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) {
Liz Kammer75db9312021-07-07 16:41:50 -040056 for _, san := range Sanitizers {
57 san.registerMutators(ctx)
58 }
Dan Willemsen581341d2017-02-09 16:16:31 -080059
Colin Cross0b908332019-06-19 23:00:20 -070060 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090061 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080062
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080063 ctx.BottomUp("coverage", coverageMutator).Parallel()
Stephen Craneba090d12017-05-09 15:44:35 -070064
65 ctx.TopDown("lto_deps", ltoDepsMutator)
66 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090067
Jooyung Han479ca172020-10-19 18:51:07 +090068 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090069 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070070 })
Colin Crossb98c8b02016-07-29 13:44:28 -070071
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080072 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
73 // sabi mutator needs to be run after apex mutator finishes.
74 ctx.TopDown("sabi_deps", sabiDepsMutator)
75 })
76
Colin Cross57898582020-10-29 18:25:19 -070077 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070078}
79
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050080// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
81// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
82// edges to these modules.
83// This object is constructed in DepsMutator, by calling to various module delegates to set
84// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
85// dependencies.
86// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
87// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080088type Deps struct {
89 SharedLibs, LateSharedLibs []string
90 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080091 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +080092 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -070093
Chris Parsons79d66a52020-06-05 17:26:16 -040094 // Used for data dependencies adjacent to tests
95 DataLibs []string
96
Yo Chiang219968c2020-09-22 18:45:04 +080097 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
98 SystemSharedLibs []string
99
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500100 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800101 StaticUnwinderIfLegacy bool
102
Colin Cross5950f382016-12-13 12:50:57 -0800103 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700104
Colin Cross81413472016-04-11 14:37:39 -0700105 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700106
Dan Willemsenb40aab62016-04-20 14:21:14 -0700107 GeneratedSources []string
108 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900109 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700110
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700111 ReexportGeneratedHeaders []string
112
Colin Crossc465efd2021-06-11 18:00:04 -0700113 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700114
115 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700116 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900117
118 // List of libs that need to be excluded for APEX variant
119 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700120}
121
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500122// PathDeps is a struct containing file paths to dependencies of a module.
123// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
124// It's used to construct flags for various build statements (such as for compiling and linking).
125// It is then passed to module decorator functions responsible for registering build statements
126// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800127type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700128 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900129 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700130 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900131 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700132 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700133 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700134
Colin Cross0de8a1e2020-09-18 14:15:30 -0700135 // Transitive static library dependencies of static libraries for use in ordering.
136 TranstiveStaticLibrariesForOrdering *android.DepSet
137
Colin Cross26c34ed2016-09-30 17:10:16 -0700138 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100139 Objs Objects
140 // Paths to .o files in dependencies that provide them. Note that these lists
141 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800142 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700143 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700144
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100145 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
146 // the libs from all whole_static_lib dependencies.
147 WholeStaticLibsFromPrebuilts android.Paths
148
Colin Cross26c34ed2016-09-30 17:10:16 -0700149 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700150 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900151 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700152
Inseob Kimd110f872019-12-06 13:15:38 +0900153 Flags []string
154 IncludeDirs android.Paths
155 SystemIncludeDirs android.Paths
156 ReexportedDirs android.Paths
157 ReexportedSystemDirs android.Paths
158 ReexportedFlags []string
159 ReexportedGeneratedHeaders android.Paths
160 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700161
Colin Cross26c34ed2016-09-30 17:10:16 -0700162 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700163 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700164
Dan Willemsena0790e32018-10-12 00:24:23 -0700165 // Path to the dynamic linker binary
166 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700167}
168
Colin Cross4af21ed2019-11-04 09:37:55 -0800169// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
170// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
171// command line so they can be overridden by the local module flags).
172type LocalOrGlobalFlags struct {
173 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700174 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800175 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700176 CFlags []string // Flags that apply to C and C++ source files
177 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
178 ConlyFlags []string // Flags that apply to C source files
179 CppFlags []string // Flags that apply to C++ source files
180 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700181 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800182}
183
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500184// Flags contains various types of command line flags (and settings) for use in building build
185// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800186type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500187 // Local flags (which individual modules are responsible for). These may override global flags.
188 Local LocalOrGlobalFlags
189 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800190 Global LocalOrGlobalFlags
191
192 aidlFlags []string // Flags that apply to aidl source files
193 rsFlags []string // Flags that apply to renderscript source files
194 libFlags []string // Flags to add libraries early to the link order
195 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
196 TidyFlags []string // Flags that apply to clang-tidy
197 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700198
Colin Crossc3199482017-03-30 15:03:04 -0700199 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800200 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700201 SystemIncludeFlags []string
202
Oliver Nguyen04526782020-04-21 12:40:27 -0700203 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500204 Tidy bool // True if clang-tidy is enabled.
205 GcovCoverage bool // True if coverage files should be generated.
206 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700207 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800208
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500209 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800210 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500211 // The target-device system path to the dynamic linker.
212 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800213
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700214 CFlagsDeps android.Paths // Files depended on by compiler flags
215 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800216
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500217 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700218 AssemblerWithCpp bool
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500219 // True if static libraries should be grouped (using `-Wl,--start-group` and `-Wl,--end-group`).
220 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800221
Colin Cross19878da2019-03-28 14:45:07 -0700222 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700223 protoC bool // Whether to use C instead of C++
224 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700225
226 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200227 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700228}
229
Colin Crossca860ac2016-01-04 14:34:37 -0800230// Properties used to compile all C or C++ modules
231type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700232 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800233 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700234
Jiyong Parkb35a8192020-08-10 15:59:36 +0900235 // The API level that this module is built against. The APIs of this API level will be
236 // visible at build time, but use of any APIs newer than min_sdk_version will render the
237 // module unloadable on older devices. In the future it will be possible to weakly-link new
238 // APIs, making the behavior match Java: such modules will load on older devices, but
239 // calling new APIs on devices that do not support them will result in a crash.
240 //
241 // This property has the same behavior as sdk_version does for Java modules. For those
242 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
243 // does for Java code.
244 //
245 // In addition, setting this property causes two variants to be built, one for the platform
246 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800247 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700248
Jiyong Parkb35a8192020-08-10 15:59:36 +0900249 // Minimum OS API level supported by this C or C++ module. This property becomes the value
250 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
251 // this property is also used to ensure that the min_sdk_version of the containing module is
252 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
253 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
254 // min_sdk_version of the containing APEX. When the module
255 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900256 Min_sdk_version *string
257
Colin Crossc511bc52020-04-07 16:50:32 +0000258 // If true, always create an sdk variant and don't create a platform variant.
259 Sdk_variant_only *bool
260
Jiyong Parkde866cb2018-12-07 23:08:36 +0900261 AndroidMkSharedLibs []string `blueprint:"mutated"`
262 AndroidMkStaticLibs []string `blueprint:"mutated"`
263 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
264 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700265 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900266 HideFromMake bool `blueprint:"mutated"`
267 PreventInstall bool `blueprint:"mutated"`
268 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700269
Yo Chiang219968c2020-09-22 18:45:04 +0800270 // Set by DepsMutator.
271 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
272
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200273 // The name of the image this module is built for, suffixed with a '.'
Justin Yun5f7f7e82019-11-18 19:52:14 +0900274 ImageVariationPrefix string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200275
276 // The VNDK version this module is built against. If empty, the module is not
277 // build against the VNDK.
278 VndkVersion string `blueprint:"mutated"`
279
280 // Suffix for the name of Android.mk entries generated by this module
281 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800282
283 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
284 // file
285 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900286
Yifan Hong39143a92020-10-26 12:43:12 -0700287 // Make this module available when building for ramdisk.
288 // On device without a dedicated recovery partition, the module is only
289 // available after switching root into
290 // /first_stage_ramdisk. To expose the module before switching root, install
291 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800292 Ramdisk_available *bool
293
Yifan Hong39143a92020-10-26 12:43:12 -0700294 // Make this module available when building for vendor ramdisk.
295 // On device without a dedicated recovery partition, the module is only
296 // available after switching root into
297 // /first_stage_ramdisk. To expose the module before switching root, install
298 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700299 Vendor_ramdisk_available *bool
300
Jiyong Parkf9332f12018-02-01 00:54:12 +0900301 // Make this module available when building for recovery
302 Recovery_available *bool
303
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200304 // Used by imageMutator, set by ImageMutatorBegin()
305 CoreVariantNeeded bool `blueprint:"mutated"`
306 RamdiskVariantNeeded bool `blueprint:"mutated"`
307 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
308 RecoveryVariantNeeded bool `blueprint:"mutated"`
309
310 // A list of variations for the "image" mutator of the form
311 //<image name> '.' <version char>, for example, 'vendor.S'
312 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900313
314 // Allows this module to use non-APEX version of libraries. Useful
315 // for building binaries that are started before APEXes are activated.
316 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900317
318 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
319 // see soong/cc/config/vndk.go
320 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900321
322 // Used by vendor snapshot to record dependencies from snapshot modules.
323 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900324 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900325 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000326
327 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000328
329 // Set by factories of module types that can only be referenced from variants compiled against
330 // the SDK.
331 AlwaysSdk bool `blueprint:"mutated"`
332
333 // Variant is an SDK variant created by sdkMutator
334 IsSdkVariant bool `blueprint:"mutated"`
335 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
336 // variant to have a ".sdk" suffix.
337 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700338
339 // Normally Soong uses the directory structure to decide which modules
340 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800341 // different snapshots (vendor, recovery, etc.), but this property
342 // allows a partner to exclude a module normally thought of as a
343 // framework module from the vendor snapshot.
344 Exclude_from_vendor_snapshot *bool
345
346 // Normally Soong uses the directory structure to decide which modules
347 // should be included (framework) or excluded (non-framework) from the
348 // different snapshots (vendor, recovery, etc.), but this property
349 // allows a partner to exclude a module normally thought of as a
350 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800351 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900352
353 // List of APEXes that this module has private access to for testing purpose. The module
354 // can depend on libraries that are not exported by the APEXes and use private symbols
355 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000356 Test_for []string `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700357}
358
359type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900360 // whether this module should be allowed to be directly depended by other
361 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900362 // If set to true, two variants will be built separately, one like
363 // normal, and the other limited to the set of libraries and headers
364 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700365 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900366 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700367 // so it shouldn't have any unversioned runtime dependencies, or
368 // make assumptions about the system that may not be true in the
369 // future.
370 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900371 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900372 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900373 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900374 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900375 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700376 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
377 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900378
Justin Yunebcf0c52021-01-08 18:00:19 +0900379 // This is the same as the "vendor_available" except that the install path
380 // of the vendor variant is /odm or /vendor/odm.
381 // By replacing "vendor_available: true" with "odm_available: true", the
382 // module will install its vendor variant to the /odm partition or /vendor/odm.
383 // As the modules with "odm_available: true" still create the vendor variants,
384 // they can link to the other vendor modules as the vendor_available modules do.
385 // Also, the vendor modules can link to odm_available modules.
386 //
387 // It may not be used for VNDK modules.
388 Odm_available *bool
389
Justin Yun63e9ec72020-10-29 16:49:43 +0900390 // whether this module should be allowed to be directly depended by other
391 // modules with `product_specific: true` or `product_available: true`.
392 // If set to true, an additional product variant will be built separately
393 // that is limited to the set of libraries and headers that are exposed to
394 // /product modules.
395 //
396 // The product variant may be used with a different (newer) /system,
397 // so it shouldn't have any unversioned runtime dependencies, or
398 // make assumptions about the system that may not be true in the
399 // future.
400 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900401 // If set to false, this module becomes inaccessible from /product modules.
402 //
403 // Different from the 'vendor_available' property, the modules with
404 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
405 // library without 'product_available' may not be depended on by any other
406 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900407 //
408 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
409 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
410 Product_available *bool
411
Jiyong Park5fb8c102018-04-09 12:03:06 +0900412 // whether this module is capable of being loaded with other instance
413 // (possibly an older version) of the same module in the same process.
414 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
415 // can be double loaded in a vendor process if the library is also a
416 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
417 // explicitly marked as `double_loadable: true` by the owner, or the dependency
418 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
419 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800420
421 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
422 IsLLNDK bool `blueprint:"mutated"`
423
Colin Cross78212242021-01-06 14:51:30 -0800424 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
425 // set and the module is not listed in VndkMustUseVendorVariantList.
426 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
427
428 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
429 IsVNDKCore bool `blueprint:"mutated"`
430
431 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
432 IsVNDKSP bool `blueprint:"mutated"`
433
434 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
435 // module sets the llndk.private property.
436 IsVNDKPrivate bool `blueprint:"mutated"`
437
438 // IsVNDKProduct is set if a VNDK module sets the product_available property.
439 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700440
441 // IsVendorPublicLibrary is set for the core and product variants of a library that has
442 // vendor_public_library stubs.
443 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800444}
445
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500446// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
447// to understanding details about the type of the current module.
448// For example, one might call these functions to determine whether the current module is a static
449// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800450type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800451 static() bool
452 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700453 testBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900454 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900455 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900456 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700457 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900458 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700459 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800460 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900461 minSdkVersion() string
462 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700463 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700464 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800465 IsLlndk() bool
466 IsLlndkPublic() bool
467 isImplementationForLLNDKPublic() bool
468 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900469 isVndk() bool
470 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500471 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700472 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900473 inProduct() bool
474 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800475 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700476 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900477 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700478 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700479 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800480 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800481 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800482 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800483 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800484 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700485 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700486 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900487 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800488 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700489 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700490 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800491 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800492 isCfiAssemblySupportEnabled() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800493}
494
495type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700496 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800497 ModuleContextIntf
498}
499
500type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700501 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800502 ModuleContextIntf
503}
504
Colin Cross37047f12016-12-13 17:06:13 -0800505type DepsContext interface {
506 android.BottomUpMutatorContext
507 ModuleContextIntf
508}
509
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500510// feature represents additional (optional) steps to building cc-related modules, such as invocation
511// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800512type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800513 flags(ctx ModuleContext, flags Flags) Flags
514 props() []interface{}
515}
516
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500517// compiler is the interface for a compiler helper object. Different module decorators may implement
518// this helper differently. For example, compiling a `cc_library` may use a different build
519// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800520type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700521 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800522 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800523 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700524 compilerProps() []interface{}
525
Colin Cross76fada02016-07-27 10:31:13 -0700526 appendCflags([]string)
527 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700528 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800529}
530
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500531// linker is the interface for a linker decorator object. Individual module types can provide
532// their own implementation for this decorator, and thus specify custom logic regarding build
533// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800534type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700535 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800536 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700537 linkerFlags(ctx ModuleContext, flags Flags) Flags
538 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800539 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700540
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700541 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700542 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900543 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700544
545 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900546 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000547
548 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000549 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
550}
551
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500552// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000553type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500554 sharedLibs []string
555 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
556 // libc, libm, etc.)
Colin Cross9ecb42d2021-06-22 13:20:01 -0700557 systemSharedLibs []string
558 defaultSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800559}
560
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500561// installer is the interface for an installer helper object. This helper is responsible for
562// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800563type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700564 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700565 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000566 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800567 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700568 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700569 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900570 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100571 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900572 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800573}
574
Chris Parsons8d6e4332021-02-22 16:13:50 -0500575// bazelHandler is the interface for a helper object related to deferring to Bazel for
576// processing a module (during Bazel mixed builds). Individual module types should define
577// their own bazel handler if they support deferring to Bazel.
578type bazelHandler interface {
579 // Issue query to Bazel to retrieve information about Bazel's view of the current module.
580 // If Bazel returns this information, set module properties on the current module to reflect
581 // the returned information.
582 // Returns true if information was available from Bazel, false if bazel invocation still needs to occur.
583 generateBazelBuildActions(ctx android.ModuleContext, label string) bool
584}
585
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800586type xref interface {
587 XrefCcFiles() android.Paths
588}
589
Colin Cross6e511a92020-07-27 21:26:48 -0700590type libraryDependencyKind int
591
592const (
593 headerLibraryDependency = iota
594 sharedLibraryDependency
595 staticLibraryDependency
596)
597
598func (k libraryDependencyKind) String() string {
599 switch k {
600 case headerLibraryDependency:
601 return "headerLibraryDependency"
602 case sharedLibraryDependency:
603 return "sharedLibraryDependency"
604 case staticLibraryDependency:
605 return "staticLibraryDependency"
606 default:
607 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
608 }
609}
610
611type libraryDependencyOrder int
612
613const (
614 earlyLibraryDependency = -1
615 normalLibraryDependency = 0
616 lateLibraryDependency = 1
617)
618
619func (o libraryDependencyOrder) String() string {
620 switch o {
621 case earlyLibraryDependency:
622 return "earlyLibraryDependency"
623 case normalLibraryDependency:
624 return "normalLibraryDependency"
625 case lateLibraryDependency:
626 return "lateLibraryDependency"
627 default:
628 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
629 }
630}
631
632// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
633// tags that have a set of predefined tag objects that are reused for each dependency, a
634// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
635// That means that comparing a libraryDependencyTag for equality will only be equal if all
636// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
637// then check individual metadata fields instead.
638type libraryDependencyTag struct {
639 blueprint.BaseDependencyTag
640
641 // These are exported so that fmt.Printf("%#v") can call their String methods.
642 Kind libraryDependencyKind
643 Order libraryDependencyOrder
644
645 wholeStatic bool
646
647 reexportFlags bool
648 explicitlyVersioned bool
649 dataLib bool
650 ndk bool
651
652 staticUnwinder bool
653
654 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900655
Cindy Zhou18417cb2020-12-10 07:12:38 -0800656 // Whether or not this dependency should skip the apex dependency check
657 skipApexAllowedDependenciesCheck bool
658
Jiyong Parke3867542020-12-03 17:28:25 +0900659 // Whether or not this dependency has to be followed for the apex variants
660 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700661}
662
663// header returns true if the libraryDependencyTag is tagging a header lib dependency.
664func (d libraryDependencyTag) header() bool {
665 return d.Kind == headerLibraryDependency
666}
667
668// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
669func (d libraryDependencyTag) shared() bool {
670 return d.Kind == sharedLibraryDependency
671}
672
673// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
674func (d libraryDependencyTag) static() bool {
675 return d.Kind == staticLibraryDependency
676}
677
Colin Crosse9fe2942020-11-10 18:12:15 -0800678// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
679// binaries or other shared libraries are installed as dependencies.
680func (d libraryDependencyTag) InstallDepNeeded() bool {
681 return d.shared()
682}
683
684var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
685
686// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700687// libraryDependencyTag. Each tag object is created globally and reused for multiple
688// dependencies (although since the object contains no references, assigning a tag to a
689// variable and modifying it will not modify the original). Users can compare the tag
690// returned by ctx.OtherModuleDependencyTag against the global original
691type dependencyTag struct {
692 blueprint.BaseDependencyTag
693 name string
694}
695
Colin Crosse9fe2942020-11-10 18:12:15 -0800696// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
697// libraryDependencyTag, but where the dependency needs to be installed when the parent is
698// installed.
699type installDependencyTag struct {
700 blueprint.BaseDependencyTag
701 android.InstallAlwaysNeededDependencyTag
702 name string
703}
704
Colin Crossc99deeb2016-04-11 15:06:20 -0700705var (
Colin Cross6e511a92020-07-27 21:26:48 -0700706 genSourceDepTag = dependencyTag{name: "gen source"}
707 genHeaderDepTag = dependencyTag{name: "gen header"}
708 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
709 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900710 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700711 reuseObjTag = dependencyTag{name: "reuse objects"}
712 staticVariantTag = dependencyTag{name: "static variant"}
713 vndkExtDepTag = dependencyTag{name: "vndk extends"}
714 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800715 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700716 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700717 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700718)
719
Roland Levillainf89cd092019-07-29 16:22:59 +0100720func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700721 ccLibDepTag, ok := depTag.(libraryDependencyTag)
722 return ok && ccLibDepTag.shared()
723}
724
725func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
726 ccLibDepTag, ok := depTag.(libraryDependencyTag)
727 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100728}
729
Zach Johnson3df4e632020-11-06 11:56:27 -0800730func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
731 ccLibDepTag, ok := depTag.(libraryDependencyTag)
732 return ok && ccLibDepTag.header()
733}
734
Roland Levillainf89cd092019-07-29 16:22:59 +0100735func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800736 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100737}
738
739func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700740 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100741 return ok && ccDepTag == testPerSrcDepTag
742}
743
Colin Crossca860ac2016-01-04 14:34:37 -0800744// Module contains the properties and members used by all C/C++ module types, and implements
745// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500746// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
747// interface.
748//
749// To define a C/C++ related module, construct a new Module object and point its delegates to
750// type-specific structs. These delegates will be invoked to register module-specific build
751// statements which may be unique to the module type. For example, module.compiler.compile() should
752// be defined so as to register build statements which are responsible for compiling the module.
753//
754// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
755// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
756// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
757// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800758type Module struct {
hamzeh41ad8812021-07-07 14:00:07 -0700759 FuzzModule
760
Jiyong Parkd1063c12019-07-17 20:08:41 +0900761 android.SdkBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500762 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700763
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700764 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700765 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700766
Colin Crossca860ac2016-01-04 14:34:37 -0800767 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700768 hod android.HostOrDeviceSupported
769 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700770
Paul Duffina0843f62019-12-13 19:50:38 +0000771 // Allowable SdkMemberTypes of this module type.
772 sdkMemberTypes []android.SdkMemberType
773
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500774 // decorator delegates, initialize before calling Init
775 // these may contain module-specific implementations, and effectively allow for custom
776 // type-specific logic. These members may reference different objects or the same object.
777 // Functions of these decorators will be invoked to initialize and register type-specific
778 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500779 compiler compiler
780 linker linker
781 installer installer
782 bazelHandler bazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500783
784 features []feature
785 stl *stl
786 sanitize *sanitize
787 coverage *coverage
788 sabi *sabi
789 vndkdep *vndkdep
790 lto *lto
791 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800792
Colin Cross31076b32020-10-23 17:22:06 -0700793 library libraryInterface
794
Colin Cross635c3b02016-05-18 15:37:25 -0700795 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800796
Colin Crossb98c8b02016-07-29 13:44:28 -0700797 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700798
799 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800800
801 // Flags used to compile this module
802 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700803
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800804 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700805 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900806
807 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800808 // Kythe (source file indexer) paths for this compilation module
809 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900810
811 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700812 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700813
814 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700815}
816
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200817func (c *Module) AddJSONData(d *map[string]interface{}) {
818 c.AndroidModuleBase().AddJSONData(d)
819 (*d)["Cc"] = map[string]interface{}{
820 "SdkVersion": c.SdkVersion(),
821 "MinSdkVersion": c.MinSdkVersion(),
822 "VndkVersion": c.VndkVersion(),
823 "ProductSpecific": c.ProductSpecific(),
824 "SocSpecific": c.SocSpecific(),
825 "DeviceSpecific": c.DeviceSpecific(),
826 "InProduct": c.InProduct(),
827 "InVendor": c.InVendor(),
828 "InRamdisk": c.InRamdisk(),
829 "InVendorRamdisk": c.InVendorRamdisk(),
830 "InRecovery": c.InRecovery(),
831 "VendorAvailable": c.VendorAvailable(),
832 "ProductAvailable": c.ProductAvailable(),
833 "RamdiskAvailable": c.RamdiskAvailable(),
834 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
835 "RecoveryAvailable": c.RecoveryAvailable(),
836 "OdmAvailable": c.OdmAvailable(),
837 "InstallInData": c.InstallInData(),
838 "InstallInRamdisk": c.InstallInRamdisk(),
839 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
840 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
841 "InstallInRecovery": c.InstallInRecovery(),
842 "InstallInRoot": c.InstallInRoot(),
843 "IsVndk": c.IsVndk(),
844 "IsVndkExt": c.IsVndkExt(),
845 "IsVndkPrivate": c.IsVndkPrivate(),
846 "IsVndkSp": c.IsVndkSp(),
847 "IsLlndk": c.IsLlndk(),
848 "IsLlndkPublic": c.IsLlndkPublic(),
849 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
850 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
851 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
852 "ApexSdkVersion": c.apexSdkVersion,
853 "TestFor": c.TestFor(),
854 }
855}
856
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500857func (c *Module) SetPreventInstall() {
858 c.Properties.PreventInstall = true
859}
860
861func (c *Module) SetHideFromMake() {
862 c.Properties.HideFromMake = true
863}
864
Ivan Lozanod7586b62021-04-01 09:49:36 -0400865func (c *Module) HiddenFromMake() bool {
866 return c.Properties.HideFromMake
867}
868
Ivan Lozano52767be2019-10-18 14:49:46 -0700869func (c *Module) Toc() android.OptionalPath {
870 if c.linker != nil {
871 if library, ok := c.linker.(libraryInterface); ok {
872 return library.toc()
873 }
874 }
875 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
876}
877
878func (c *Module) ApiLevel() string {
879 if c.linker != nil {
880 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700881 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700882 }
883 }
884 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
885}
886
887func (c *Module) Static() bool {
888 if c.linker != nil {
889 if library, ok := c.linker.(libraryInterface); ok {
890 return library.static()
891 }
892 }
893 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
894}
895
896func (c *Module) Shared() bool {
897 if c.linker != nil {
898 if library, ok := c.linker.(libraryInterface); ok {
899 return library.shared()
900 }
901 }
902 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
903}
904
905func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000906 if c.stl != nil {
907 return c.stl.Properties.SelectedStl
908 }
909 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700910}
911
912func (c *Module) ToolchainLibrary() bool {
913 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
914 return true
915 }
916 return false
917}
918
919func (c *Module) NdkPrebuiltStl() bool {
920 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
921 return true
922 }
923 return false
924}
925
926func (c *Module) StubDecorator() bool {
927 if _, ok := c.linker.(*stubDecorator); ok {
928 return true
929 }
930 return false
931}
932
933func (c *Module) SdkVersion() string {
934 return String(c.Properties.Sdk_version)
935}
936
Artur Satayev480e25b2020-04-27 18:53:18 +0100937func (c *Module) MinSdkVersion() string {
938 return String(c.Properties.Min_sdk_version)
939}
940
Dan Albert92fe7402020-07-15 13:33:30 -0700941func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700942 if !c.canUseSdk() {
943 return false
944 }
Dan Albert92fe7402020-07-15 13:33:30 -0700945 if linker, ok := c.linker.(*objectLinker); ok {
946 return linker.isCrt()
947 }
948 return false
949}
950
Colin Crossc511bc52020-04-07 16:50:32 +0000951func (c *Module) AlwaysSdk() bool {
952 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
953}
954
Ivan Lozano183a3212019-10-18 14:18:45 -0700955func (c *Module) CcLibrary() bool {
956 if c.linker != nil {
957 if _, ok := c.linker.(*libraryDecorator); ok {
958 return true
959 }
Colin Crossd48fe732020-09-23 20:37:24 -0700960 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
961 return true
962 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700963 }
964 return false
965}
966
967func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700968 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700969 return true
970 }
971 return false
972}
973
Ivan Lozano2b262972019-11-21 12:30:50 -0800974func (c *Module) NonCcVariants() bool {
975 return false
976}
977
Ivan Lozano183a3212019-10-18 14:18:45 -0700978func (c *Module) SetStatic() {
979 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700980 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700981 library.setStatic()
982 return
983 }
984 }
985 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
986}
987
988func (c *Module) SetShared() {
989 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700990 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700991 library.setShared()
992 return
993 }
994 }
995 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
996}
997
998func (c *Module) BuildStaticVariant() bool {
999 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001000 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001001 return library.buildStatic()
1002 }
1003 }
1004 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1005}
1006
1007func (c *Module) BuildSharedVariant() bool {
1008 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001009 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001010 return library.buildShared()
1011 }
1012 }
1013 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1014}
1015
1016func (c *Module) Module() android.Module {
1017 return c
1018}
1019
Jiyong Parkc20eee32018-09-05 22:36:17 +09001020func (c *Module) OutputFile() android.OptionalPath {
1021 return c.outputFile
1022}
1023
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001024func (c *Module) CoverageFiles() android.Paths {
1025 if c.linker != nil {
1026 if library, ok := c.linker.(libraryInterface); ok {
1027 return library.objs().coverageFiles
1028 }
1029 }
1030 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1031}
1032
Ivan Lozano183a3212019-10-18 14:18:45 -07001033var _ LinkableInterface = (*Module)(nil)
1034
Jiyong Park719b4462019-01-13 00:39:51 +09001035func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001036 if c.linker != nil {
1037 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001038 }
1039 return nil
1040}
1041
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001042func (c *Module) CoverageOutputFile() android.OptionalPath {
1043 if c.linker != nil {
1044 return c.linker.coverageOutputFilePath()
1045 }
1046 return android.OptionalPath{}
1047}
1048
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001049func (c *Module) RelativeInstallPath() string {
1050 if c.installer != nil {
1051 return c.installer.relativeInstallPath()
1052 }
1053 return ""
1054}
1055
Jooyung Han344d5432019-08-23 11:17:39 +09001056func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001057 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001058}
1059
Colin Cross36242852017-06-23 15:06:31 -07001060func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001061 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001062 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001063 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001064 }
1065 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001066 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001067 }
1068 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001069 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001070 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001071 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001072 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001073 }
Colin Cross16b23492016-01-06 14:41:07 -08001074 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001075 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001076 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001077 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001078 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001079 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001080 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001081 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001082 }
Justin Yun8effde42017-06-23 19:24:43 +09001083 if c.vndkdep != nil {
1084 c.AddProperties(c.vndkdep.props()...)
1085 }
Stephen Craneba090d12017-05-09 15:44:35 -07001086 if c.lto != nil {
1087 c.AddProperties(c.lto.props()...)
1088 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001089 if c.pgo != nil {
1090 c.AddProperties(c.pgo.props()...)
1091 }
Colin Crossca860ac2016-01-04 14:34:37 -08001092 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001093 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001094 }
Colin Crossc472d572015-03-17 15:06:21 -07001095
Colin Cross36242852017-06-23 15:06:31 -07001096 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerea6666f2021-02-17 10:17:28 -05001097 android.InitBazelModule(c)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001098 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001099 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001100 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001101
Colin Cross36242852017-06-23 15:06:31 -07001102 return c
Colin Crossc472d572015-03-17 15:06:21 -07001103}
1104
Ivan Lozano52767be2019-10-18 14:49:46 -07001105func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001106 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001107}
1108
Colin Crossc511bc52020-04-07 16:50:32 +00001109func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001110 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1111 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001112}
1113
1114func (c *Module) UseSdk() bool {
1115 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001116 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001117 }
1118 return false
1119}
1120
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001121func (c *Module) isCoverageVariant() bool {
1122 return c.coverage.Properties.IsCoverageVariant
1123}
1124
Colin Cross95f1ca02020-10-29 20:47:22 -07001125func (c *Module) IsNdk(config android.Config) bool {
1126 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001127}
1128
Colin Cross127bb8b2020-12-16 16:46:01 -08001129func (c *Module) IsLlndk() bool {
1130 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001131}
1132
Colin Cross127bb8b2020-12-16 16:46:01 -08001133func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001134 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001135}
1136
Colin Cross1f3f1302021-04-26 18:37:44 -07001137func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001138 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001139 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001140}
1141
Colin Cross5271fea2021-04-27 13:06:04 -07001142func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1143 lib := moduleLibraryInterface(m)
1144 return lib != nil && (lib.hasVendorPublicLibrary())
1145}
1146
1147// IsVendorPublicLibrary returns true for vendor public libraries.
1148func (c *Module) IsVendorPublicLibrary() bool {
1149 return c.VendorProperties.IsVendorPublicLibrary
1150}
1151
Ivan Lozanod7586b62021-04-01 09:49:36 -04001152func (c *Module) HasLlndkStubs() bool {
1153 lib := moduleLibraryInterface(c)
1154 return lib != nil && lib.hasLLNDKStubs()
1155}
1156
1157func (c *Module) StubsVersion() string {
1158 if lib, ok := c.linker.(versionedInterface); ok {
1159 return lib.stubsVersion()
1160 }
1161 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1162}
1163
Colin Cross127bb8b2020-12-16 16:46:01 -08001164// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1165// and does not set llndk.vendor_available: false.
1166func (c *Module) isImplementationForLLNDKPublic() bool {
1167 library, _ := c.library.(*libraryDecorator)
1168 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001169 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001170}
1171
Justin Yunfd9e8042020-12-23 18:23:14 +09001172// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001173func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001174 // Check if VNDK-core-private or VNDK-SP-private
1175 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001176 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001177 }
1178
1179 // Check if LLNDK-private
1180 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001181 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001182 }
1183
1184 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001185}
1186
Ivan Lozano52767be2019-10-18 14:49:46 -07001187func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001188 if vndkdep := c.vndkdep; vndkdep != nil {
1189 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001190 }
1191 return false
1192}
1193
Yi Kong7e53c572018-02-14 18:16:12 +08001194func (c *Module) isPgoCompile() bool {
1195 if pgo := c.pgo; pgo != nil {
1196 return pgo.Properties.PgoCompile
1197 }
1198 return false
1199}
1200
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001201func (c *Module) isNDKStubLibrary() bool {
1202 if _, ok := c.compiler.(*stubDecorator); ok {
1203 return true
1204 }
1205 return false
1206}
1207
Ivan Lozanod7586b62021-04-01 09:49:36 -04001208func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001209 if vndkdep := c.vndkdep; vndkdep != nil {
1210 return vndkdep.isVndkSp()
1211 }
1212 return false
1213}
1214
Ivan Lozanof9e21722020-12-02 09:00:51 -05001215func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001216 if vndkdep := c.vndkdep; vndkdep != nil {
1217 return vndkdep.isVndkExt()
1218 }
1219 return false
1220}
1221
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001222func (c *Module) SubName() string {
1223 return c.Properties.SubName
1224}
1225
Ivan Lozano52767be2019-10-18 14:49:46 -07001226func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001227 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001228}
1229
Logan Chienf3511742017-10-31 18:04:35 +08001230func (c *Module) getVndkExtendsModuleName() string {
1231 if vndkdep := c.vndkdep; vndkdep != nil {
1232 return vndkdep.getVndkExtendsModuleName()
1233 }
1234 return ""
1235}
1236
Jiyong Park25fc6a92018-11-18 18:02:45 +09001237func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001238 if lib := c.library; lib != nil {
1239 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001240 }
1241 return false
1242}
1243
1244func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001245 if lib := c.library; lib != nil {
1246 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001247 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001248 return false
1249}
1250
Colin Cross0477b422020-10-13 18:43:54 -07001251// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1252// the implementation. If it is an implementation library it returns its own name.
1253func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1254 name := ctx.OtherModuleName(c)
1255 if versioned, ok := c.linker.(versionedInterface); ok {
1256 name = versioned.implementationModuleName(name)
1257 }
1258 return name
1259}
1260
Martin Stjernholm2856c662020-12-02 15:03:42 +00001261// Similar to ImplementationModuleName, but uses the Make variant of the module
1262// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1263// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1264// under the premise that the prebuilt module overrides its source counterpart
1265// if it is exposed to Make).
1266func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1267 name := c.BaseModuleName()
1268 if versioned, ok := c.linker.(versionedInterface); ok {
1269 name = versioned.implementationModuleName(name)
1270 }
1271 return name
1272}
1273
Jiyong Park7d55b612021-06-11 17:22:09 +09001274func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001275 return Bool(c.Properties.Bootstrap)
1276}
1277
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001278func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001279 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1280 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1281 return false
1282 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001283 return c.linker != nil && c.linker.nativeCoverage()
1284}
1285
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001286func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001287 if p, ok := c.linker.(SnapshotInterface); ok {
1288 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001289 }
1290 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001291}
1292
Bill Peckham945441c2020-08-31 16:07:58 -07001293func (c *Module) ExcludeFromVendorSnapshot() bool {
1294 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1295}
1296
Jose Galmesf7294582020-11-13 12:07:36 -08001297func (c *Module) ExcludeFromRecoverySnapshot() bool {
1298 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1299}
1300
Jiyong Parkf1194352019-02-25 11:05:47 +09001301func isBionic(name string) bool {
1302 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001303 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001304 return true
1305 }
1306 return false
1307}
1308
Martin Stjernholm279de572019-09-10 23:18:20 +01001309func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001310 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001311 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001312 }
1313 return isBionic(name)
1314}
1315
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001316func (c *Module) XrefCcFiles() android.Paths {
1317 return c.kytheFiles
1318}
1319
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001320func (c *Module) isCfiAssemblySupportEnabled() bool {
1321 return c.sanitize != nil &&
1322 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1323}
1324
Inseob Kim800d1142021-06-14 12:03:51 +09001325func (c *Module) InstallInRoot() bool {
1326 return c.installer != nil && c.installer.installInRoot()
1327}
1328
Colin Crossca860ac2016-01-04 14:34:37 -08001329type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001330 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001331 moduleContextImpl
1332}
1333
Colin Cross37047f12016-12-13 17:06:13 -08001334type depsContext struct {
1335 android.BottomUpMutatorContext
1336 moduleContextImpl
1337}
1338
Colin Crossca860ac2016-01-04 14:34:37 -08001339type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001340 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001341 moduleContextImpl
1342}
1343
1344type moduleContextImpl struct {
1345 mod *Module
1346 ctx BaseModuleContext
1347}
1348
Colin Crossb98c8b02016-07-29 13:44:28 -07001349func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001350 return ctx.mod.toolchain(ctx.ctx)
1351}
1352
1353func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001354 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001355}
1356
1357func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001358 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001359}
1360
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001361func (ctx *moduleContextImpl) testBinary() bool {
1362 return ctx.mod.testBinary()
1363}
1364
Jiyong Park1d1119f2019-07-29 21:27:18 +09001365func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001366 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001367}
1368
Inseob Kim7f283f42020-06-01 21:53:49 +09001369func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001370 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001371}
1372
Inseob Kim1042d292020-06-01 23:23:05 +09001373func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001374 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001375}
1376
Jooyung Hanccce2f22020-03-07 03:45:53 +09001377func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001378 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001379}
1380
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001381func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001382 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001383}
1384
1385func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001386 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001387 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001388 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001389 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001390 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001391 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001392 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001393 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001394 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001395 }
1396 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001397}
1398
Jiyong Parkb35a8192020-08-10 15:59:36 +09001399func (ctx *moduleContextImpl) minSdkVersion() string {
1400 ver := ctx.mod.MinSdkVersion()
1401 if ver == "apex_inherit" && !ctx.isForPlatform() {
1402 ver = ctx.apexSdkVersion().String()
1403 }
1404 if ver == "apex_inherit" || ver == "" {
1405 ver = ctx.sdkVersion()
1406 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001407 // For crt objects, the meaning of min_sdk_version is very different from other types of
1408 // module. For them, min_sdk_version defines the oldest version that the build system will
1409 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1410 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1411 // and min_sdk_version properties of the variants are set to the corresponding version
1412 // numbers. However, the platform (non-sdk) variant of the crt object is left untouched.
1413 // min_sdk_version: 16 doesn't actually mean that the platform variant has to support such
1414 // an old version. Since the variant is for the platform, it's preferred to target the
1415 // latest version.
1416 if ctx.mod.SplitPerApiLevel() && !ctx.isSdkVariant() {
1417 ver = strconv.Itoa(android.FutureApiLevelInt)
1418 }
1419
Jiyong Parkb35a8192020-08-10 15:59:36 +09001420 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1421 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1422 minSdkVersionInt, err2 := strconv.Atoi(ver)
1423 if err == nil && err2 == nil {
1424 if sdkVersionInt < minSdkVersionInt {
1425 return strconv.Itoa(sdkVersionInt)
1426 }
1427 }
1428 return ver
1429}
1430
1431func (ctx *moduleContextImpl) isSdkVariant() bool {
1432 return ctx.mod.IsSdkVariant()
1433}
1434
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001435func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001436 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001437}
Justin Yun8effde42017-06-23 19:24:43 +09001438
Colin Cross95f1ca02020-10-29 20:47:22 -07001439func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1440 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001441}
1442
Colin Cross127bb8b2020-12-16 16:46:01 -08001443func (ctx *moduleContextImpl) IsLlndk() bool {
1444 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001445}
1446
Colin Cross127bb8b2020-12-16 16:46:01 -08001447func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1448 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001449}
1450
Colin Cross127bb8b2020-12-16 16:46:01 -08001451func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1452 return ctx.mod.isImplementationForLLNDKPublic()
1453}
1454
1455func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1456 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001457}
1458
Logan Chienf3511742017-10-31 18:04:35 +08001459func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001460 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001461}
1462
Yi Kong7e53c572018-02-14 18:16:12 +08001463func (ctx *moduleContextImpl) isPgoCompile() bool {
1464 return ctx.mod.isPgoCompile()
1465}
1466
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001467func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1468 return ctx.mod.isNDKStubLibrary()
1469}
1470
Justin Yun8effde42017-06-23 19:24:43 +09001471func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001472 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001473}
1474
Ivan Lozanof9e21722020-12-02 09:00:51 -05001475func (ctx *moduleContextImpl) IsVndkExt() bool {
1476 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001477}
1478
Colin Cross5271fea2021-04-27 13:06:04 -07001479func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1480 return ctx.mod.IsVendorPublicLibrary()
1481}
1482
Vic Yangefd249e2018-11-12 20:19:56 -08001483func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001484 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001485}
1486
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001487func (ctx *moduleContextImpl) selectedStl() string {
1488 if stl := ctx.mod.stl; stl != nil {
1489 return stl.Properties.SelectedStl
1490 }
1491 return ""
1492}
1493
Ivan Lozanobd721262018-11-27 14:33:03 -08001494func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1495 return ctx.mod.linker.useClangLld(actx)
1496}
1497
Colin Crossce75d2c2016-10-06 16:12:58 -07001498func (ctx *moduleContextImpl) baseModuleName() string {
1499 return ctx.mod.ModuleBase.BaseModuleName()
1500}
1501
Logan Chienf3511742017-10-31 18:04:35 +08001502func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1503 return ctx.mod.getVndkExtendsModuleName()
1504}
1505
Logan Chiene274fc92019-12-03 11:18:32 -08001506func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001507 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001508}
1509
Colin Crosse07f2312020-08-13 11:24:56 -07001510func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001511 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001512}
1513
Dan Albertc8060532020-07-22 22:32:17 -07001514func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001515 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001516}
1517
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001518func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001519 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001520}
1521
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001522func (ctx *moduleContextImpl) nativeCoverage() bool {
1523 return ctx.mod.nativeCoverage()
1524}
1525
Colin Cross56a83212020-09-15 18:30:11 -07001526func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1527 return ctx.mod.DirectlyInAnyApex()
1528}
1529
Colin Cross95b07f22020-12-16 11:06:50 -08001530func (ctx *moduleContextImpl) isPreventInstall() bool {
1531 return ctx.mod.Properties.PreventInstall
1532}
1533
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001534func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1535 return ctx.mod.isCfiAssemblySupportEnabled()
1536}
1537
Colin Cross635c3b02016-05-18 15:37:25 -07001538func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001539 return &Module{
1540 hod: hod,
1541 multilib: multilib,
1542 }
1543}
1544
Colin Cross635c3b02016-05-18 15:37:25 -07001545func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001546 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001547 module.features = []feature{
1548 &tidyFeature{},
1549 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001550 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001551 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001552 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001553 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001554 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001555 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001556 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001557 return module
1558}
1559
Colin Crossce75d2c2016-10-06 16:12:58 -07001560func (c *Module) Prebuilt() *android.Prebuilt {
1561 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1562 return p.prebuilt()
1563 }
1564 return nil
1565}
1566
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001567func (c *Module) IsPrebuilt() bool {
1568 return c.Prebuilt() != nil
1569}
1570
Colin Crossce75d2c2016-10-06 16:12:58 -07001571func (c *Module) Name() string {
1572 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001573 if p, ok := c.linker.(interface {
1574 Name(string) string
1575 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001576 name = p.Name(name)
1577 }
1578 return name
1579}
1580
Alex Light3d673592019-01-18 14:37:31 -08001581func (c *Module) Symlinks() []string {
1582 if p, ok := c.installer.(interface {
1583 symlinkList() []string
1584 }); ok {
1585 return p.symlinkList()
1586 }
1587 return nil
1588}
1589
Roland Levillainf89cd092019-07-29 16:22:59 +01001590func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1591 test, ok := c.linker.(testPerSrc)
1592 return ok && test.isAllTestsVariation()
1593}
1594
Chris Parsons216e10a2020-07-09 17:12:52 -04001595func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001596 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001597 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001598 }); ok {
1599 return p.dataPaths()
1600 }
1601 return nil
1602}
1603
Justin Yun5f7f7e82019-11-18 19:52:14 +09001604func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1605 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1606 // "current", it will append the VNDK version to the name suffix.
1607 var vndkVersion string
1608 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001609 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001610 if c.ProductSpecific() {
1611 // If the module is product specific with 'product_specific: true',
1612 // do not add a name suffix because it is a base module.
1613 return ""
1614 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001615 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1616 nameSuffix = productSuffix
1617 } else {
1618 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001619 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001620 }
1621 if vndkVersion == "current" {
1622 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1623 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001624 if c.Properties.VndkVersion != vndkVersion && c.Properties.VndkVersion != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001625 // add version suffix only if the module is using different vndk version than the
1626 // version in product or vendor partition.
1627 nameSuffix += "." + c.Properties.VndkVersion
1628 }
1629 return nameSuffix
1630}
1631
Chris Parsons8d6e4332021-02-22 16:13:50 -05001632func (c *Module) setSubnameProperty(actx android.ModuleContext) {
Inseob Kim64c43952019-08-26 16:52:35 +09001633 c.Properties.SubName = ""
1634
1635 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1636 c.Properties.SubName += nativeBridgeSuffix
1637 }
1638
Colin Cross127bb8b2020-12-16 16:46:01 -08001639 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001640 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001641 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1642 // added for product variant only when we have vendor and product variants with core
1643 // variant. The suffix is not added for vendor-only or product-only module.
1644 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
Colin Cross5271fea2021-04-27 13:06:04 -07001645 } else if c.IsVendorPublicLibrary() {
1646 c.Properties.SubName += vendorPublicLibrarySuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001647 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001648 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1649 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001650 c.Properties.SubName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001651 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1652 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001653 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001654 c.Properties.SubName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001655 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001656 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001657 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001658 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001659 if c.SplitPerApiLevel() {
1660 c.Properties.SubName += "." + c.SdkVersion()
1661 }
Inseob Kim64c43952019-08-26 16:52:35 +09001662 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001663}
1664
1665// Returns true if Bazel was successfully used for the analysis of this module.
1666func (c *Module) maybeGenerateBazelActions(actx android.ModuleContext) bool {
Liz Kammerbdc60992021-02-24 16:55:11 -05001667 bazelModuleLabel := c.GetBazelLabel(actx, c)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001668 bazelActionsUsed := false
Chris Parsonsbab4d7e2021-04-15 17:27:08 -04001669 if c.MixedBuildsEnabled(actx) && c.bazelHandler != nil {
Chris Parsons8d6e4332021-02-22 16:13:50 -05001670 bazelActionsUsed = c.bazelHandler.generateBazelBuildActions(actx, bazelModuleLabel)
1671 }
1672 return bazelActionsUsed
1673}
1674
1675func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1676 // TODO(cparsons): Any logic in this method occurring prior to querying Bazel should be
1677 // requested from Bazel instead.
1678
1679 // Handle the case of a test module split by `test_per_src` mutator.
1680 //
1681 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1682 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1683 // module and return early, as this module does not produce an output file per se.
1684 if c.IsTestPerSrcAllTestsVariation() {
1685 c.outputFile = android.OptionalPath{}
1686 return
1687 }
1688
1689 c.setSubnameProperty(actx)
1690 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1691 if !apexInfo.IsForPlatform() {
1692 c.hideApexVariantFromMake = true
1693 }
1694
Chris Parsonseefc9e62021-04-02 17:36:47 -04001695 c.makeLinkType = GetMakeLinkType(actx, c)
1696
Colin Crossca860ac2016-01-04 14:34:37 -08001697 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001698 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001699 moduleContextImpl: moduleContextImpl{
1700 mod: c,
1701 },
1702 }
1703 ctx.ctx = ctx
1704
Chris Parsons94a0bba2021-06-04 15:03:47 -04001705 if c.maybeGenerateBazelActions(actx) {
1706 c.maybeInstall(ctx, apexInfo)
1707 return
1708 }
1709
Colin Crossf18e1102017-11-16 14:33:08 -08001710 deps := c.depsToPaths(ctx)
1711 if ctx.Failed() {
1712 return
1713 }
1714
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001715 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1716 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1717 }
1718
Colin Crossca860ac2016-01-04 14:34:37 -08001719 flags := Flags{
1720 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001721 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001722 }
Colin Crossca860ac2016-01-04 14:34:37 -08001723 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001724 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001725 }
1726 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001727 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001728 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001729 if c.stl != nil {
1730 flags = c.stl.flags(ctx, flags)
1731 }
Colin Cross16b23492016-01-06 14:41:07 -08001732 if c.sanitize != nil {
1733 flags = c.sanitize.flags(ctx, flags)
1734 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001735 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001736 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001737 }
Stephen Craneba090d12017-05-09 15:44:35 -07001738 if c.lto != nil {
1739 flags = c.lto.flags(ctx, flags)
1740 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001741 if c.pgo != nil {
1742 flags = c.pgo.flags(ctx, flags)
1743 }
Colin Crossca860ac2016-01-04 14:34:37 -08001744 for _, feature := range c.features {
1745 flags = feature.flags(ctx, flags)
1746 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001747 if ctx.Failed() {
1748 return
1749 }
1750
Colin Cross4af21ed2019-11-04 09:37:55 -08001751 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1752 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1753 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001754
Colin Cross4af21ed2019-11-04 09:37:55 -08001755 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001756
1757 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001758 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001759 }
1760 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001761 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001762 }
1763
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001764 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001765 // We need access to all the flags seen by a source file.
1766 if c.sabi != nil {
1767 flags = c.sabi.flags(ctx, flags)
1768 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001769
Colin Cross4af21ed2019-11-04 09:37:55 -08001770 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001771
Colin Crossca860ac2016-01-04 14:34:37 -08001772 // Optimization to reduce size of build.ninja
1773 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001774 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1775 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1776 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1777 flags.Local.CFlags = []string{"$cflags"}
1778 flags.Local.CppFlags = []string{"$cppflags"}
1779 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001780
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001781 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001782 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001783 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001784 if ctx.Failed() {
1785 return
1786 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001787 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001788 }
1789
Colin Crossca860ac2016-01-04 14:34:37 -08001790 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001791 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001792 if ctx.Failed() {
1793 return
1794 }
Colin Cross635c3b02016-05-18 15:37:25 -07001795 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001796
Chris Parsons94a0bba2021-06-04 15:03:47 -04001797 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001798
Jose Galmes6f843bc2020-12-11 13:36:29 -08001799 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
1800 // RECOVERY_SNAPSHOT_VERSION is current.
1801 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001802 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001803 i.collectHeadersForSnapshot(ctx)
1804 }
1805 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001806 }
Colin Cross5049f022015-03-18 13:28:46 -07001807
Chris Parsons94a0bba2021-06-04 15:03:47 -04001808 c.maybeInstall(ctx, apexInfo)
1809}
1810
1811func (c *Module) maybeUnhideFromMake() {
1812 // If a lib is directly included in any of the APEXes or is not available to the
1813 // platform (which is often the case when the stub is provided as a prebuilt),
1814 // unhide the stubs variant having the latest version gets visible to make. In
1815 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1816 // force anything in the make world to link against the stubs library. (unless it
1817 // is explicitly referenced via .bootstrap suffix or the module is marked with
1818 // 'bootstrap: true').
1819 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
1820 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
1821 c.IsStubs() && !c.InVendorRamdisk() {
1822 c.Properties.HideFromMake = false // unhide
1823 // Note: this is still non-installable
1824 }
1825}
1826
1827func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001828 if !proptools.BoolDefault(c.Properties.Installable, true) {
1829 // If the module has been specifically configure to not be installed then
1830 // hide from make as otherwise it will break when running inside make
1831 // as the output path to install will not be specified. Not all uninstallable
1832 // modules can be hidden from make as some are needed for resolving make side
1833 // dependencies.
1834 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001835 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001836 c.SkipInstall()
1837 }
1838
1839 // Still call c.installer.install though, the installs will be stored as PackageSpecs
1840 // to allow using the outputs in a genrule.
1841 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001842 c.installer.install(ctx, c.outputFile.Path())
1843 if ctx.Failed() {
1844 return
Colin Crossca860ac2016-01-04 14:34:37 -08001845 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001846 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001847}
1848
Colin Cross0ea8ba82019-06-06 14:33:29 -07001849func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001850 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05001851 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08001852 }
Colin Crossca860ac2016-01-04 14:34:37 -08001853 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001854}
1855
Colin Crossca860ac2016-01-04 14:34:37 -08001856func (c *Module) begin(ctx BaseModuleContext) {
1857 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001858 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001859 }
Colin Crossca860ac2016-01-04 14:34:37 -08001860 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001861 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001862 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001863 if c.stl != nil {
1864 c.stl.begin(ctx)
1865 }
Colin Cross16b23492016-01-06 14:41:07 -08001866 if c.sanitize != nil {
1867 c.sanitize.begin(ctx)
1868 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001869 if c.coverage != nil {
1870 c.coverage.begin(ctx)
1871 }
Stephen Craneba090d12017-05-09 15:44:35 -07001872 if c.lto != nil {
1873 c.lto.begin(ctx)
1874 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001875 if c.pgo != nil {
1876 c.pgo.begin(ctx)
1877 }
Dan Albert92fe7402020-07-15 13:33:30 -07001878 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001879 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001880 if err != nil {
1881 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001882 c.Properties.Sdk_version = nil
1883 } else {
1884 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001885 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001886 }
Colin Crossca860ac2016-01-04 14:34:37 -08001887}
1888
Colin Cross37047f12016-12-13 17:06:13 -08001889func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001890 deps := Deps{}
1891
1892 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001893 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001894 }
1895 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001896 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001897 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001898 if c.stl != nil {
1899 deps = c.stl.deps(ctx, deps)
1900 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001901 if c.coverage != nil {
1902 deps = c.coverage.deps(ctx, deps)
1903 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001904
Colin Crossb6715442017-10-24 11:13:31 -07001905 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1906 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1907 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1908 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1909 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1910 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001911 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001912
Liz Kammer356f7d42021-01-26 09:18:53 -05001913 // In Bazel conversion mode, we dependency and build validations will occur in Bazel, so there is
1914 // no need to do so in Soong.
1915 if ctx.BazelConversionMode() {
1916 return deps
1917 }
1918
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001919 for _, lib := range deps.ReexportSharedLibHeaders {
1920 if !inList(lib, deps.SharedLibs) {
1921 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1922 }
1923 }
1924
1925 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00001926 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
1927 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 -07001928 }
1929 }
1930
Colin Cross5950f382016-12-13 12:50:57 -08001931 for _, lib := range deps.ReexportHeaderLibHeaders {
1932 if !inList(lib, deps.HeaderLibs) {
1933 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1934 }
1935 }
1936
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001937 for _, gen := range deps.ReexportGeneratedHeaders {
1938 if !inList(gen, deps.GeneratedHeaders) {
1939 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1940 }
1941 }
1942
Colin Crossc99deeb2016-04-11 15:06:20 -07001943 return deps
1944}
1945
Dan Albert7e9d2952016-08-04 13:02:36 -07001946func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001947 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001948 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001949 moduleContextImpl: moduleContextImpl{
1950 mod: c,
1951 },
1952 }
1953 ctx.ctx = ctx
1954
Colin Crossca860ac2016-01-04 14:34:37 -08001955 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001956}
1957
Jiyong Park7ed9de32018-10-15 22:25:07 +09001958// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001959func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001960 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1961 version := name[sharp+1:]
1962 libname := name[:sharp]
1963 return libname, version
1964 }
1965 return name, ""
1966}
1967
Dan Albert92fe7402020-07-15 13:33:30 -07001968func GetCrtVariations(ctx android.BottomUpMutatorContext,
1969 m LinkableInterface) []blueprint.Variation {
1970 if ctx.Os() != android.Android {
1971 return nil
1972 }
1973 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001974 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
1975 minSdkVersion := m.MinSdkVersion()
1976 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
1977 minSdkVersion = m.SdkVersion()
1978 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09001979 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
1980 if err != nil {
1981 ctx.PropertyErrorf("min_sdk_version", err.Error())
1982 }
Dan Albert92fe7402020-07-15 13:33:30 -07001983 return []blueprint.Variation{
1984 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09001985 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07001986 }
1987 }
1988 return []blueprint.Variation{
1989 {Mutator: "sdk", Variation: ""},
1990 }
1991}
1992
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001993func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
1994 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07001995
1996 variations = append([]blueprint.Variation(nil), variations...)
1997
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001998 if version != "" && CanBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07001999 // Version is explicitly specified. i.e. libFoo#30
2000 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002001 if tag, ok := depTag.(libraryDependencyTag); ok {
2002 tag.explicitlyVersioned = true
2003 } else {
2004 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2005 }
Colin Crosse7257d22020-09-24 09:56:18 -07002006 }
Colin Crosse7257d22020-09-24 09:56:18 -07002007
Colin Cross0de8a1e2020-09-18 14:15:30 -07002008 if far {
2009 ctx.AddFarVariationDependencies(variations, depTag, name)
2010 } else {
2011 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002012 }
2013}
2014
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002015func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002016 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002017 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002018 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002019 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2020 // between the modules in the snapshot and the snapshot itself.
2021 var snapshotModule []blueprint.Module
2022 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2023 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2024 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2025 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2026 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002027 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002028 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2029 *snapshotInfo = &snapshot
2030 // republish the snapshot for use in later mutators on this module
2031 actx.SetProvider(SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002032 }
2033 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002034 if *snapshotInfo == nil {
2035 *snapshotInfo = &SnapshotInfo{}
2036 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002037 return **snapshotInfo
2038}
2039
2040func RewriteSnapshotLib(lib string, snapshotMap map[string]string) string {
2041 if snapshot, ok := snapshotMap[lib]; ok {
2042 return snapshot
2043 }
2044
2045 return lib
2046}
2047
2048// RewriteLibs takes a list of names of shared libraries and scans it for three types
2049// of names:
2050//
2051// 1. Name of an NDK library that refers to a prebuilt module.
2052// For each of these, it adds the name of the prebuilt module (which will be in
2053// prebuilts/ndk) to the list of nonvariant libs.
2054// 2. Name of an NDK library that refers to an ndk_library module.
2055// For each of these, it adds the name of the ndk_library module to the list of
2056// variant libs.
2057// 3. Anything else (so anything that isn't an NDK library).
2058// It adds these to the nonvariantLibs list.
2059//
2060// The caller can then know to add the variantLibs dependencies differently from the
2061// nonvariantLibs
2062func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2063 variantLibs = []string{}
2064
2065 nonvariantLibs = []string{}
2066 for _, entry := range list {
2067 // strip #version suffix out
2068 name, _ := StubsLibNameAndVersion(entry)
2069 if c.InRecovery() {
2070 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2071 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2072 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2073 } else if c.UseVndk() {
2074 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2075 } else {
2076 // put name#version back
2077 nonvariantLibs = append(nonvariantLibs, entry)
2078 }
2079 }
2080 return nonvariantLibs, variantLibs
2081}
2082
Colin Cross1e676be2016-10-12 14:38:15 -07002083func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002084 if !c.Enabled() {
2085 return
2086 }
2087
Colin Cross37047f12016-12-13 17:06:13 -08002088 ctx := &depsContext{
2089 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002090 moduleContextImpl: moduleContextImpl{
2091 mod: c,
2092 },
2093 }
2094 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002095
Colin Crossc99deeb2016-04-11 15:06:20 -07002096 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002097
Yo Chiang219968c2020-09-22 18:45:04 +08002098 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2099
Colin Crosse0edaf92021-01-11 17:31:17 -08002100 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002101
Dan Albert914449f2016-06-17 16:45:24 -07002102 variantNdkLibs := []string{}
2103 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002104 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002105 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2106 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2107 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002108
2109 for idx, lib := range deps.RuntimeLibs {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002110 deps.RuntimeLibs[idx] = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002111 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002112 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002113
Colin Cross32ec36c2016-12-15 07:39:51 -08002114 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002115 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002116 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002117 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002118 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002119
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002120 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002121
Jiyong Park1ad8e162020-12-01 23:40:09 +09002122 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002123 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002124 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002125 } else {
2126 actx.AddVariationDependencies(nil, depTag, lib)
2127 }
2128 }
2129
Dan Albertf1d14c72020-07-30 14:32:55 -07002130 if c.isNDKStubLibrary() {
2131 // NDK stubs depend on their implementation because the ABI dumps are
2132 // generated from the implementation library.
2133 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2134 c.ImageVariation(),
2135 blueprint.Variation{Mutator: "link", Variation: "shared"},
2136 ), stubImplementation, c.BaseModuleName())
2137 }
2138
Inseob Kim07def122020-11-23 14:43:02 +09002139 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
2140 // C++ implementation library and one Java implementation library. When a module links against
2141 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
2142 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
2143 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09002144 syspropImplLibraries := syspropImplLibraries(actx.Config())
2145
Jiyong Park5d1598f2019-02-25 22:14:17 +09002146 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002147 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09002148 if impl, ok := syspropImplLibraries[lib]; ok {
2149 lib = impl
2150 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002151
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002152 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002153
Jiyong Park5d1598f2019-02-25 22:14:17 +09002154 actx.AddVariationDependencies([]blueprint.Variation{
2155 {Mutator: "link", Variation: "static"},
2156 }, depTag, lib)
2157 }
2158
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002159 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002160 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002161 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002162 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002163 }
Jiyong Parke3867542020-12-03 17:28:25 +09002164 if inList(lib, deps.ExcludeLibsForApex) {
2165 depTag.excludeInApex = true
2166 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002167
2168 if impl, ok := syspropImplLibraries[lib]; ok {
2169 lib = impl
2170 }
2171
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002172 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002173
Dan Willemsen59339a22018-07-22 21:18:45 -07002174 actx.AddVariationDependencies([]blueprint.Variation{
2175 {Mutator: "link", Variation: "static"},
2176 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002177 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002178
Jooyung Han75568392020-03-20 04:29:24 +09002179 // staticUnwinderDep is treated as staticDep for Q apexes
2180 // so that native libraries/binaries are linked with static unwinder
2181 // because Q libc doesn't have unwinder APIs
2182 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002183 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002184 actx.AddVariationDependencies([]blueprint.Variation{
2185 {Mutator: "link", Variation: "static"},
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002186 }, depTag, RewriteSnapshotLib(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002187 }
2188
Jiyong Park7ed9de32018-10-15 22:25:07 +09002189 // shared lib names without the #version suffix
2190 var sharedLibNames []string
2191
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002192 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002193 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002194 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002195 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002196 }
Jiyong Parke3867542020-12-03 17:28:25 +09002197 if inList(lib, deps.ExcludeLibsForApex) {
2198 depTag.excludeInApex = true
2199 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002200
2201 if impl, ok := syspropImplLibraries[lib]; ok {
2202 lib = impl
2203 }
2204
Jiyong Park73c54ee2019-10-22 20:31:18 +09002205 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002206 sharedLibNames = append(sharedLibNames, name)
2207
Colin Crosse7257d22020-09-24 09:56:18 -07002208 variations := []blueprint.Variation{
2209 {Mutator: "link", Variation: "shared"},
2210 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002211 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002212 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002213
Colin Crossfe9acfe2021-06-14 16:13:03 -07002214 for _, lib := range deps.LateStaticLibs {
2215 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2216 actx.AddVariationDependencies([]blueprint.Variation{
2217 {Mutator: "link", Variation: "static"},
2218 }, depTag, RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
2219 }
2220
Jiyong Park7ed9de32018-10-15 22:25:07 +09002221 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002222 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002223 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2224 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2225 // linking against both the stubs lib and the non-stubs lib at the same time.
2226 continue
2227 }
Colin Cross6e511a92020-07-27 21:26:48 -07002228 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002229 variations := []blueprint.Variation{
2230 {Mutator: "link", Variation: "shared"},
2231 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002232 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002233 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002234
Dan Willemsen59339a22018-07-22 21:18:45 -07002235 actx.AddVariationDependencies([]blueprint.Variation{
2236 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002237 }, dataLibDepTag, deps.DataLibs...)
2238
2239 actx.AddVariationDependencies([]blueprint.Variation{
2240 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002241 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002242
Colin Cross68861832016-07-08 10:41:41 -07002243 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002244
2245 for _, gen := range deps.GeneratedHeaders {
2246 depTag := genHeaderDepTag
2247 if inList(gen, deps.ReexportGeneratedHeaders) {
2248 depTag = genHeaderExportDepTag
2249 }
2250 actx.AddDependency(c, depTag, gen)
2251 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002252
Dan Albert92fe7402020-07-15 13:33:30 -07002253 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002254 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002255 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002256 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002257 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002258 }
Colin Crossc465efd2021-06-11 18:00:04 -07002259 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002260 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002261 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002262 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002263 if deps.DynamicLinker != "" {
2264 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002265 }
Dan Albert914449f2016-06-17 16:45:24 -07002266
2267 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002268
2269 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002270 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002271 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002272 {Mutator: "link", Variation: "shared"},
2273 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002274
2275 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002276 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002277 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002278 {Mutator: "link", Variation: "shared"},
2279 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002280
2281 if vndkdep := c.vndkdep; vndkdep != nil {
2282 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002283 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002284 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002285 {Mutator: "link", Variation: "shared"},
2286 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002287 }
2288 }
Colin Cross6362e272015-10-29 15:25:03 -07002289}
Colin Cross21b9a242015-03-24 14:15:58 -07002290
Colin Crosse40b4ea2018-10-02 22:25:58 -07002291func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002292 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2293 c.beginMutator(ctx)
2294 }
2295}
2296
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002297// Whether a module can link to another module, taking into
2298// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002299func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002300 tag blueprint.DependencyTag) {
2301
2302 switch t := tag.(type) {
2303 case dependencyTag:
2304 if t != vndkExtDepTag {
2305 return
2306 }
2307 case libraryDependencyTag:
2308 default:
2309 return
2310 }
2311
Ivan Lozanof9e21722020-12-02 09:00:51 -05002312 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002313 // Host code is not restricted
2314 return
2315 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002316
2317 // VNDK is cc.Module supported only for now.
2318 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002319 // Though allowed dependency is limited by the image mutator,
2320 // each vendor and product module needs to check link-type
2321 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002322 if ccTo, ok := to.(*Module); ok {
2323 if ccFrom.vndkdep != nil {
2324 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2325 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002326 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002327 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002328 }
2329 return
2330 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002331 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002332 // Platform code can link to anything
2333 return
2334 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002335 if from.InRamdisk() {
2336 // Ramdisk code is not NDK
2337 return
2338 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002339 if from.InVendorRamdisk() {
2340 // Vendor ramdisk code is not NDK
2341 return
2342 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002343 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002344 // Recovery code is not NDK
2345 return
2346 }
Colin Cross31076b32020-10-23 17:22:06 -07002347 if c, ok := to.(*Module); ok {
2348 if c.ToolchainLibrary() {
2349 // These are always allowed
2350 return
2351 }
2352 if c.NdkPrebuiltStl() {
2353 // These are allowed, but they don't set sdk_version
2354 return
2355 }
2356 if c.StubDecorator() {
2357 // These aren't real libraries, but are the stub shared libraries that are included in
2358 // the NDK.
2359 return
2360 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002361 }
Logan Chien834b9a62019-01-14 15:39:03 +08002362
Ivan Lozano52767be2019-10-18 14:49:46 -07002363 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002364 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2365 // to link to libc++ (non-NDK and without sdk_version).
2366 return
2367 }
2368
Ivan Lozano52767be2019-10-18 14:49:46 -07002369 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002370 // NDK code linking to platform code is never okay.
2371 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002372 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002373 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002374 }
2375
2376 // At this point we know we have two NDK libraries, but we need to
2377 // check that we're not linking against anything built against a higher
2378 // API level, as it is only valid to link against older or equivalent
2379 // APIs.
2380
Inseob Kim01a28722018-04-11 09:48:45 +09002381 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002382 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002383 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002384 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002385 // Current can't be linked against by anything else.
2386 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002387 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002388 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002389 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002390 if err != nil {
2391 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002392 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002393 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002394 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002395 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002396 if err != nil {
2397 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002398 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002399 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002400 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002401
Inseob Kim01a28722018-04-11 09:48:45 +09002402 if toApi > fromApi {
2403 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002404 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002405 }
2406 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002407 }
Dan Albert202fe492017-12-15 13:56:59 -08002408
2409 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002410 fromStl := from.SelectedStl()
2411 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002412 if fromStl == "" || toStl == "" {
2413 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002414 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002415 // We can be permissive with the system "STL" since it is only the C++
2416 // ABI layer, but in the future we should make sure that everyone is
2417 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002418 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002419 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002420 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2421 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002422 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002423}
2424
Jooyung Han479ca172020-10-19 18:51:07 +09002425func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2426 if c, ok := ctx.Module().(*Module); ok {
2427 ctx.VisitDirectDeps(func(dep android.Module) {
2428 depTag := ctx.OtherModuleDependencyTag(dep)
2429 ccDep, ok := dep.(LinkableInterface)
2430 if ok {
2431 checkLinkType(ctx, c, ccDep, depTag)
2432 }
2433 })
2434 }
2435}
2436
Jiyong Park5fb8c102018-04-09 12:03:06 +09002437// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002438// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2439// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002440// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002441func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2442 check := func(child, parent android.Module) bool {
2443 to, ok := child.(*Module)
2444 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002445 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002446 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002447
Jooyung Hana70f0672019-01-18 15:20:43 +09002448 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2449 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002450 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002451
Jiyong Park0474e1f2021-01-14 14:26:06 +09002452 // These dependencies are not excercised at runtime. Tracking these will give us
2453 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002454 depTag := ctx.OtherModuleDependencyTag(child)
2455 if IsHeaderDepTag(depTag) {
2456 return false
2457 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002458 if depTag == staticVariantTag {
2459 return false
2460 }
2461 if depTag == stubImplDepTag {
2462 return false
2463 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002464
Justin Yun63e9ec72020-10-29 16:49:43 +09002465 // Even if target lib has no vendor variant, keep checking dependency
2466 // graph in case it depends on vendor_available or product_available
2467 // but not double_loadable transtively.
2468 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002469 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002470 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002471
Jiyong Park0474e1f2021-01-14 14:26:06 +09002472 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2473 // one.
2474 if Bool(to.VendorProperties.Double_loadable) {
2475 return true
2476 }
2477
Ivan Lozanod7586b62021-04-01 09:49:36 -04002478 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002479 return false
2480 }
2481
Jooyung Hana70f0672019-01-18 15:20:43 +09002482 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2483 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002484 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002485 return false
2486 }
2487 if module, ok := ctx.Module().(*Module); ok {
2488 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002489 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002490 ctx.WalkDeps(check)
2491 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002492 }
2493 }
2494}
2495
Colin Crossc99deeb2016-04-11 15:06:20 -07002496// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002497func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002498 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002499
Colin Cross0de8a1e2020-09-18 14:15:30 -07002500 var directStaticDeps []StaticLibraryInfo
2501 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002502
Colin Cross0de8a1e2020-09-18 14:15:30 -07002503 reexportExporter := func(exporter FlagExporterInfo) {
2504 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2505 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2506 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2507 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2508 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002509 }
2510
Jooyung Hande34d232020-07-23 13:04:15 +09002511 // For the dependency from platform to apex, use the latest stubs
2512 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002513 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2514 if !apexInfo.IsForPlatform() {
Jiyong Park4eab21d2021-04-15 15:17:54 +09002515 c.apexSdkVersion = apexInfo.MinSdkVersion
Jooyung Hande34d232020-07-23 13:04:15 +09002516 }
2517
2518 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2519 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2520 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2521 // (b/144430859)
2522 c.apexSdkVersion = android.FutureApiLevel
2523 }
2524
Colin Crossd11fcda2017-10-23 17:59:01 -07002525 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002526 depName := ctx.OtherModuleName(dep)
2527 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002528
Ivan Lozano52767be2019-10-18 14:49:46 -07002529 ccDep, ok := dep.(LinkableInterface)
2530 if !ok {
2531
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002532 // handling for a few module types that aren't cc Module but that are also supported
2533 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002534 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002535 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002536 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2537 genRule.GeneratedSourceFiles()...)
2538 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002539 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002540 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002541 // Support exported headers from a generated_sources dependency
2542 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002543 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002544 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002545 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002546 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002547 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002548 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002549 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002550 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002551 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2552 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002553 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002554 // 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 +09002555 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002556
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002557 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002558 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002559 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002560 }
Colin Crosscef792e2021-06-11 18:01:26 -07002561 case CrtBeginDepTag:
2562 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2563 case CrtEndDepTag:
2564 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002565 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002566 return
2567 }
2568
Colin Crossfe17f6f2019-03-28 19:30:56 -07002569 if depTag == android.ProtoPluginDepTag {
2570 return
2571 }
2572
Colin Crossd11fcda2017-10-23 17:59:01 -07002573 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002574 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2575 return
2576 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002577 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002578 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2579 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002580 return
2581 }
2582
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002583 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002584 // Skip reused objects for stub libraries, they use their own stub object file instead.
2585 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2586 // version mutator, so the stubs variant is created from the shared variant that
2587 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002588 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002589 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2590 objs := staticAnalogue.ReuseObjects
2591 depPaths.Objs = depPaths.Objs.Append(objs)
2592 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2593 reexportExporter(depExporterInfo)
2594 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002595 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002596 }
2597
Colin Cross6e511a92020-07-27 21:26:48 -07002598 linkFile := ccDep.OutputFile()
2599
2600 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2601 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002602 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002603 return
2604 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002605
Jiyong Parke3867542020-12-03 17:28:25 +09002606 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2607 return
2608 }
2609
Colin Cross0de8a1e2020-09-18 14:15:30 -07002610 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002611
Colin Cross6e511a92020-07-27 21:26:48 -07002612 var ptr *android.Paths
2613 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002614
Colin Cross6e511a92020-07-27 21:26:48 -07002615 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002616
Colin Cross6e511a92020-07-27 21:26:48 -07002617 switch {
2618 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002619 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2620 if !ctx.Config().AllowMissingDependencies() {
2621 ctx.ModuleErrorf("module %q is not a header library", depName)
2622 } else {
2623 ctx.AddMissingDependencies([]string{depName})
2624 }
2625 return
2626 }
Colin Cross6e511a92020-07-27 21:26:48 -07002627 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002628 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2629 if !ctx.Config().AllowMissingDependencies() {
2630 ctx.ModuleErrorf("module %q is not a shared library", depName)
2631 } else {
2632 ctx.AddMissingDependencies([]string{depName})
2633 }
2634 return
2635 }
Jiyong Parke3867542020-12-03 17:28:25 +09002636
Jiyong Park7d55b612021-06-11 17:22:09 +09002637 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
2638 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07002639
Jiyong Park1ad8e162020-12-01 23:40:09 +09002640 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2641 // linkFile, depFile, and ptr.
2642 if c.IsStubs() {
2643 break
2644 }
2645
Colin Cross0de8a1e2020-09-18 14:15:30 -07002646 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2647 depFile = sharedLibraryInfo.TableOfContents
2648
Colin Cross6e511a92020-07-27 21:26:48 -07002649 ptr = &depPaths.SharedLibs
2650 switch libDepTag.Order {
2651 case earlyLibraryDependency:
2652 ptr = &depPaths.EarlySharedLibs
2653 depPtr = &depPaths.EarlySharedLibsDeps
2654 case normalLibraryDependency:
2655 ptr = &depPaths.SharedLibs
2656 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002657 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002658 case lateLibraryDependency:
2659 ptr = &depPaths.LateSharedLibs
2660 depPtr = &depPaths.LateSharedLibsDeps
2661 default:
2662 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002663 }
Colin Cross6e511a92020-07-27 21:26:48 -07002664 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002665 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2666 if !ctx.Config().AllowMissingDependencies() {
2667 ctx.ModuleErrorf("module %q is not a static library", depName)
2668 } else {
2669 ctx.AddMissingDependencies([]string{depName})
2670 }
2671 return
2672 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002673
2674 // Stubs lib doesn't link to the static lib dependencies. Don't set
2675 // linkFile, depFile, and ptr.
2676 if c.IsStubs() {
2677 break
2678 }
2679
Colin Cross0de8a1e2020-09-18 14:15:30 -07002680 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2681 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002682 if libDepTag.wholeStatic {
2683 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002684 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2685 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002686 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002687 // This case normally catches prebuilt static
2688 // libraries, but it can also occur when
2689 // AllowMissingDependencies is on and the
2690 // dependencies has no sources of its own
2691 // but has a whole_static_libs dependency
2692 // on a missing library. We want to depend
2693 // on the .a file so that there is something
2694 // in the dependency tree that contains the
2695 // error rule for the missing transitive
2696 // dependency.
2697 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002698 }
Colin Cross6e511a92020-07-27 21:26:48 -07002699 } else {
2700 switch libDepTag.Order {
2701 case earlyLibraryDependency:
2702 panic(fmt.Errorf("early static libs not suppported"))
2703 case normalLibraryDependency:
2704 // static dependencies will be handled separately so they can be ordered
2705 // using transitive dependencies.
2706 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002707 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002708 case lateLibraryDependency:
2709 ptr = &depPaths.LateStaticLibs
2710 default:
2711 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002712 }
2713 }
2714 }
2715
Colin Cross6e511a92020-07-27 21:26:48 -07002716 if libDepTag.static() && !libDepTag.wholeStatic {
2717 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2718 ctx.ModuleErrorf("module %q not a static library", depName)
2719 return
2720 }
Logan Chien43d34c32017-12-20 01:17:32 +08002721
Colin Cross6e511a92020-07-27 21:26:48 -07002722 // When combining coverage files for shared libraries and executables, coverage files
2723 // in static libraries act as if they were whole static libraries. The same goes for
2724 // source based Abi dump files.
2725 if c, ok := ccDep.(*Module); ok {
2726 staticLib := c.linker.(libraryInterface)
2727 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2728 staticLib.objs().coverageFiles...)
2729 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2730 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002731 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002732 // Handle non-CC modules here
2733 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002734 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002735 }
2736 }
2737
Colin Cross6e511a92020-07-27 21:26:48 -07002738 if ptr != nil {
2739 if !linkFile.Valid() {
2740 if !ctx.Config().AllowMissingDependencies() {
2741 ctx.ModuleErrorf("module %q missing output file", depName)
2742 } else {
2743 ctx.AddMissingDependencies([]string{depName})
2744 }
2745 return
2746 }
2747 *ptr = append(*ptr, linkFile.Path())
2748 }
2749
2750 if depPtr != nil {
2751 dep := depFile
2752 if !dep.Valid() {
2753 dep = linkFile
2754 }
2755 *depPtr = append(*depPtr, dep.Path())
2756 }
2757
Colin Cross0de8a1e2020-09-18 14:15:30 -07002758 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2759 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2760 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2761 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2762
2763 if libDepTag.reexportFlags {
2764 reexportExporter(depExporterInfo)
2765 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2766 // Re-exported shared library headers must be included as well since they can help us with type information
2767 // about template instantiations (instantiated from their headers).
2768 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2769 // scripts.
2770 c.sabi.Properties.ReexportedIncludes = append(
2771 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2772 }
2773
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002774 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002775 switch {
2776 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002777 c.Properties.AndroidMkHeaderLibs = append(
2778 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002779 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002780 if lib := moduleLibraryInterface(dep); lib != nil {
2781 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002782 // Add the dependency to the APEX(es) providing the library so that
2783 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002784 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09002785 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07002786 c.Properties.ApexesProvidingSharedLibs = append(
2787 c.Properties.ApexesProvidingSharedLibs, an)
2788 }
2789 }
2790 }
2791
2792 // Note: the order of libs in this list is not important because
2793 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002794 c.Properties.AndroidMkSharedLibs = append(
2795 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002796 // Record BaseLibName for snapshots.
2797 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002798 case libDepTag.static():
2799 if libDepTag.wholeStatic {
2800 c.Properties.AndroidMkWholeStaticLibs = append(
2801 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2802 } else {
2803 c.Properties.AndroidMkStaticLibs = append(
2804 c.Properties.AndroidMkStaticLibs, makeLibName)
2805 }
Justin Yun5e035862021-06-29 20:50:37 +09002806 // Record BaseLibName for snapshots.
2807 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002808 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002809 } else if !c.IsStubs() {
2810 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2811
Colin Cross6e511a92020-07-27 21:26:48 -07002812 switch depTag {
2813 case runtimeDepTag:
2814 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002815 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002816 // Record BaseLibName for snapshots.
2817 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002818 case objDepTag:
2819 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2820 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002821 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002822 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002823 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002824 case dynamicLinkerDepTag:
2825 depPaths.DynamicLinker = linkFile
2826 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002827 }
Colin Crossca860ac2016-01-04 14:34:37 -08002828 })
2829
Jeff Gaston294356f2017-09-27 17:05:30 -07002830 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002831 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2832 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2833 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002834
Colin Crossdd84e052017-05-17 13:44:16 -07002835 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002836 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002837 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2838 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002839 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002840 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2841 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002842 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002843 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002844 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002845
2846 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002847 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002848 }
Colin Crossdd84e052017-05-17 13:44:16 -07002849
Colin Crossca860ac2016-01-04 14:34:37 -08002850 return depPaths
2851}
2852
Jiyong Park7d55b612021-06-11 17:22:09 +09002853// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
2854// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
2855// dependency. The stub variant is selected when the dependency crosses a boundary where each side
2856// has different level of updatability. For example, if a library foo in an APEX depends on a
2857// library bar which provides stable interface and exists in the platform, foo uses the stub variant
2858// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
2859// same APEX as foo, the non-stub variant of bar is used.
2860func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
2861 depName := ctx.OtherModuleName(dep)
2862 depTag := ctx.OtherModuleDependencyTag(dep)
2863 libDepTag, ok := depTag.(libraryDependencyTag)
2864 if !ok || !libDepTag.shared() {
2865 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2866 }
2867
2868 thisModule, ok := ctx.Module().(android.ApexModule)
2869 if !ok {
2870 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
2871 }
2872
2873 useVndk := false
2874 bootstrap := false
2875 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
2876 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
2877 } else {
2878 useVndk = linkable.UseVndk()
2879 bootstrap = linkable.Bootstrap()
2880 }
2881
2882 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2883 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2884 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
2885 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2886
2887 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
2888 useStubs := false
2889
2890 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
2891 if !apexInfo.IsForPlatform() {
2892 // For platform libraries, use current version of LLNDK
2893 // If this is for use_vendor apex we will apply the same rules
2894 // of apex sdk enforcement below to choose right version.
2895 useStubs = true
2896 }
Jiyong Park9477c262021-06-22 20:23:05 +09002897 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
2898 // If not building for APEX or the containing APEX allows the use of
2899 // platform APIs, use stubs only when it is from an APEX (and not from
2900 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
2901 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09002902 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
2903 if useStubs {
2904 // Another exception: if this module is a test for an APEX, then
2905 // it is linked with the non-stub variant of a module in the APEX
2906 // as if this is part of the APEX.
2907 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2908 for _, apexContents := range testFor.ApexContents {
2909 if apexContents.DirectlyInApex(depName) {
2910 useStubs = false
2911 break
2912 }
2913 }
2914 }
2915 if useStubs {
2916 // Yet another exception: If this module and the dependency are
2917 // available to the same APEXes then skip stubs between their
2918 // platform variants. This complements the test_for case above,
2919 // which avoids the stubs on a direct APEX library dependency, by
2920 // avoiding stubs for indirect test dependencies as well.
2921 //
2922 // TODO(b/183882457): This doesn't work if the two libraries have
2923 // only partially overlapping apex_available. For that test_for
2924 // modules would need to be split into APEX variants and resolved
2925 // separately for each APEX they have access to.
2926 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
2927 useStubs = false
2928 }
2929 }
2930 } else {
2931 // If building for APEX, use stubs when the parent is in any APEX that
2932 // the child is not in.
2933 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2934 }
2935
2936 // when to use (unspecified) stubs, use the latest one.
2937 if useStubs {
2938 stubs := sharedLibraryStubsInfo.SharedStubLibraries
2939 toUse := stubs[len(stubs)-1]
2940 sharedLibraryInfo = toUse.SharedLibraryInfo
2941 depExporterInfo = toUse.FlagExporterInfo
2942 }
2943 }
2944 return sharedLibraryInfo, depExporterInfo
2945}
2946
Colin Cross0de8a1e2020-09-18 14:15:30 -07002947// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2948// to match the topological order of the dependency tree, including any static analogues of
2949// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2950// of the transitive dependencies.
2951func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2952 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2953 var staticPaths android.Paths
2954 for _, staticDep := range staticDeps {
2955 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2956 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2957 }
2958 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04002959 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
2960 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002961 }
2962 }
2963 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2964
2965 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2966
2967 // reorder the dependencies based on transitive dependencies
2968 staticPaths = android.FirstUniquePaths(staticPaths)
2969 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2970
2971 if len(orderedStaticPaths) != len(staticPaths) {
2972 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2973 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2974 }
2975
2976 return orderedStaticPaths, transitiveStaticLibs
2977}
2978
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002979// BaseLibName trims known prefixes and suffixes
2980func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07002981 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
2982 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00002983 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07002984 return libName
2985}
2986
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002987func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002988 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08002989 ccDepModule, _ := ccDep.(*Module)
2990 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09002991 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07002992
Justin Yuncbca3732021-02-03 19:24:13 +09002993 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002994 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07002995 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04002996 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09002997 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07002998
Ivan Lozanod1dec542021-05-26 15:33:11 -04002999 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003000 }
3001 }
3002
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003003 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3004 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003005 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3006 // core module instead.
3007 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003008 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003009 // The vendor and product modules in Make will have been renamed to not conflict with the
3010 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003011 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003012 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
3013 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003014 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003015 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003016 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
3017 return libName + recoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003018 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Colin Cross6e511a92020-07-27 21:26:48 -07003019 return libName + nativeBridgeSuffix
3020 } else {
3021 return libName
3022 }
3023}
3024
Colin Crossca860ac2016-01-04 14:34:37 -08003025func (c *Module) InstallInData() bool {
3026 if c.installer == nil {
3027 return false
3028 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003029 return c.installer.inData()
3030}
3031
3032func (c *Module) InstallInSanitizerDir() bool {
3033 if c.installer == nil {
3034 return false
3035 }
3036 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003037 return true
3038 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003039 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003040}
3041
Yifan Hong1b3348d2020-01-21 15:53:22 -08003042func (c *Module) InstallInRamdisk() bool {
3043 return c.InRamdisk()
3044}
3045
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003046func (c *Module) InstallInVendorRamdisk() bool {
3047 return c.InVendorRamdisk()
3048}
3049
Jiyong Parkf9332f12018-02-01 00:54:12 +09003050func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003051 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003052}
3053
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003054func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003055 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003056 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003057 return
3058 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003059 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003060}
3061
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003062func (c *Module) HostToolPath() android.OptionalPath {
3063 if c.installer == nil {
3064 return android.OptionalPath{}
3065 }
3066 return c.installer.hostToolPath()
3067}
3068
Nan Zhangd4e641b2017-07-12 12:55:28 -07003069func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3070 return c.outputFile
3071}
3072
Colin Cross41955e82019-05-29 14:40:35 -07003073func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3074 switch tag {
3075 case "":
3076 if c.outputFile.Valid() {
3077 return android.Paths{c.outputFile.Path()}, nil
3078 }
3079 return android.Paths{}, nil
3080 default:
3081 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003082 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003083}
3084
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003085func (c *Module) static() bool {
3086 if static, ok := c.linker.(interface {
3087 static() bool
3088 }); ok {
3089 return static.static()
3090 }
3091 return false
3092}
3093
Jiyong Park379de2f2018-12-19 02:47:14 +09003094func (c *Module) staticBinary() bool {
3095 if static, ok := c.linker.(interface {
3096 staticBinary() bool
3097 }); ok {
3098 return static.staticBinary()
3099 }
3100 return false
3101}
3102
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003103func (c *Module) testBinary() bool {
3104 if test, ok := c.linker.(interface {
3105 testBinary() bool
3106 }); ok {
3107 return test.testBinary()
3108 }
3109 return false
3110}
3111
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003112// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3113func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003114 if h, ok := c.linker.(interface {
3115 header() bool
3116 }); ok {
3117 return h.header()
3118 }
3119 return false
3120}
3121
Ivan Lozanod7586b62021-04-01 09:49:36 -04003122func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003123 if b, ok := c.linker.(interface {
3124 binary() bool
3125 }); ok {
3126 return b.binary()
3127 }
3128 return false
3129}
3130
Justin Yun5e035862021-06-29 20:50:37 +09003131func (c *Module) StaticExecutable() bool {
3132 if b, ok := c.linker.(*binaryDecorator); ok {
3133 return b.static()
3134 }
3135 return false
3136}
3137
Ivan Lozanod7586b62021-04-01 09:49:36 -04003138func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003139 if o, ok := c.linker.(interface {
3140 object() bool
3141 }); ok {
3142 return o.object()
3143 }
3144 return false
3145}
3146
Ivan Lozanof9e21722020-12-02 09:00:51 -05003147func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003148 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003149 if c.IsLlndk() {
3150 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003151 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003152 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003153 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003154 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003155 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003156 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003157 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003158 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003159 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003160 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003161 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003162 return "native:product"
3163 }
Jooyung Han38002912019-05-16 04:01:54 +09003164 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003165 } else if c.InRamdisk() {
3166 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003167 } else if c.InVendorRamdisk() {
3168 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003169 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003170 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003171 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003172 return "native:ndk:none:none"
3173 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3174 //family, link := getNdkStlFamilyAndLinkType(c)
3175 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003176 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003177 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003178 } else {
3179 return "native:platform"
3180 }
3181}
3182
Jiyong Park9d452992018-10-03 00:38:19 +09003183// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003184// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003185func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003186 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003187 // Stub libs and prebuilt libs in a versioned SDK are not
3188 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07003189 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01003190 } else if _, ok := c.linker.(testPerSrc); ok {
3191 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003192 }
3193 return false
3194}
3195
Jiyong Parka90ca002019-10-07 15:47:24 +09003196func (c *Module) AvailableFor(what string) bool {
3197 if linker, ok := c.linker.(interface {
3198 availableFor(string) bool
3199 }); ok {
3200 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3201 } else {
3202 return c.ApexModuleBase.AvailableFor(what)
3203 }
3204}
3205
Jiyong Park62304bb2020-04-13 16:19:48 +09003206func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003207 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003208}
3209
Colin Crossaede88c2020-08-11 12:17:01 -07003210func (c *Module) UniqueApexVariations() bool {
3211 if u, ok := c.compiler.(interface {
3212 uniqueApexVariations() bool
3213 }); ok {
3214 return u.uniqueApexVariations()
3215 } else {
3216 return false
3217 }
3218}
3219
Paul Duffin0cb37b92020-03-04 14:52:46 +00003220func (c *Module) EverInstallable() bool {
3221 return c.installer != nil &&
3222 // Check to see whether the module is actually ever installable.
3223 c.installer.everInstallable()
3224}
3225
Ivan Lozanod7586b62021-04-01 09:49:36 -04003226func (c *Module) PreventInstall() bool {
3227 return c.Properties.PreventInstall
3228}
3229
3230func (c *Module) Installable() *bool {
3231 return c.Properties.Installable
3232}
3233
3234func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003235 ret := c.EverInstallable() &&
3236 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003237 proptools.BoolDefault(c.Installable(), true) &&
3238 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003239
3240 // The platform variant doesn't need further condition. Apex variants however might not
3241 // be installable because it will likely to be included in the APEX and won't appear
3242 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003243 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003244 return ret
3245 }
3246
3247 // Special case for modules that are configured to be installed to /data, which includes
3248 // test modules. For these modules, both APEX and non-APEX variants are considered as
3249 // installable. This is because even the APEX variants won't be included in the APEX, but
3250 // will anyway be installed to /data/*.
3251 // See b/146995717
3252 if c.InstallInData() {
3253 return ret
3254 }
3255
3256 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003257}
3258
Logan Chien41eabe62019-04-10 13:33:58 +08003259func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3260 if c.linker != nil {
3261 if library, ok := c.linker.(*libraryDecorator); ok {
3262 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3263 }
3264 }
3265}
3266
Jiyong Park45bf82e2020-12-15 22:29:02 +09003267var _ android.ApexModule = (*Module)(nil)
3268
3269// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003270func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003271 depTag := ctx.OtherModuleDependencyTag(dep)
3272 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3273
3274 if cc, ok := dep.(*Module); ok {
3275 if cc.HasStubsVariants() {
3276 if isLibDepTag && libDepTag.shared() {
3277 // dynamic dep to a stubs lib crosses APEX boundary
3278 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003279 }
Colin Cross6e511a92020-07-27 21:26:48 -07003280 if IsRuntimeDepTag(depTag) {
3281 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003282 return false
3283 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003284 }
Zhijun Heec285872021-04-24 10:47:08 -07003285 if cc.IsLlndk() {
3286 return false
3287 }
Colin Crossaac32222020-07-29 12:51:56 -07003288 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003289 // shared_lib dependency from a static lib is considered as crossing
3290 // the APEX boundary because the dependency doesn't actually is
3291 // linked; the dependency is used only during the compilation phase.
3292 return false
3293 }
Jiyong Parke3867542020-12-03 17:28:25 +09003294
3295 if isLibDepTag && libDepTag.excludeInApex {
3296 return false
3297 }
Colin Cross6e511a92020-07-27 21:26:48 -07003298 }
Colin Crossc1b36442021-05-06 13:42:48 -07003299 if depTag == stubImplDepTag {
3300 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003301 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003302 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003303 if depTag == staticVariantTag {
3304 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3305 // actually mean that the static lib (and its dependencies) are copied into the
3306 // APEX.
3307 return false
3308 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003309 return true
3310}
3311
Jiyong Park45bf82e2020-12-15 22:29:02 +09003312// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003313func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3314 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003315 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3316 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3317 return nil
3318 }
3319 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3320 if c.ToolchainLibrary() {
3321 return nil
3322 }
3323 // We don't check for prebuilt modules
3324 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3325 return nil
3326 }
3327 minSdkVersion := c.MinSdkVersion()
3328 if minSdkVersion == "apex_inherit" {
3329 return nil
3330 }
3331 if minSdkVersion == "" {
3332 // JNI libs within APK-in-APEX fall into here
3333 // Those are okay to set sdk_version instead
3334 // We don't have to check if this is a SDK variant because
3335 // non-SDK variant resets sdk_version, which works too.
3336 minSdkVersion = c.SdkVersion()
3337 }
Dan Albertc8060532020-07-22 22:32:17 -07003338 if minSdkVersion == "" {
3339 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3340 }
3341 // Not using nativeApiLevelFromUser because the context here is not
3342 // necessarily a native context.
3343 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003344 if err != nil {
3345 return err
3346 }
Dan Albertc8060532020-07-22 22:32:17 -07003347
3348 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003349 return fmt.Errorf("newer SDK(%v)", ver)
3350 }
3351 return nil
3352}
3353
Paul Duffinb5769c12021-05-12 16:16:51 +01003354// Implements android.ApexModule
3355func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3356 // stub libraries and native bridge libraries are always available to platform
3357 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3358}
3359
Colin Cross2ba19d92015-05-07 15:44:20 -07003360//
Colin Crosscfad1192015-11-02 16:43:11 -08003361// Defaults
3362//
Colin Crossca860ac2016-01-04 14:34:37 -08003363type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003364 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003365 android.DefaultsModuleBase
Liz Kammer3cf52112021-03-31 15:42:03 -04003366 // Included to support setting bazel_module.label for multiple Soong modules to the same Bazel
3367 // target. This is primarily useful for modules that were architecture specific and instead are
3368 // handled in Bazel as a select().
3369 android.BazelModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003370 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003371}
3372
Patrice Arrudac249c712019-03-19 17:00:29 -07003373// cc_defaults provides a set of properties that can be inherited by other cc
3374// modules. A module can use the properties from a cc_defaults using
3375// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3376// merged (when possible) by prepending the default module's values to the
3377// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003378func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003379 return DefaultsFactory()
3380}
3381
Colin Cross36242852017-06-23 15:06:31 -07003382func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003383 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003384
Colin Cross36242852017-06-23 15:06:31 -07003385 module.AddProperties(props...)
3386 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003387 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003388 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003389 &BaseCompilerProperties{},
3390 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003391 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003392 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003393 &StaticProperties{},
3394 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003395 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003396 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003397 &TestProperties{},
3398 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003399 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003400 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003401 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003402 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003403 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003404 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003405 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003406 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003407 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003408 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003409 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003410 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003411 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003412 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3413 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003414 )
Colin Crosscfad1192015-11-02 16:43:11 -08003415
Liz Kammer3cf52112021-03-31 15:42:03 -04003416 // Bazel module must be initialized _before_ Defaults to be included in cc_defaults module.
3417 android.InitBazelModule(module)
Jooyung Hancc372c52019-09-25 15:18:44 +09003418 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003419
3420 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003421}
3422
Jiyong Park2286afd2020-06-16 21:58:53 +09003423func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003424 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003425}
3426
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003427func kytheExtractAllFactory() android.Singleton {
3428 return &kytheExtractAllSingleton{}
3429}
3430
3431type kytheExtractAllSingleton struct {
3432}
3433
3434func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3435 var xrefTargets android.Paths
3436 ctx.VisitAllModules(func(module android.Module) {
3437 if ccModule, ok := module.(xref); ok {
3438 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3439 }
3440 })
3441 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3442 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003443 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003444 }
3445}
3446
Colin Cross06a931b2015-10-28 17:23:31 -07003447var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003448var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003449var BoolPtr = proptools.BoolPtr
3450var String = proptools.String
3451var StringPtr = proptools.StringPtr