blob: 90c0237016533f1e64ffa750ee6241dd61429412 [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 {
Colin Cross635c3b02016-05-18 15:37:25 -0700759 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700760 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900761 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900762 android.SdkBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500763 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700764
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700765 Properties BaseProperties
766 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700767
Colin Crossca860ac2016-01-04 14:34:37 -0800768 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700769 hod android.HostOrDeviceSupported
770 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700771
Paul Duffina0843f62019-12-13 19:50:38 +0000772 // Allowable SdkMemberTypes of this module type.
773 sdkMemberTypes []android.SdkMemberType
774
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500775 // decorator delegates, initialize before calling Init
776 // these may contain module-specific implementations, and effectively allow for custom
777 // type-specific logic. These members may reference different objects or the same object.
778 // Functions of these decorators will be invoked to initialize and register type-specific
779 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500780 compiler compiler
781 linker linker
782 installer installer
783 bazelHandler bazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500784
785 features []feature
786 stl *stl
787 sanitize *sanitize
788 coverage *coverage
789 sabi *sabi
790 vndkdep *vndkdep
791 lto *lto
792 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800793
Colin Cross31076b32020-10-23 17:22:06 -0700794 library libraryInterface
795
Colin Cross635c3b02016-05-18 15:37:25 -0700796 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800797
Colin Crossb98c8b02016-07-29 13:44:28 -0700798 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700799
800 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800801
802 // Flags used to compile this module
803 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700804
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800805 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700806 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900807
808 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800809 // Kythe (source file indexer) paths for this compilation module
810 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900811
812 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700813 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700814
815 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700816}
817
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200818func (c *Module) AddJSONData(d *map[string]interface{}) {
819 c.AndroidModuleBase().AddJSONData(d)
820 (*d)["Cc"] = map[string]interface{}{
821 "SdkVersion": c.SdkVersion(),
822 "MinSdkVersion": c.MinSdkVersion(),
823 "VndkVersion": c.VndkVersion(),
824 "ProductSpecific": c.ProductSpecific(),
825 "SocSpecific": c.SocSpecific(),
826 "DeviceSpecific": c.DeviceSpecific(),
827 "InProduct": c.InProduct(),
828 "InVendor": c.InVendor(),
829 "InRamdisk": c.InRamdisk(),
830 "InVendorRamdisk": c.InVendorRamdisk(),
831 "InRecovery": c.InRecovery(),
832 "VendorAvailable": c.VendorAvailable(),
833 "ProductAvailable": c.ProductAvailable(),
834 "RamdiskAvailable": c.RamdiskAvailable(),
835 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
836 "RecoveryAvailable": c.RecoveryAvailable(),
837 "OdmAvailable": c.OdmAvailable(),
838 "InstallInData": c.InstallInData(),
839 "InstallInRamdisk": c.InstallInRamdisk(),
840 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
841 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
842 "InstallInRecovery": c.InstallInRecovery(),
843 "InstallInRoot": c.InstallInRoot(),
844 "IsVndk": c.IsVndk(),
845 "IsVndkExt": c.IsVndkExt(),
846 "IsVndkPrivate": c.IsVndkPrivate(),
847 "IsVndkSp": c.IsVndkSp(),
848 "IsLlndk": c.IsLlndk(),
849 "IsLlndkPublic": c.IsLlndkPublic(),
850 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
851 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
852 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
853 "ApexSdkVersion": c.apexSdkVersion,
854 "TestFor": c.TestFor(),
855 }
856}
857
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500858func (c *Module) SetPreventInstall() {
859 c.Properties.PreventInstall = true
860}
861
862func (c *Module) SetHideFromMake() {
863 c.Properties.HideFromMake = true
864}
865
Ivan Lozanod7586b62021-04-01 09:49:36 -0400866func (c *Module) HiddenFromMake() bool {
867 return c.Properties.HideFromMake
868}
869
Ivan Lozano52767be2019-10-18 14:49:46 -0700870func (c *Module) Toc() android.OptionalPath {
871 if c.linker != nil {
872 if library, ok := c.linker.(libraryInterface); ok {
873 return library.toc()
874 }
875 }
876 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
877}
878
879func (c *Module) ApiLevel() string {
880 if c.linker != nil {
881 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700882 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700883 }
884 }
885 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
886}
887
888func (c *Module) Static() bool {
889 if c.linker != nil {
890 if library, ok := c.linker.(libraryInterface); ok {
891 return library.static()
892 }
893 }
894 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
895}
896
897func (c *Module) Shared() bool {
898 if c.linker != nil {
899 if library, ok := c.linker.(libraryInterface); ok {
900 return library.shared()
901 }
902 }
903 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
904}
905
906func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000907 if c.stl != nil {
908 return c.stl.Properties.SelectedStl
909 }
910 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700911}
912
913func (c *Module) ToolchainLibrary() bool {
914 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
915 return true
916 }
917 return false
918}
919
920func (c *Module) NdkPrebuiltStl() bool {
921 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
922 return true
923 }
924 return false
925}
926
927func (c *Module) StubDecorator() bool {
928 if _, ok := c.linker.(*stubDecorator); ok {
929 return true
930 }
931 return false
932}
933
934func (c *Module) SdkVersion() string {
935 return String(c.Properties.Sdk_version)
936}
937
Artur Satayev480e25b2020-04-27 18:53:18 +0100938func (c *Module) MinSdkVersion() string {
939 return String(c.Properties.Min_sdk_version)
940}
941
Dan Albert92fe7402020-07-15 13:33:30 -0700942func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700943 if !c.canUseSdk() {
944 return false
945 }
Dan Albert92fe7402020-07-15 13:33:30 -0700946 if linker, ok := c.linker.(*objectLinker); ok {
947 return linker.isCrt()
948 }
949 return false
950}
951
Colin Crossc511bc52020-04-07 16:50:32 +0000952func (c *Module) AlwaysSdk() bool {
953 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
954}
955
Ivan Lozano183a3212019-10-18 14:18:45 -0700956func (c *Module) CcLibrary() bool {
957 if c.linker != nil {
958 if _, ok := c.linker.(*libraryDecorator); ok {
959 return true
960 }
Colin Crossd48fe732020-09-23 20:37:24 -0700961 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
962 return true
963 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700964 }
965 return false
966}
967
968func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700969 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700970 return true
971 }
972 return false
973}
974
Ivan Lozano2b262972019-11-21 12:30:50 -0800975func (c *Module) NonCcVariants() bool {
976 return false
977}
978
Ivan Lozano183a3212019-10-18 14:18:45 -0700979func (c *Module) SetStatic() {
980 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700981 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700982 library.setStatic()
983 return
984 }
985 }
986 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
987}
988
989func (c *Module) SetShared() {
990 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700991 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700992 library.setShared()
993 return
994 }
995 }
996 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
997}
998
999func (c *Module) BuildStaticVariant() bool {
1000 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001001 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001002 return library.buildStatic()
1003 }
1004 }
1005 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1006}
1007
1008func (c *Module) BuildSharedVariant() bool {
1009 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001010 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001011 return library.buildShared()
1012 }
1013 }
1014 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1015}
1016
1017func (c *Module) Module() android.Module {
1018 return c
1019}
1020
Jiyong Parkc20eee32018-09-05 22:36:17 +09001021func (c *Module) OutputFile() android.OptionalPath {
1022 return c.outputFile
1023}
1024
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001025func (c *Module) CoverageFiles() android.Paths {
1026 if c.linker != nil {
1027 if library, ok := c.linker.(libraryInterface); ok {
1028 return library.objs().coverageFiles
1029 }
1030 }
1031 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1032}
1033
Ivan Lozano183a3212019-10-18 14:18:45 -07001034var _ LinkableInterface = (*Module)(nil)
1035
Jiyong Park719b4462019-01-13 00:39:51 +09001036func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001037 if c.linker != nil {
1038 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001039 }
1040 return nil
1041}
1042
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001043func (c *Module) CoverageOutputFile() android.OptionalPath {
1044 if c.linker != nil {
1045 return c.linker.coverageOutputFilePath()
1046 }
1047 return android.OptionalPath{}
1048}
1049
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001050func (c *Module) RelativeInstallPath() string {
1051 if c.installer != nil {
1052 return c.installer.relativeInstallPath()
1053 }
1054 return ""
1055}
1056
Jooyung Han344d5432019-08-23 11:17:39 +09001057func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001058 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001059}
1060
Colin Cross36242852017-06-23 15:06:31 -07001061func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001062 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001063 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001064 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001065 }
1066 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001067 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001068 }
1069 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001070 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001071 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001072 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001073 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001074 }
Colin Cross16b23492016-01-06 14:41:07 -08001075 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001076 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001077 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001078 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001079 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001080 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001081 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001082 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001083 }
Justin Yun8effde42017-06-23 19:24:43 +09001084 if c.vndkdep != nil {
1085 c.AddProperties(c.vndkdep.props()...)
1086 }
Stephen Craneba090d12017-05-09 15:44:35 -07001087 if c.lto != nil {
1088 c.AddProperties(c.lto.props()...)
1089 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001090 if c.pgo != nil {
1091 c.AddProperties(c.pgo.props()...)
1092 }
Colin Crossca860ac2016-01-04 14:34:37 -08001093 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001094 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001095 }
Colin Crossc472d572015-03-17 15:06:21 -07001096
Colin Cross36242852017-06-23 15:06:31 -07001097 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerea6666f2021-02-17 10:17:28 -05001098 android.InitBazelModule(c)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001099 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001100 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001101 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001102
Colin Cross36242852017-06-23 15:06:31 -07001103 return c
Colin Crossc472d572015-03-17 15:06:21 -07001104}
1105
Ivan Lozano52767be2019-10-18 14:49:46 -07001106func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001107 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001108}
1109
Colin Crossc511bc52020-04-07 16:50:32 +00001110func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001111 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1112 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001113}
1114
1115func (c *Module) UseSdk() bool {
1116 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001117 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001118 }
1119 return false
1120}
1121
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001122func (c *Module) isCoverageVariant() bool {
1123 return c.coverage.Properties.IsCoverageVariant
1124}
1125
Colin Cross95f1ca02020-10-29 20:47:22 -07001126func (c *Module) IsNdk(config android.Config) bool {
1127 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001128}
1129
Colin Cross127bb8b2020-12-16 16:46:01 -08001130func (c *Module) IsLlndk() bool {
1131 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001132}
1133
Colin Cross127bb8b2020-12-16 16:46:01 -08001134func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001135 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001136}
1137
Colin Cross1f3f1302021-04-26 18:37:44 -07001138func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001139 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001140 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001141}
1142
Colin Cross5271fea2021-04-27 13:06:04 -07001143func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1144 lib := moduleLibraryInterface(m)
1145 return lib != nil && (lib.hasVendorPublicLibrary())
1146}
1147
1148// IsVendorPublicLibrary returns true for vendor public libraries.
1149func (c *Module) IsVendorPublicLibrary() bool {
1150 return c.VendorProperties.IsVendorPublicLibrary
1151}
1152
Ivan Lozanod7586b62021-04-01 09:49:36 -04001153func (c *Module) HasLlndkStubs() bool {
1154 lib := moduleLibraryInterface(c)
1155 return lib != nil && lib.hasLLNDKStubs()
1156}
1157
1158func (c *Module) StubsVersion() string {
1159 if lib, ok := c.linker.(versionedInterface); ok {
1160 return lib.stubsVersion()
1161 }
1162 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1163}
1164
Colin Cross127bb8b2020-12-16 16:46:01 -08001165// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1166// and does not set llndk.vendor_available: false.
1167func (c *Module) isImplementationForLLNDKPublic() bool {
1168 library, _ := c.library.(*libraryDecorator)
1169 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001170 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001171}
1172
Justin Yunfd9e8042020-12-23 18:23:14 +09001173// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001174func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001175 // Check if VNDK-core-private or VNDK-SP-private
1176 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001177 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001178 }
1179
1180 // Check if LLNDK-private
1181 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001182 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001183 }
1184
1185 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001186}
1187
Ivan Lozano52767be2019-10-18 14:49:46 -07001188func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001189 if vndkdep := c.vndkdep; vndkdep != nil {
1190 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001191 }
1192 return false
1193}
1194
Yi Kong7e53c572018-02-14 18:16:12 +08001195func (c *Module) isPgoCompile() bool {
1196 if pgo := c.pgo; pgo != nil {
1197 return pgo.Properties.PgoCompile
1198 }
1199 return false
1200}
1201
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001202func (c *Module) isNDKStubLibrary() bool {
1203 if _, ok := c.compiler.(*stubDecorator); ok {
1204 return true
1205 }
1206 return false
1207}
1208
Ivan Lozanod7586b62021-04-01 09:49:36 -04001209func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001210 if vndkdep := c.vndkdep; vndkdep != nil {
1211 return vndkdep.isVndkSp()
1212 }
1213 return false
1214}
1215
Ivan Lozanof9e21722020-12-02 09:00:51 -05001216func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001217 if vndkdep := c.vndkdep; vndkdep != nil {
1218 return vndkdep.isVndkExt()
1219 }
1220 return false
1221}
1222
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001223func (c *Module) SubName() string {
1224 return c.Properties.SubName
1225}
1226
Ivan Lozano52767be2019-10-18 14:49:46 -07001227func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001228 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001229}
1230
Logan Chienf3511742017-10-31 18:04:35 +08001231func (c *Module) getVndkExtendsModuleName() string {
1232 if vndkdep := c.vndkdep; vndkdep != nil {
1233 return vndkdep.getVndkExtendsModuleName()
1234 }
1235 return ""
1236}
1237
Jiyong Park25fc6a92018-11-18 18:02:45 +09001238func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001239 if lib := c.library; lib != nil {
1240 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001241 }
1242 return false
1243}
1244
1245func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001246 if lib := c.library; lib != nil {
1247 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001248 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001249 return false
1250}
1251
Colin Cross0477b422020-10-13 18:43:54 -07001252// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1253// the implementation. If it is an implementation library it returns its own name.
1254func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1255 name := ctx.OtherModuleName(c)
1256 if versioned, ok := c.linker.(versionedInterface); ok {
1257 name = versioned.implementationModuleName(name)
1258 }
1259 return name
1260}
1261
Martin Stjernholm2856c662020-12-02 15:03:42 +00001262// Similar to ImplementationModuleName, but uses the Make variant of the module
1263// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1264// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1265// under the premise that the prebuilt module overrides its source counterpart
1266// if it is exposed to Make).
1267func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1268 name := c.BaseModuleName()
1269 if versioned, ok := c.linker.(versionedInterface); ok {
1270 name = versioned.implementationModuleName(name)
1271 }
1272 return name
1273}
1274
Jiyong Park7d55b612021-06-11 17:22:09 +09001275func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001276 return Bool(c.Properties.Bootstrap)
1277}
1278
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001279func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001280 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1281 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1282 return false
1283 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001284 return c.linker != nil && c.linker.nativeCoverage()
1285}
1286
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001287func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001288 if p, ok := c.linker.(SnapshotInterface); ok {
1289 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001290 }
1291 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001292}
1293
Bill Peckham945441c2020-08-31 16:07:58 -07001294func (c *Module) ExcludeFromVendorSnapshot() bool {
1295 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1296}
1297
Jose Galmesf7294582020-11-13 12:07:36 -08001298func (c *Module) ExcludeFromRecoverySnapshot() bool {
1299 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1300}
1301
Jiyong Parkf1194352019-02-25 11:05:47 +09001302func isBionic(name string) bool {
1303 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001304 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001305 return true
1306 }
1307 return false
1308}
1309
Martin Stjernholm279de572019-09-10 23:18:20 +01001310func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001311 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001312 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001313 }
1314 return isBionic(name)
1315}
1316
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001317func (c *Module) XrefCcFiles() android.Paths {
1318 return c.kytheFiles
1319}
1320
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001321func (c *Module) isCfiAssemblySupportEnabled() bool {
1322 return c.sanitize != nil &&
1323 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1324}
1325
Inseob Kim800d1142021-06-14 12:03:51 +09001326func (c *Module) InstallInRoot() bool {
1327 return c.installer != nil && c.installer.installInRoot()
1328}
1329
Colin Crossca860ac2016-01-04 14:34:37 -08001330type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001331 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001332 moduleContextImpl
1333}
1334
Colin Cross37047f12016-12-13 17:06:13 -08001335type depsContext struct {
1336 android.BottomUpMutatorContext
1337 moduleContextImpl
1338}
1339
Colin Crossca860ac2016-01-04 14:34:37 -08001340type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001341 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001342 moduleContextImpl
1343}
1344
1345type moduleContextImpl struct {
1346 mod *Module
1347 ctx BaseModuleContext
1348}
1349
Colin Crossb98c8b02016-07-29 13:44:28 -07001350func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001351 return ctx.mod.toolchain(ctx.ctx)
1352}
1353
1354func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001355 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001356}
1357
1358func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001359 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001360}
1361
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001362func (ctx *moduleContextImpl) testBinary() bool {
1363 return ctx.mod.testBinary()
1364}
1365
Jiyong Park1d1119f2019-07-29 21:27:18 +09001366func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001367 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001368}
1369
Inseob Kim7f283f42020-06-01 21:53:49 +09001370func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001371 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001372}
1373
Inseob Kim1042d292020-06-01 23:23:05 +09001374func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001375 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001376}
1377
Jooyung Hanccce2f22020-03-07 03:45:53 +09001378func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001379 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001380}
1381
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001382func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001383 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001384}
1385
1386func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001387 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001388 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001389 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001390 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001391 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001392 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001393 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001394 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001395 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001396 }
1397 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001398}
1399
Jiyong Parkb35a8192020-08-10 15:59:36 +09001400func (ctx *moduleContextImpl) minSdkVersion() string {
1401 ver := ctx.mod.MinSdkVersion()
1402 if ver == "apex_inherit" && !ctx.isForPlatform() {
1403 ver = ctx.apexSdkVersion().String()
1404 }
1405 if ver == "apex_inherit" || ver == "" {
1406 ver = ctx.sdkVersion()
1407 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001408 // For crt objects, the meaning of min_sdk_version is very different from other types of
1409 // module. For them, min_sdk_version defines the oldest version that the build system will
1410 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1411 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1412 // and min_sdk_version properties of the variants are set to the corresponding version
1413 // numbers. However, the platform (non-sdk) variant of the crt object is left untouched.
1414 // min_sdk_version: 16 doesn't actually mean that the platform variant has to support such
1415 // an old version. Since the variant is for the platform, it's preferred to target the
1416 // latest version.
1417 if ctx.mod.SplitPerApiLevel() && !ctx.isSdkVariant() {
1418 ver = strconv.Itoa(android.FutureApiLevelInt)
1419 }
1420
Jiyong Parkb35a8192020-08-10 15:59:36 +09001421 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1422 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1423 minSdkVersionInt, err2 := strconv.Atoi(ver)
1424 if err == nil && err2 == nil {
1425 if sdkVersionInt < minSdkVersionInt {
1426 return strconv.Itoa(sdkVersionInt)
1427 }
1428 }
1429 return ver
1430}
1431
1432func (ctx *moduleContextImpl) isSdkVariant() bool {
1433 return ctx.mod.IsSdkVariant()
1434}
1435
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001436func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001437 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001438}
Justin Yun8effde42017-06-23 19:24:43 +09001439
Colin Cross95f1ca02020-10-29 20:47:22 -07001440func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1441 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001442}
1443
Colin Cross127bb8b2020-12-16 16:46:01 -08001444func (ctx *moduleContextImpl) IsLlndk() bool {
1445 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001446}
1447
Colin Cross127bb8b2020-12-16 16:46:01 -08001448func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1449 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001450}
1451
Colin Cross127bb8b2020-12-16 16:46:01 -08001452func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1453 return ctx.mod.isImplementationForLLNDKPublic()
1454}
1455
1456func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1457 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001458}
1459
Logan Chienf3511742017-10-31 18:04:35 +08001460func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001461 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001462}
1463
Yi Kong7e53c572018-02-14 18:16:12 +08001464func (ctx *moduleContextImpl) isPgoCompile() bool {
1465 return ctx.mod.isPgoCompile()
1466}
1467
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001468func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1469 return ctx.mod.isNDKStubLibrary()
1470}
1471
Justin Yun8effde42017-06-23 19:24:43 +09001472func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001473 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001474}
1475
Ivan Lozanof9e21722020-12-02 09:00:51 -05001476func (ctx *moduleContextImpl) IsVndkExt() bool {
1477 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001478}
1479
Colin Cross5271fea2021-04-27 13:06:04 -07001480func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1481 return ctx.mod.IsVendorPublicLibrary()
1482}
1483
Vic Yangefd249e2018-11-12 20:19:56 -08001484func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001485 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001486}
1487
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001488func (ctx *moduleContextImpl) selectedStl() string {
1489 if stl := ctx.mod.stl; stl != nil {
1490 return stl.Properties.SelectedStl
1491 }
1492 return ""
1493}
1494
Ivan Lozanobd721262018-11-27 14:33:03 -08001495func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1496 return ctx.mod.linker.useClangLld(actx)
1497}
1498
Colin Crossce75d2c2016-10-06 16:12:58 -07001499func (ctx *moduleContextImpl) baseModuleName() string {
1500 return ctx.mod.ModuleBase.BaseModuleName()
1501}
1502
Logan Chienf3511742017-10-31 18:04:35 +08001503func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1504 return ctx.mod.getVndkExtendsModuleName()
1505}
1506
Logan Chiene274fc92019-12-03 11:18:32 -08001507func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001508 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001509}
1510
Colin Crosse07f2312020-08-13 11:24:56 -07001511func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001512 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001513}
1514
Dan Albertc8060532020-07-22 22:32:17 -07001515func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001516 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001517}
1518
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001519func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001520 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001521}
1522
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001523func (ctx *moduleContextImpl) nativeCoverage() bool {
1524 return ctx.mod.nativeCoverage()
1525}
1526
Colin Cross56a83212020-09-15 18:30:11 -07001527func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1528 return ctx.mod.DirectlyInAnyApex()
1529}
1530
Colin Cross95b07f22020-12-16 11:06:50 -08001531func (ctx *moduleContextImpl) isPreventInstall() bool {
1532 return ctx.mod.Properties.PreventInstall
1533}
1534
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001535func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1536 return ctx.mod.isCfiAssemblySupportEnabled()
1537}
1538
Colin Cross635c3b02016-05-18 15:37:25 -07001539func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001540 return &Module{
1541 hod: hod,
1542 multilib: multilib,
1543 }
1544}
1545
Colin Cross635c3b02016-05-18 15:37:25 -07001546func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001547 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001548 module.features = []feature{
1549 &tidyFeature{},
1550 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001551 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001552 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001553 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001554 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001555 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001556 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001557 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001558 return module
1559}
1560
Colin Crossce75d2c2016-10-06 16:12:58 -07001561func (c *Module) Prebuilt() *android.Prebuilt {
1562 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1563 return p.prebuilt()
1564 }
1565 return nil
1566}
1567
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001568func (c *Module) IsPrebuilt() bool {
1569 return c.Prebuilt() != nil
1570}
1571
Colin Crossce75d2c2016-10-06 16:12:58 -07001572func (c *Module) Name() string {
1573 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001574 if p, ok := c.linker.(interface {
1575 Name(string) string
1576 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001577 name = p.Name(name)
1578 }
1579 return name
1580}
1581
Alex Light3d673592019-01-18 14:37:31 -08001582func (c *Module) Symlinks() []string {
1583 if p, ok := c.installer.(interface {
1584 symlinkList() []string
1585 }); ok {
1586 return p.symlinkList()
1587 }
1588 return nil
1589}
1590
Roland Levillainf89cd092019-07-29 16:22:59 +01001591func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1592 test, ok := c.linker.(testPerSrc)
1593 return ok && test.isAllTestsVariation()
1594}
1595
Chris Parsons216e10a2020-07-09 17:12:52 -04001596func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001597 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001598 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001599 }); ok {
1600 return p.dataPaths()
1601 }
1602 return nil
1603}
1604
Justin Yun5f7f7e82019-11-18 19:52:14 +09001605func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1606 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1607 // "current", it will append the VNDK version to the name suffix.
1608 var vndkVersion string
1609 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001610 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001611 if c.ProductSpecific() {
1612 // If the module is product specific with 'product_specific: true',
1613 // do not add a name suffix because it is a base module.
1614 return ""
1615 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001616 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1617 nameSuffix = productSuffix
1618 } else {
1619 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001620 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001621 }
1622 if vndkVersion == "current" {
1623 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1624 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001625 if c.Properties.VndkVersion != vndkVersion && c.Properties.VndkVersion != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001626 // add version suffix only if the module is using different vndk version than the
1627 // version in product or vendor partition.
1628 nameSuffix += "." + c.Properties.VndkVersion
1629 }
1630 return nameSuffix
1631}
1632
Chris Parsons8d6e4332021-02-22 16:13:50 -05001633func (c *Module) setSubnameProperty(actx android.ModuleContext) {
Inseob Kim64c43952019-08-26 16:52:35 +09001634 c.Properties.SubName = ""
1635
1636 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1637 c.Properties.SubName += nativeBridgeSuffix
1638 }
1639
Colin Cross127bb8b2020-12-16 16:46:01 -08001640 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001641 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001642 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1643 // added for product variant only when we have vendor and product variants with core
1644 // variant. The suffix is not added for vendor-only or product-only module.
1645 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
Colin Cross5271fea2021-04-27 13:06:04 -07001646 } else if c.IsVendorPublicLibrary() {
1647 c.Properties.SubName += vendorPublicLibrarySuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001648 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001649 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1650 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001651 c.Properties.SubName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001652 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1653 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001654 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001655 c.Properties.SubName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001656 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001657 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001658 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001659 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001660 if c.SplitPerApiLevel() {
1661 c.Properties.SubName += "." + c.SdkVersion()
1662 }
Inseob Kim64c43952019-08-26 16:52:35 +09001663 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001664}
1665
1666// Returns true if Bazel was successfully used for the analysis of this module.
1667func (c *Module) maybeGenerateBazelActions(actx android.ModuleContext) bool {
Liz Kammerbdc60992021-02-24 16:55:11 -05001668 bazelModuleLabel := c.GetBazelLabel(actx, c)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001669 bazelActionsUsed := false
Chris Parsonsbab4d7e2021-04-15 17:27:08 -04001670 if c.MixedBuildsEnabled(actx) && c.bazelHandler != nil {
Chris Parsons8d6e4332021-02-22 16:13:50 -05001671 bazelActionsUsed = c.bazelHandler.generateBazelBuildActions(actx, bazelModuleLabel)
1672 }
1673 return bazelActionsUsed
1674}
1675
1676func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1677 // TODO(cparsons): Any logic in this method occurring prior to querying Bazel should be
1678 // requested from Bazel instead.
1679
1680 // Handle the case of a test module split by `test_per_src` mutator.
1681 //
1682 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1683 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1684 // module and return early, as this module does not produce an output file per se.
1685 if c.IsTestPerSrcAllTestsVariation() {
1686 c.outputFile = android.OptionalPath{}
1687 return
1688 }
1689
1690 c.setSubnameProperty(actx)
1691 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1692 if !apexInfo.IsForPlatform() {
1693 c.hideApexVariantFromMake = true
1694 }
1695
Chris Parsonseefc9e62021-04-02 17:36:47 -04001696 c.makeLinkType = GetMakeLinkType(actx, c)
1697
Colin Crossca860ac2016-01-04 14:34:37 -08001698 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001699 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001700 moduleContextImpl: moduleContextImpl{
1701 mod: c,
1702 },
1703 }
1704 ctx.ctx = ctx
1705
Chris Parsons94a0bba2021-06-04 15:03:47 -04001706 if c.maybeGenerateBazelActions(actx) {
1707 c.maybeInstall(ctx, apexInfo)
1708 return
1709 }
1710
Colin Crossf18e1102017-11-16 14:33:08 -08001711 deps := c.depsToPaths(ctx)
1712 if ctx.Failed() {
1713 return
1714 }
1715
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001716 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1717 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1718 }
1719
Colin Crossca860ac2016-01-04 14:34:37 -08001720 flags := Flags{
1721 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001722 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001723 }
Colin Crossca860ac2016-01-04 14:34:37 -08001724 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001725 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001726 }
1727 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001728 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001729 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001730 if c.stl != nil {
1731 flags = c.stl.flags(ctx, flags)
1732 }
Colin Cross16b23492016-01-06 14:41:07 -08001733 if c.sanitize != nil {
1734 flags = c.sanitize.flags(ctx, flags)
1735 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001736 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001737 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001738 }
Stephen Craneba090d12017-05-09 15:44:35 -07001739 if c.lto != nil {
1740 flags = c.lto.flags(ctx, flags)
1741 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001742 if c.pgo != nil {
1743 flags = c.pgo.flags(ctx, flags)
1744 }
Colin Crossca860ac2016-01-04 14:34:37 -08001745 for _, feature := range c.features {
1746 flags = feature.flags(ctx, flags)
1747 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001748 if ctx.Failed() {
1749 return
1750 }
1751
Colin Cross4af21ed2019-11-04 09:37:55 -08001752 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1753 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1754 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001755
Colin Cross4af21ed2019-11-04 09:37:55 -08001756 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001757
1758 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001759 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001760 }
1761 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001762 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001763 }
1764
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001765 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001766 // We need access to all the flags seen by a source file.
1767 if c.sabi != nil {
1768 flags = c.sabi.flags(ctx, flags)
1769 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001770
Colin Cross4af21ed2019-11-04 09:37:55 -08001771 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001772
Colin Crossca860ac2016-01-04 14:34:37 -08001773 // Optimization to reduce size of build.ninja
1774 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001775 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1776 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1777 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1778 flags.Local.CFlags = []string{"$cflags"}
1779 flags.Local.CppFlags = []string{"$cppflags"}
1780 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001781
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001782 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001783 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001784 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001785 if ctx.Failed() {
1786 return
1787 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001788 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001789 }
1790
Colin Crossca860ac2016-01-04 14:34:37 -08001791 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001792 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001793 if ctx.Failed() {
1794 return
1795 }
Colin Cross635c3b02016-05-18 15:37:25 -07001796 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001797
Chris Parsons94a0bba2021-06-04 15:03:47 -04001798 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001799
Jose Galmes6f843bc2020-12-11 13:36:29 -08001800 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
1801 // RECOVERY_SNAPSHOT_VERSION is current.
1802 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001803 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001804 i.collectHeadersForSnapshot(ctx)
1805 }
1806 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001807 }
Colin Cross5049f022015-03-18 13:28:46 -07001808
Chris Parsons94a0bba2021-06-04 15:03:47 -04001809 c.maybeInstall(ctx, apexInfo)
1810}
1811
1812func (c *Module) maybeUnhideFromMake() {
1813 // If a lib is directly included in any of the APEXes or is not available to the
1814 // platform (which is often the case when the stub is provided as a prebuilt),
1815 // unhide the stubs variant having the latest version gets visible to make. In
1816 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1817 // force anything in the make world to link against the stubs library. (unless it
1818 // is explicitly referenced via .bootstrap suffix or the module is marked with
1819 // 'bootstrap: true').
1820 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
1821 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
1822 c.IsStubs() && !c.InVendorRamdisk() {
1823 c.Properties.HideFromMake = false // unhide
1824 // Note: this is still non-installable
1825 }
1826}
1827
1828func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001829 if !proptools.BoolDefault(c.Properties.Installable, true) {
1830 // If the module has been specifically configure to not be installed then
1831 // hide from make as otherwise it will break when running inside make
1832 // as the output path to install will not be specified. Not all uninstallable
1833 // modules can be hidden from make as some are needed for resolving make side
1834 // dependencies.
1835 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001836 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001837 c.SkipInstall()
1838 }
1839
1840 // Still call c.installer.install though, the installs will be stored as PackageSpecs
1841 // to allow using the outputs in a genrule.
1842 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001843 c.installer.install(ctx, c.outputFile.Path())
1844 if ctx.Failed() {
1845 return
Colin Crossca860ac2016-01-04 14:34:37 -08001846 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001847 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001848}
1849
Colin Cross0ea8ba82019-06-06 14:33:29 -07001850func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001851 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05001852 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08001853 }
Colin Crossca860ac2016-01-04 14:34:37 -08001854 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001855}
1856
Colin Crossca860ac2016-01-04 14:34:37 -08001857func (c *Module) begin(ctx BaseModuleContext) {
1858 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001859 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001860 }
Colin Crossca860ac2016-01-04 14:34:37 -08001861 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001862 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001863 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001864 if c.stl != nil {
1865 c.stl.begin(ctx)
1866 }
Colin Cross16b23492016-01-06 14:41:07 -08001867 if c.sanitize != nil {
1868 c.sanitize.begin(ctx)
1869 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001870 if c.coverage != nil {
1871 c.coverage.begin(ctx)
1872 }
Stephen Craneba090d12017-05-09 15:44:35 -07001873 if c.lto != nil {
1874 c.lto.begin(ctx)
1875 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001876 if c.pgo != nil {
1877 c.pgo.begin(ctx)
1878 }
Dan Albert92fe7402020-07-15 13:33:30 -07001879 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001880 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001881 if err != nil {
1882 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001883 c.Properties.Sdk_version = nil
1884 } else {
1885 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001886 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001887 }
Colin Crossca860ac2016-01-04 14:34:37 -08001888}
1889
Colin Cross37047f12016-12-13 17:06:13 -08001890func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001891 deps := Deps{}
1892
1893 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001894 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001895 }
1896 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001897 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001898 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001899 if c.stl != nil {
1900 deps = c.stl.deps(ctx, deps)
1901 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001902 if c.coverage != nil {
1903 deps = c.coverage.deps(ctx, deps)
1904 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001905
Colin Crossb6715442017-10-24 11:13:31 -07001906 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1907 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1908 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1909 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1910 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1911 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001912 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001913
Liz Kammer356f7d42021-01-26 09:18:53 -05001914 // In Bazel conversion mode, we dependency and build validations will occur in Bazel, so there is
1915 // no need to do so in Soong.
1916 if ctx.BazelConversionMode() {
1917 return deps
1918 }
1919
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001920 for _, lib := range deps.ReexportSharedLibHeaders {
1921 if !inList(lib, deps.SharedLibs) {
1922 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1923 }
1924 }
1925
1926 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00001927 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
1928 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 -07001929 }
1930 }
1931
Colin Cross5950f382016-12-13 12:50:57 -08001932 for _, lib := range deps.ReexportHeaderLibHeaders {
1933 if !inList(lib, deps.HeaderLibs) {
1934 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1935 }
1936 }
1937
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001938 for _, gen := range deps.ReexportGeneratedHeaders {
1939 if !inList(gen, deps.GeneratedHeaders) {
1940 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1941 }
1942 }
1943
Colin Crossc99deeb2016-04-11 15:06:20 -07001944 return deps
1945}
1946
Dan Albert7e9d2952016-08-04 13:02:36 -07001947func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001948 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001949 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001950 moduleContextImpl: moduleContextImpl{
1951 mod: c,
1952 },
1953 }
1954 ctx.ctx = ctx
1955
Colin Crossca860ac2016-01-04 14:34:37 -08001956 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001957}
1958
Jiyong Park7ed9de32018-10-15 22:25:07 +09001959// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001960func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001961 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1962 version := name[sharp+1:]
1963 libname := name[:sharp]
1964 return libname, version
1965 }
1966 return name, ""
1967}
1968
Dan Albert92fe7402020-07-15 13:33:30 -07001969func GetCrtVariations(ctx android.BottomUpMutatorContext,
1970 m LinkableInterface) []blueprint.Variation {
1971 if ctx.Os() != android.Android {
1972 return nil
1973 }
1974 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001975 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
1976 minSdkVersion := m.MinSdkVersion()
1977 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
1978 minSdkVersion = m.SdkVersion()
1979 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09001980 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
1981 if err != nil {
1982 ctx.PropertyErrorf("min_sdk_version", err.Error())
1983 }
Dan Albert92fe7402020-07-15 13:33:30 -07001984 return []blueprint.Variation{
1985 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09001986 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07001987 }
1988 }
1989 return []blueprint.Variation{
1990 {Mutator: "sdk", Variation: ""},
1991 }
1992}
1993
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001994func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
1995 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07001996
1997 variations = append([]blueprint.Variation(nil), variations...)
1998
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001999 if version != "" && CanBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002000 // Version is explicitly specified. i.e. libFoo#30
2001 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002002 if tag, ok := depTag.(libraryDependencyTag); ok {
2003 tag.explicitlyVersioned = true
2004 } else {
2005 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2006 }
Colin Crosse7257d22020-09-24 09:56:18 -07002007 }
Colin Crosse7257d22020-09-24 09:56:18 -07002008
Colin Cross0de8a1e2020-09-18 14:15:30 -07002009 if far {
2010 ctx.AddFarVariationDependencies(variations, depTag, name)
2011 } else {
2012 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002013 }
2014}
2015
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002016func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
2017 // Only modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
2018 // SnapshotInfo, which provides no mappings.
2019 if *snapshotInfo == nil {
2020 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2021 // between the modules in the snapshot and the snapshot itself.
2022 var snapshotModule []blueprint.Module
2023 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2024 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2025 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2026 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2027 }
2028 if len(snapshotModule) > 0 {
2029 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2030 *snapshotInfo = &snapshot
2031 // republish the snapshot for use in later mutators on this module
2032 actx.SetProvider(SnapshotInfoProvider, snapshot)
2033 } else {
2034 *snapshotInfo = &SnapshotInfo{}
2035 }
2036 }
2037
2038 return **snapshotInfo
2039}
2040
2041func RewriteSnapshotLib(lib string, snapshotMap map[string]string) string {
2042 if snapshot, ok := snapshotMap[lib]; ok {
2043 return snapshot
2044 }
2045
2046 return lib
2047}
2048
2049// RewriteLibs takes a list of names of shared libraries and scans it for three types
2050// of names:
2051//
2052// 1. Name of an NDK library that refers to a prebuilt module.
2053// For each of these, it adds the name of the prebuilt module (which will be in
2054// prebuilts/ndk) to the list of nonvariant libs.
2055// 2. Name of an NDK library that refers to an ndk_library module.
2056// For each of these, it adds the name of the ndk_library module to the list of
2057// variant libs.
2058// 3. Anything else (so anything that isn't an NDK library).
2059// It adds these to the nonvariantLibs list.
2060//
2061// The caller can then know to add the variantLibs dependencies differently from the
2062// nonvariantLibs
2063func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2064 variantLibs = []string{}
2065
2066 nonvariantLibs = []string{}
2067 for _, entry := range list {
2068 // strip #version suffix out
2069 name, _ := StubsLibNameAndVersion(entry)
2070 if c.InRecovery() {
2071 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2072 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2073 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2074 } else if c.UseVndk() {
2075 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2076 } else {
2077 // put name#version back
2078 nonvariantLibs = append(nonvariantLibs, entry)
2079 }
2080 }
2081 return nonvariantLibs, variantLibs
2082}
2083
Colin Cross1e676be2016-10-12 14:38:15 -07002084func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002085 if !c.Enabled() {
2086 return
2087 }
2088
Colin Cross37047f12016-12-13 17:06:13 -08002089 ctx := &depsContext{
2090 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002091 moduleContextImpl: moduleContextImpl{
2092 mod: c,
2093 },
2094 }
2095 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002096
Colin Crossc99deeb2016-04-11 15:06:20 -07002097 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002098
Yo Chiang219968c2020-09-22 18:45:04 +08002099 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2100
Colin Crosse0edaf92021-01-11 17:31:17 -08002101 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002102
Dan Albert914449f2016-06-17 16:45:24 -07002103 variantNdkLibs := []string{}
2104 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002105 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002106 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2107 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2108 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002109
2110 for idx, lib := range deps.RuntimeLibs {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002111 deps.RuntimeLibs[idx] = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002112 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002113 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002114
Colin Cross32ec36c2016-12-15 07:39:51 -08002115 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002116 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002117 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002118 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002119 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002120
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002121 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002122
Jiyong Park1ad8e162020-12-01 23:40:09 +09002123 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002124 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002125 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002126 } else {
2127 actx.AddVariationDependencies(nil, depTag, lib)
2128 }
2129 }
2130
Dan Albertf1d14c72020-07-30 14:32:55 -07002131 if c.isNDKStubLibrary() {
2132 // NDK stubs depend on their implementation because the ABI dumps are
2133 // generated from the implementation library.
2134 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2135 c.ImageVariation(),
2136 blueprint.Variation{Mutator: "link", Variation: "shared"},
2137 ), stubImplementation, c.BaseModuleName())
2138 }
2139
Inseob Kim07def122020-11-23 14:43:02 +09002140 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
2141 // C++ implementation library and one Java implementation library. When a module links against
2142 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
2143 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
2144 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09002145 syspropImplLibraries := syspropImplLibraries(actx.Config())
2146
Jiyong Park5d1598f2019-02-25 22:14:17 +09002147 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002148 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09002149 if impl, ok := syspropImplLibraries[lib]; ok {
2150 lib = impl
2151 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002152
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002153 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002154
Jiyong Park5d1598f2019-02-25 22:14:17 +09002155 actx.AddVariationDependencies([]blueprint.Variation{
2156 {Mutator: "link", Variation: "static"},
2157 }, depTag, lib)
2158 }
2159
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002160 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002161 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002162 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002163 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002164 }
Jiyong Parke3867542020-12-03 17:28:25 +09002165 if inList(lib, deps.ExcludeLibsForApex) {
2166 depTag.excludeInApex = true
2167 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002168
2169 if impl, ok := syspropImplLibraries[lib]; ok {
2170 lib = impl
2171 }
2172
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002173 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002174
Dan Willemsen59339a22018-07-22 21:18:45 -07002175 actx.AddVariationDependencies([]blueprint.Variation{
2176 {Mutator: "link", Variation: "static"},
2177 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002178 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002179
Jooyung Han75568392020-03-20 04:29:24 +09002180 // staticUnwinderDep is treated as staticDep for Q apexes
2181 // so that native libraries/binaries are linked with static unwinder
2182 // because Q libc doesn't have unwinder APIs
2183 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002184 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002185 actx.AddVariationDependencies([]blueprint.Variation{
2186 {Mutator: "link", Variation: "static"},
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002187 }, depTag, RewriteSnapshotLib(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002188 }
2189
Jiyong Park7ed9de32018-10-15 22:25:07 +09002190 // shared lib names without the #version suffix
2191 var sharedLibNames []string
2192
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002193 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002194 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002195 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002196 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002197 }
Jiyong Parke3867542020-12-03 17:28:25 +09002198 if inList(lib, deps.ExcludeLibsForApex) {
2199 depTag.excludeInApex = true
2200 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002201
2202 if impl, ok := syspropImplLibraries[lib]; ok {
2203 lib = impl
2204 }
2205
Jiyong Park73c54ee2019-10-22 20:31:18 +09002206 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002207 sharedLibNames = append(sharedLibNames, name)
2208
Colin Crosse7257d22020-09-24 09:56:18 -07002209 variations := []blueprint.Variation{
2210 {Mutator: "link", Variation: "shared"},
2211 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002212 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002213 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002214
Colin Crossfe9acfe2021-06-14 16:13:03 -07002215 for _, lib := range deps.LateStaticLibs {
2216 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2217 actx.AddVariationDependencies([]blueprint.Variation{
2218 {Mutator: "link", Variation: "static"},
2219 }, depTag, RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
2220 }
2221
Jiyong Park7ed9de32018-10-15 22:25:07 +09002222 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002223 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002224 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2225 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2226 // linking against both the stubs lib and the non-stubs lib at the same time.
2227 continue
2228 }
Colin Cross6e511a92020-07-27 21:26:48 -07002229 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002230 variations := []blueprint.Variation{
2231 {Mutator: "link", Variation: "shared"},
2232 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002233 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002234 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002235
Dan Willemsen59339a22018-07-22 21:18:45 -07002236 actx.AddVariationDependencies([]blueprint.Variation{
2237 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002238 }, dataLibDepTag, deps.DataLibs...)
2239
2240 actx.AddVariationDependencies([]blueprint.Variation{
2241 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002242 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002243
Colin Cross68861832016-07-08 10:41:41 -07002244 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002245
2246 for _, gen := range deps.GeneratedHeaders {
2247 depTag := genHeaderDepTag
2248 if inList(gen, deps.ReexportGeneratedHeaders) {
2249 depTag = genHeaderExportDepTag
2250 }
2251 actx.AddDependency(c, depTag, gen)
2252 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002253
Dan Albert92fe7402020-07-15 13:33:30 -07002254 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002255 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002256 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002257 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002258 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002259 }
Colin Crossc465efd2021-06-11 18:00:04 -07002260 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002261 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002262 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002263 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002264 if deps.DynamicLinker != "" {
2265 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002266 }
Dan Albert914449f2016-06-17 16:45:24 -07002267
2268 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002269
2270 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002271 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002272 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002273 {Mutator: "link", Variation: "shared"},
2274 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002275
2276 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002277 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002278 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002279 {Mutator: "link", Variation: "shared"},
2280 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002281
2282 if vndkdep := c.vndkdep; vndkdep != nil {
2283 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002284 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002285 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002286 {Mutator: "link", Variation: "shared"},
2287 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002288 }
2289 }
Colin Cross6362e272015-10-29 15:25:03 -07002290}
Colin Cross21b9a242015-03-24 14:15:58 -07002291
Colin Crosse40b4ea2018-10-02 22:25:58 -07002292func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002293 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2294 c.beginMutator(ctx)
2295 }
2296}
2297
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002298// Whether a module can link to another module, taking into
2299// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002300func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002301 tag blueprint.DependencyTag) {
2302
2303 switch t := tag.(type) {
2304 case dependencyTag:
2305 if t != vndkExtDepTag {
2306 return
2307 }
2308 case libraryDependencyTag:
2309 default:
2310 return
2311 }
2312
Ivan Lozanof9e21722020-12-02 09:00:51 -05002313 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002314 // Host code is not restricted
2315 return
2316 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002317
2318 // VNDK is cc.Module supported only for now.
2319 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002320 // Though allowed dependency is limited by the image mutator,
2321 // each vendor and product module needs to check link-type
2322 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002323 if ccTo, ok := to.(*Module); ok {
2324 if ccFrom.vndkdep != nil {
2325 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2326 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002327 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002328 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002329 }
2330 return
2331 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002332 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002333 // Platform code can link to anything
2334 return
2335 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002336 if from.InRamdisk() {
2337 // Ramdisk code is not NDK
2338 return
2339 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002340 if from.InVendorRamdisk() {
2341 // Vendor ramdisk code is not NDK
2342 return
2343 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002344 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002345 // Recovery code is not NDK
2346 return
2347 }
Colin Cross31076b32020-10-23 17:22:06 -07002348 if c, ok := to.(*Module); ok {
2349 if c.ToolchainLibrary() {
2350 // These are always allowed
2351 return
2352 }
2353 if c.NdkPrebuiltStl() {
2354 // These are allowed, but they don't set sdk_version
2355 return
2356 }
2357 if c.StubDecorator() {
2358 // These aren't real libraries, but are the stub shared libraries that are included in
2359 // the NDK.
2360 return
2361 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002362 }
Logan Chien834b9a62019-01-14 15:39:03 +08002363
Ivan Lozano52767be2019-10-18 14:49:46 -07002364 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002365 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2366 // to link to libc++ (non-NDK and without sdk_version).
2367 return
2368 }
2369
Ivan Lozano52767be2019-10-18 14:49:46 -07002370 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002371 // NDK code linking to platform code is never okay.
2372 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002373 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002374 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002375 }
2376
2377 // At this point we know we have two NDK libraries, but we need to
2378 // check that we're not linking against anything built against a higher
2379 // API level, as it is only valid to link against older or equivalent
2380 // APIs.
2381
Inseob Kim01a28722018-04-11 09:48:45 +09002382 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002383 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002384 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002385 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002386 // Current can't be linked against by anything else.
2387 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002388 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002389 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002390 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002391 if err != nil {
2392 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002393 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002394 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002395 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002396 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002397 if err != nil {
2398 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002399 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002400 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002401 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002402
Inseob Kim01a28722018-04-11 09:48:45 +09002403 if toApi > fromApi {
2404 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002405 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002406 }
2407 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002408 }
Dan Albert202fe492017-12-15 13:56:59 -08002409
2410 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002411 fromStl := from.SelectedStl()
2412 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002413 if fromStl == "" || toStl == "" {
2414 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002415 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002416 // We can be permissive with the system "STL" since it is only the C++
2417 // ABI layer, but in the future we should make sure that everyone is
2418 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002419 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002420 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002421 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2422 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002423 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002424}
2425
Jooyung Han479ca172020-10-19 18:51:07 +09002426func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2427 if c, ok := ctx.Module().(*Module); ok {
2428 ctx.VisitDirectDeps(func(dep android.Module) {
2429 depTag := ctx.OtherModuleDependencyTag(dep)
2430 ccDep, ok := dep.(LinkableInterface)
2431 if ok {
2432 checkLinkType(ctx, c, ccDep, depTag)
2433 }
2434 })
2435 }
2436}
2437
Jiyong Park5fb8c102018-04-09 12:03:06 +09002438// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002439// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2440// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002441// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002442func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2443 check := func(child, parent android.Module) bool {
2444 to, ok := child.(*Module)
2445 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002446 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002447 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002448
Jooyung Hana70f0672019-01-18 15:20:43 +09002449 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2450 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002451 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002452
Jiyong Park0474e1f2021-01-14 14:26:06 +09002453 // These dependencies are not excercised at runtime. Tracking these will give us
2454 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002455 depTag := ctx.OtherModuleDependencyTag(child)
2456 if IsHeaderDepTag(depTag) {
2457 return false
2458 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002459 if depTag == staticVariantTag {
2460 return false
2461 }
2462 if depTag == stubImplDepTag {
2463 return false
2464 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002465
Justin Yun63e9ec72020-10-29 16:49:43 +09002466 // Even if target lib has no vendor variant, keep checking dependency
2467 // graph in case it depends on vendor_available or product_available
2468 // but not double_loadable transtively.
2469 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002470 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002471 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002472
Jiyong Park0474e1f2021-01-14 14:26:06 +09002473 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2474 // one.
2475 if Bool(to.VendorProperties.Double_loadable) {
2476 return true
2477 }
2478
Ivan Lozanod7586b62021-04-01 09:49:36 -04002479 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002480 return false
2481 }
2482
Jooyung Hana70f0672019-01-18 15:20:43 +09002483 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2484 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002485 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002486 return false
2487 }
2488 if module, ok := ctx.Module().(*Module); ok {
2489 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002490 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002491 ctx.WalkDeps(check)
2492 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002493 }
2494 }
2495}
2496
Colin Crossc99deeb2016-04-11 15:06:20 -07002497// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002498func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002499 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002500
Colin Cross0de8a1e2020-09-18 14:15:30 -07002501 var directStaticDeps []StaticLibraryInfo
2502 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002503
Colin Cross0de8a1e2020-09-18 14:15:30 -07002504 reexportExporter := func(exporter FlagExporterInfo) {
2505 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2506 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2507 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2508 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2509 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002510 }
2511
Jooyung Hande34d232020-07-23 13:04:15 +09002512 // For the dependency from platform to apex, use the latest stubs
2513 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002514 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2515 if !apexInfo.IsForPlatform() {
Jiyong Park4eab21d2021-04-15 15:17:54 +09002516 c.apexSdkVersion = apexInfo.MinSdkVersion
Jooyung Hande34d232020-07-23 13:04:15 +09002517 }
2518
2519 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2520 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2521 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2522 // (b/144430859)
2523 c.apexSdkVersion = android.FutureApiLevel
2524 }
2525
Colin Crossd11fcda2017-10-23 17:59:01 -07002526 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002527 depName := ctx.OtherModuleName(dep)
2528 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002529
Ivan Lozano52767be2019-10-18 14:49:46 -07002530 ccDep, ok := dep.(LinkableInterface)
2531 if !ok {
2532
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002533 // handling for a few module types that aren't cc Module but that are also supported
2534 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002535 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002536 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002537 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2538 genRule.GeneratedSourceFiles()...)
2539 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002540 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002541 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002542 // Support exported headers from a generated_sources dependency
2543 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002544 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002545 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002546 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002547 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002548 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002549 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002550 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002551 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002552 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2553 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002554 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002555 // 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 +09002556 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002557
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002558 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002559 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002560 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002561 }
Colin Crosscef792e2021-06-11 18:01:26 -07002562 case CrtBeginDepTag:
2563 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2564 case CrtEndDepTag:
2565 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002566 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002567 return
2568 }
2569
Colin Crossfe17f6f2019-03-28 19:30:56 -07002570 if depTag == android.ProtoPluginDepTag {
2571 return
2572 }
2573
Colin Crossd11fcda2017-10-23 17:59:01 -07002574 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002575 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2576 return
2577 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002578 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002579 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2580 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002581 return
2582 }
2583
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002584 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002585 // Skip reused objects for stub libraries, they use their own stub object file instead.
2586 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2587 // version mutator, so the stubs variant is created from the shared variant that
2588 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002589 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002590 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2591 objs := staticAnalogue.ReuseObjects
2592 depPaths.Objs = depPaths.Objs.Append(objs)
2593 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2594 reexportExporter(depExporterInfo)
2595 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002596 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002597 }
2598
Colin Cross6e511a92020-07-27 21:26:48 -07002599 linkFile := ccDep.OutputFile()
2600
2601 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2602 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002603 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002604 return
2605 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002606
Jiyong Parke3867542020-12-03 17:28:25 +09002607 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2608 return
2609 }
2610
Colin Cross0de8a1e2020-09-18 14:15:30 -07002611 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002612
Colin Cross6e511a92020-07-27 21:26:48 -07002613 var ptr *android.Paths
2614 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002615
Colin Cross6e511a92020-07-27 21:26:48 -07002616 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002617
Colin Cross6e511a92020-07-27 21:26:48 -07002618 switch {
2619 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002620 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2621 if !ctx.Config().AllowMissingDependencies() {
2622 ctx.ModuleErrorf("module %q is not a header library", depName)
2623 } else {
2624 ctx.AddMissingDependencies([]string{depName})
2625 }
2626 return
2627 }
Colin Cross6e511a92020-07-27 21:26:48 -07002628 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002629 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2630 if !ctx.Config().AllowMissingDependencies() {
2631 ctx.ModuleErrorf("module %q is not a shared library", depName)
2632 } else {
2633 ctx.AddMissingDependencies([]string{depName})
2634 }
2635 return
2636 }
Jiyong Parke3867542020-12-03 17:28:25 +09002637
Jiyong Park7d55b612021-06-11 17:22:09 +09002638 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
2639 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07002640
Jiyong Park1ad8e162020-12-01 23:40:09 +09002641 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2642 // linkFile, depFile, and ptr.
2643 if c.IsStubs() {
2644 break
2645 }
2646
Colin Cross0de8a1e2020-09-18 14:15:30 -07002647 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2648 depFile = sharedLibraryInfo.TableOfContents
2649
Colin Cross6e511a92020-07-27 21:26:48 -07002650 ptr = &depPaths.SharedLibs
2651 switch libDepTag.Order {
2652 case earlyLibraryDependency:
2653 ptr = &depPaths.EarlySharedLibs
2654 depPtr = &depPaths.EarlySharedLibsDeps
2655 case normalLibraryDependency:
2656 ptr = &depPaths.SharedLibs
2657 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002658 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002659 case lateLibraryDependency:
2660 ptr = &depPaths.LateSharedLibs
2661 depPtr = &depPaths.LateSharedLibsDeps
2662 default:
2663 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002664 }
Colin Cross6e511a92020-07-27 21:26:48 -07002665 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002666 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2667 if !ctx.Config().AllowMissingDependencies() {
2668 ctx.ModuleErrorf("module %q is not a static library", depName)
2669 } else {
2670 ctx.AddMissingDependencies([]string{depName})
2671 }
2672 return
2673 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002674
2675 // Stubs lib doesn't link to the static lib dependencies. Don't set
2676 // linkFile, depFile, and ptr.
2677 if c.IsStubs() {
2678 break
2679 }
2680
Colin Cross0de8a1e2020-09-18 14:15:30 -07002681 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2682 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002683 if libDepTag.wholeStatic {
2684 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002685 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2686 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002687 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002688 // This case normally catches prebuilt static
2689 // libraries, but it can also occur when
2690 // AllowMissingDependencies is on and the
2691 // dependencies has no sources of its own
2692 // but has a whole_static_libs dependency
2693 // on a missing library. We want to depend
2694 // on the .a file so that there is something
2695 // in the dependency tree that contains the
2696 // error rule for the missing transitive
2697 // dependency.
2698 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002699 }
Colin Cross6e511a92020-07-27 21:26:48 -07002700 } else {
2701 switch libDepTag.Order {
2702 case earlyLibraryDependency:
2703 panic(fmt.Errorf("early static libs not suppported"))
2704 case normalLibraryDependency:
2705 // static dependencies will be handled separately so they can be ordered
2706 // using transitive dependencies.
2707 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002708 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002709 case lateLibraryDependency:
2710 ptr = &depPaths.LateStaticLibs
2711 default:
2712 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002713 }
2714 }
2715 }
2716
Colin Cross6e511a92020-07-27 21:26:48 -07002717 if libDepTag.static() && !libDepTag.wholeStatic {
2718 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2719 ctx.ModuleErrorf("module %q not a static library", depName)
2720 return
2721 }
Logan Chien43d34c32017-12-20 01:17:32 +08002722
Colin Cross6e511a92020-07-27 21:26:48 -07002723 // When combining coverage files for shared libraries and executables, coverage files
2724 // in static libraries act as if they were whole static libraries. The same goes for
2725 // source based Abi dump files.
2726 if c, ok := ccDep.(*Module); ok {
2727 staticLib := c.linker.(libraryInterface)
2728 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2729 staticLib.objs().coverageFiles...)
2730 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2731 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002732 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002733 // Handle non-CC modules here
2734 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002735 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002736 }
2737 }
2738
Colin Cross6e511a92020-07-27 21:26:48 -07002739 if ptr != nil {
2740 if !linkFile.Valid() {
2741 if !ctx.Config().AllowMissingDependencies() {
2742 ctx.ModuleErrorf("module %q missing output file", depName)
2743 } else {
2744 ctx.AddMissingDependencies([]string{depName})
2745 }
2746 return
2747 }
2748 *ptr = append(*ptr, linkFile.Path())
2749 }
2750
2751 if depPtr != nil {
2752 dep := depFile
2753 if !dep.Valid() {
2754 dep = linkFile
2755 }
2756 *depPtr = append(*depPtr, dep.Path())
2757 }
2758
Colin Cross0de8a1e2020-09-18 14:15:30 -07002759 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2760 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2761 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2762 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2763
2764 if libDepTag.reexportFlags {
2765 reexportExporter(depExporterInfo)
2766 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2767 // Re-exported shared library headers must be included as well since they can help us with type information
2768 // about template instantiations (instantiated from their headers).
2769 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2770 // scripts.
2771 c.sabi.Properties.ReexportedIncludes = append(
2772 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2773 }
2774
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002775 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002776 switch {
2777 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002778 c.Properties.AndroidMkHeaderLibs = append(
2779 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002780 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002781 if lib := moduleLibraryInterface(dep); lib != nil {
2782 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002783 // Add the dependency to the APEX(es) providing the library so that
2784 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002785 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09002786 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07002787 c.Properties.ApexesProvidingSharedLibs = append(
2788 c.Properties.ApexesProvidingSharedLibs, an)
2789 }
2790 }
2791 }
2792
2793 // Note: the order of libs in this list is not important because
2794 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002795 c.Properties.AndroidMkSharedLibs = append(
2796 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002797 // Record BaseLibName for snapshots.
2798 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002799 case libDepTag.static():
2800 if libDepTag.wholeStatic {
2801 c.Properties.AndroidMkWholeStaticLibs = append(
2802 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2803 } else {
2804 c.Properties.AndroidMkStaticLibs = append(
2805 c.Properties.AndroidMkStaticLibs, makeLibName)
2806 }
Justin Yun5e035862021-06-29 20:50:37 +09002807 // Record BaseLibName for snapshots.
2808 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002809 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002810 } else if !c.IsStubs() {
2811 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2812
Colin Cross6e511a92020-07-27 21:26:48 -07002813 switch depTag {
2814 case runtimeDepTag:
2815 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002816 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002817 // Record BaseLibName for snapshots.
2818 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002819 case objDepTag:
2820 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2821 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002822 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002823 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002824 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002825 case dynamicLinkerDepTag:
2826 depPaths.DynamicLinker = linkFile
2827 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002828 }
Colin Crossca860ac2016-01-04 14:34:37 -08002829 })
2830
Jeff Gaston294356f2017-09-27 17:05:30 -07002831 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002832 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2833 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2834 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002835
Colin Crossdd84e052017-05-17 13:44:16 -07002836 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002837 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002838 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2839 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002840 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002841 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2842 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002843 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002844 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002845 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002846
2847 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002848 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002849 }
Colin Crossdd84e052017-05-17 13:44:16 -07002850
Colin Crossca860ac2016-01-04 14:34:37 -08002851 return depPaths
2852}
2853
Jiyong Park7d55b612021-06-11 17:22:09 +09002854// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
2855// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
2856// dependency. The stub variant is selected when the dependency crosses a boundary where each side
2857// has different level of updatability. For example, if a library foo in an APEX depends on a
2858// library bar which provides stable interface and exists in the platform, foo uses the stub variant
2859// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
2860// same APEX as foo, the non-stub variant of bar is used.
2861func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
2862 depName := ctx.OtherModuleName(dep)
2863 depTag := ctx.OtherModuleDependencyTag(dep)
2864 libDepTag, ok := depTag.(libraryDependencyTag)
2865 if !ok || !libDepTag.shared() {
2866 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2867 }
2868
2869 thisModule, ok := ctx.Module().(android.ApexModule)
2870 if !ok {
2871 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
2872 }
2873
2874 useVndk := false
2875 bootstrap := false
2876 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
2877 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
2878 } else {
2879 useVndk = linkable.UseVndk()
2880 bootstrap = linkable.Bootstrap()
2881 }
2882
2883 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2884 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2885 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
2886 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2887
2888 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
2889 useStubs := false
2890
2891 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
2892 if !apexInfo.IsForPlatform() {
2893 // For platform libraries, use current version of LLNDK
2894 // If this is for use_vendor apex we will apply the same rules
2895 // of apex sdk enforcement below to choose right version.
2896 useStubs = true
2897 }
Jiyong Park9477c262021-06-22 20:23:05 +09002898 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
2899 // If not building for APEX or the containing APEX allows the use of
2900 // platform APIs, use stubs only when it is from an APEX (and not from
2901 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
2902 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09002903 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
2904 if useStubs {
2905 // Another exception: if this module is a test for an APEX, then
2906 // it is linked with the non-stub variant of a module in the APEX
2907 // as if this is part of the APEX.
2908 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2909 for _, apexContents := range testFor.ApexContents {
2910 if apexContents.DirectlyInApex(depName) {
2911 useStubs = false
2912 break
2913 }
2914 }
2915 }
2916 if useStubs {
2917 // Yet another exception: If this module and the dependency are
2918 // available to the same APEXes then skip stubs between their
2919 // platform variants. This complements the test_for case above,
2920 // which avoids the stubs on a direct APEX library dependency, by
2921 // avoiding stubs for indirect test dependencies as well.
2922 //
2923 // TODO(b/183882457): This doesn't work if the two libraries have
2924 // only partially overlapping apex_available. For that test_for
2925 // modules would need to be split into APEX variants and resolved
2926 // separately for each APEX they have access to.
2927 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
2928 useStubs = false
2929 }
2930 }
2931 } else {
2932 // If building for APEX, use stubs when the parent is in any APEX that
2933 // the child is not in.
2934 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2935 }
2936
2937 // when to use (unspecified) stubs, use the latest one.
2938 if useStubs {
2939 stubs := sharedLibraryStubsInfo.SharedStubLibraries
2940 toUse := stubs[len(stubs)-1]
2941 sharedLibraryInfo = toUse.SharedLibraryInfo
2942 depExporterInfo = toUse.FlagExporterInfo
2943 }
2944 }
2945 return sharedLibraryInfo, depExporterInfo
2946}
2947
Colin Cross0de8a1e2020-09-18 14:15:30 -07002948// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2949// to match the topological order of the dependency tree, including any static analogues of
2950// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2951// of the transitive dependencies.
2952func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2953 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2954 var staticPaths android.Paths
2955 for _, staticDep := range staticDeps {
2956 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2957 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2958 }
2959 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04002960 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
2961 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002962 }
2963 }
2964 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2965
2966 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2967
2968 // reorder the dependencies based on transitive dependencies
2969 staticPaths = android.FirstUniquePaths(staticPaths)
2970 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2971
2972 if len(orderedStaticPaths) != len(staticPaths) {
2973 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2974 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2975 }
2976
2977 return orderedStaticPaths, transitiveStaticLibs
2978}
2979
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002980// BaseLibName trims known prefixes and suffixes
2981func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07002982 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
2983 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00002984 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07002985 return libName
2986}
2987
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002988func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002989 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08002990 ccDepModule, _ := ccDep.(*Module)
2991 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09002992 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07002993
Justin Yuncbca3732021-02-03 19:24:13 +09002994 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002995 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07002996 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04002997 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09002998 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07002999
Ivan Lozanod1dec542021-05-26 15:33:11 -04003000 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003001 }
3002 }
3003
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003004 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3005 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003006 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3007 // core module instead.
3008 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003009 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003010 // The vendor and product modules in Make will have been renamed to not conflict with the
3011 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003012 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003013 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
3014 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003015 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003016 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003017 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
3018 return libName + recoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003019 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Colin Cross6e511a92020-07-27 21:26:48 -07003020 return libName + nativeBridgeSuffix
3021 } else {
3022 return libName
3023 }
3024}
3025
Colin Crossca860ac2016-01-04 14:34:37 -08003026func (c *Module) InstallInData() bool {
3027 if c.installer == nil {
3028 return false
3029 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003030 return c.installer.inData()
3031}
3032
3033func (c *Module) InstallInSanitizerDir() bool {
3034 if c.installer == nil {
3035 return false
3036 }
3037 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003038 return true
3039 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003040 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003041}
3042
Yifan Hong1b3348d2020-01-21 15:53:22 -08003043func (c *Module) InstallInRamdisk() bool {
3044 return c.InRamdisk()
3045}
3046
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003047func (c *Module) InstallInVendorRamdisk() bool {
3048 return c.InVendorRamdisk()
3049}
3050
Jiyong Parkf9332f12018-02-01 00:54:12 +09003051func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003052 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003053}
3054
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003055func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003056 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003057 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003058 return
3059 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003060 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003061}
3062
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003063func (c *Module) HostToolPath() android.OptionalPath {
3064 if c.installer == nil {
3065 return android.OptionalPath{}
3066 }
3067 return c.installer.hostToolPath()
3068}
3069
Nan Zhangd4e641b2017-07-12 12:55:28 -07003070func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3071 return c.outputFile
3072}
3073
Colin Cross41955e82019-05-29 14:40:35 -07003074func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3075 switch tag {
3076 case "":
3077 if c.outputFile.Valid() {
3078 return android.Paths{c.outputFile.Path()}, nil
3079 }
3080 return android.Paths{}, nil
3081 default:
3082 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003083 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003084}
3085
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003086func (c *Module) static() bool {
3087 if static, ok := c.linker.(interface {
3088 static() bool
3089 }); ok {
3090 return static.static()
3091 }
3092 return false
3093}
3094
Jiyong Park379de2f2018-12-19 02:47:14 +09003095func (c *Module) staticBinary() bool {
3096 if static, ok := c.linker.(interface {
3097 staticBinary() bool
3098 }); ok {
3099 return static.staticBinary()
3100 }
3101 return false
3102}
3103
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003104func (c *Module) testBinary() bool {
3105 if test, ok := c.linker.(interface {
3106 testBinary() bool
3107 }); ok {
3108 return test.testBinary()
3109 }
3110 return false
3111}
3112
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003113// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3114func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003115 if h, ok := c.linker.(interface {
3116 header() bool
3117 }); ok {
3118 return h.header()
3119 }
3120 return false
3121}
3122
Ivan Lozanod7586b62021-04-01 09:49:36 -04003123func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003124 if b, ok := c.linker.(interface {
3125 binary() bool
3126 }); ok {
3127 return b.binary()
3128 }
3129 return false
3130}
3131
Justin Yun5e035862021-06-29 20:50:37 +09003132func (c *Module) StaticExecutable() bool {
3133 if b, ok := c.linker.(*binaryDecorator); ok {
3134 return b.static()
3135 }
3136 return false
3137}
3138
Ivan Lozanod7586b62021-04-01 09:49:36 -04003139func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003140 if o, ok := c.linker.(interface {
3141 object() bool
3142 }); ok {
3143 return o.object()
3144 }
3145 return false
3146}
3147
Ivan Lozanof9e21722020-12-02 09:00:51 -05003148func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003149 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003150 if c.IsLlndk() {
3151 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003152 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003153 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003154 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003155 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003156 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003157 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003158 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003159 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003160 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003161 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003162 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003163 return "native:product"
3164 }
Jooyung Han38002912019-05-16 04:01:54 +09003165 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003166 } else if c.InRamdisk() {
3167 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003168 } else if c.InVendorRamdisk() {
3169 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003170 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003171 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003172 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003173 return "native:ndk:none:none"
3174 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3175 //family, link := getNdkStlFamilyAndLinkType(c)
3176 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003177 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003178 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003179 } else {
3180 return "native:platform"
3181 }
3182}
3183
Jiyong Park9d452992018-10-03 00:38:19 +09003184// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003185// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003186func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003187 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003188 // Stub libs and prebuilt libs in a versioned SDK are not
3189 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07003190 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01003191 } else if _, ok := c.linker.(testPerSrc); ok {
3192 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003193 }
3194 return false
3195}
3196
Jiyong Parka90ca002019-10-07 15:47:24 +09003197func (c *Module) AvailableFor(what string) bool {
3198 if linker, ok := c.linker.(interface {
3199 availableFor(string) bool
3200 }); ok {
3201 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3202 } else {
3203 return c.ApexModuleBase.AvailableFor(what)
3204 }
3205}
3206
Jiyong Park62304bb2020-04-13 16:19:48 +09003207func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003208 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003209}
3210
Colin Crossaede88c2020-08-11 12:17:01 -07003211func (c *Module) UniqueApexVariations() bool {
3212 if u, ok := c.compiler.(interface {
3213 uniqueApexVariations() bool
3214 }); ok {
3215 return u.uniqueApexVariations()
3216 } else {
3217 return false
3218 }
3219}
3220
Paul Duffin0cb37b92020-03-04 14:52:46 +00003221func (c *Module) EverInstallable() bool {
3222 return c.installer != nil &&
3223 // Check to see whether the module is actually ever installable.
3224 c.installer.everInstallable()
3225}
3226
Ivan Lozanod7586b62021-04-01 09:49:36 -04003227func (c *Module) PreventInstall() bool {
3228 return c.Properties.PreventInstall
3229}
3230
3231func (c *Module) Installable() *bool {
3232 return c.Properties.Installable
3233}
3234
3235func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003236 ret := c.EverInstallable() &&
3237 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003238 proptools.BoolDefault(c.Installable(), true) &&
3239 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003240
3241 // The platform variant doesn't need further condition. Apex variants however might not
3242 // be installable because it will likely to be included in the APEX and won't appear
3243 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003244 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003245 return ret
3246 }
3247
3248 // Special case for modules that are configured to be installed to /data, which includes
3249 // test modules. For these modules, both APEX and non-APEX variants are considered as
3250 // installable. This is because even the APEX variants won't be included in the APEX, but
3251 // will anyway be installed to /data/*.
3252 // See b/146995717
3253 if c.InstallInData() {
3254 return ret
3255 }
3256
3257 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003258}
3259
Logan Chien41eabe62019-04-10 13:33:58 +08003260func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3261 if c.linker != nil {
3262 if library, ok := c.linker.(*libraryDecorator); ok {
3263 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3264 }
3265 }
3266}
3267
Jiyong Park45bf82e2020-12-15 22:29:02 +09003268var _ android.ApexModule = (*Module)(nil)
3269
3270// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003271func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003272 depTag := ctx.OtherModuleDependencyTag(dep)
3273 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3274
3275 if cc, ok := dep.(*Module); ok {
3276 if cc.HasStubsVariants() {
3277 if isLibDepTag && libDepTag.shared() {
3278 // dynamic dep to a stubs lib crosses APEX boundary
3279 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003280 }
Colin Cross6e511a92020-07-27 21:26:48 -07003281 if IsRuntimeDepTag(depTag) {
3282 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003283 return false
3284 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003285 }
Zhijun Heec285872021-04-24 10:47:08 -07003286 if cc.IsLlndk() {
3287 return false
3288 }
Colin Crossaac32222020-07-29 12:51:56 -07003289 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003290 // shared_lib dependency from a static lib is considered as crossing
3291 // the APEX boundary because the dependency doesn't actually is
3292 // linked; the dependency is used only during the compilation phase.
3293 return false
3294 }
Jiyong Parke3867542020-12-03 17:28:25 +09003295
3296 if isLibDepTag && libDepTag.excludeInApex {
3297 return false
3298 }
Colin Cross6e511a92020-07-27 21:26:48 -07003299 }
Colin Crossc1b36442021-05-06 13:42:48 -07003300 if depTag == stubImplDepTag {
3301 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003302 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003303 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003304 if depTag == staticVariantTag {
3305 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3306 // actually mean that the static lib (and its dependencies) are copied into the
3307 // APEX.
3308 return false
3309 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003310 return true
3311}
3312
Jiyong Park45bf82e2020-12-15 22:29:02 +09003313// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003314func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3315 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003316 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3317 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3318 return nil
3319 }
3320 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3321 if c.ToolchainLibrary() {
3322 return nil
3323 }
3324 // We don't check for prebuilt modules
3325 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3326 return nil
3327 }
3328 minSdkVersion := c.MinSdkVersion()
3329 if minSdkVersion == "apex_inherit" {
3330 return nil
3331 }
3332 if minSdkVersion == "" {
3333 // JNI libs within APK-in-APEX fall into here
3334 // Those are okay to set sdk_version instead
3335 // We don't have to check if this is a SDK variant because
3336 // non-SDK variant resets sdk_version, which works too.
3337 minSdkVersion = c.SdkVersion()
3338 }
Dan Albertc8060532020-07-22 22:32:17 -07003339 if minSdkVersion == "" {
3340 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3341 }
3342 // Not using nativeApiLevelFromUser because the context here is not
3343 // necessarily a native context.
3344 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003345 if err != nil {
3346 return err
3347 }
Dan Albertc8060532020-07-22 22:32:17 -07003348
3349 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003350 return fmt.Errorf("newer SDK(%v)", ver)
3351 }
3352 return nil
3353}
3354
Paul Duffinb5769c12021-05-12 16:16:51 +01003355// Implements android.ApexModule
3356func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3357 // stub libraries and native bridge libraries are always available to platform
3358 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3359}
3360
Colin Cross2ba19d92015-05-07 15:44:20 -07003361//
Colin Crosscfad1192015-11-02 16:43:11 -08003362// Defaults
3363//
Colin Crossca860ac2016-01-04 14:34:37 -08003364type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003365 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003366 android.DefaultsModuleBase
Liz Kammer3cf52112021-03-31 15:42:03 -04003367 // Included to support setting bazel_module.label for multiple Soong modules to the same Bazel
3368 // target. This is primarily useful for modules that were architecture specific and instead are
3369 // handled in Bazel as a select().
3370 android.BazelModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003371 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003372}
3373
Patrice Arrudac249c712019-03-19 17:00:29 -07003374// cc_defaults provides a set of properties that can be inherited by other cc
3375// modules. A module can use the properties from a cc_defaults using
3376// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3377// merged (when possible) by prepending the default module's values to the
3378// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003379func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003380 return DefaultsFactory()
3381}
3382
Colin Cross36242852017-06-23 15:06:31 -07003383func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003384 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003385
Colin Cross36242852017-06-23 15:06:31 -07003386 module.AddProperties(props...)
3387 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003388 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003389 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003390 &BaseCompilerProperties{},
3391 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003392 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003393 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003394 &StaticProperties{},
3395 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003396 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003397 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003398 &TestProperties{},
3399 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003400 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003401 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003402 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003403 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003404 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003405 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003406 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003407 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003408 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003409 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003410 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003411 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003412 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003413 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3414 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003415 )
Colin Crosscfad1192015-11-02 16:43:11 -08003416
Liz Kammer3cf52112021-03-31 15:42:03 -04003417 // Bazel module must be initialized _before_ Defaults to be included in cc_defaults module.
3418 android.InitBazelModule(module)
Jooyung Hancc372c52019-09-25 15:18:44 +09003419 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003420
3421 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003422}
3423
Jiyong Park2286afd2020-06-16 21:58:53 +09003424func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003425 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003426}
3427
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003428func kytheExtractAllFactory() android.Singleton {
3429 return &kytheExtractAllSingleton{}
3430}
3431
3432type kytheExtractAllSingleton struct {
3433}
3434
3435func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3436 var xrefTargets android.Paths
3437 ctx.VisitAllModules(func(module android.Module) {
3438 if ccModule, ok := module.(xref); ok {
3439 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3440 }
3441 })
3442 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3443 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003444 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003445 }
3446}
3447
Colin Cross06a931b2015-10-28 17:23:31 -07003448var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003449var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003450var BoolPtr = proptools.BoolPtr
3451var String = proptools.String
3452var StringPtr = proptools.StringPtr