blob: 2006ecfe37b6de43bf254004682a37783e5936ee [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"
hamzehc0a671f2021-07-22 12:05:08 -070032 "android/soong/fuzz"
Colin Cross5049f022015-03-18 13:28:46 -070033 "android/soong/genrule"
Colin Cross3f40fa42015-01-30 17:27:36 -080034)
35
Colin Cross463a90e2015-06-17 14:20:06 -070036func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000037 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070038
Paul Duffin036e7002019-12-19 19:16:28 +000039 pctx.Import("android/soong/cc/config")
40}
41
42func RegisterCCBuildComponents(ctx android.RegistrationContext) {
43 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
44
45 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000046 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090047 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070048 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010049 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070050 ctx.BottomUp("version_selector", versionSelectorMutator).Parallel()
51 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070052 ctx.BottomUp("begin", BeginMutator).Parallel()
Inseob Kimac1e9862019-12-09 18:15:47 +090053 ctx.BottomUp("sysprop_cc", SyspropMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070054 })
Colin Cross16b23492016-01-06 14:41:07 -080055
Paul Duffin036e7002019-12-19 19:16:28 +000056 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040057 for _, san := range Sanitizers {
58 san.registerMutators(ctx)
59 }
Dan Willemsen581341d2017-02-09 16:16:31 -080060
Colin Cross0b908332019-06-19 23:00:20 -070061 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090062 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080063
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080064 ctx.BottomUp("coverage", coverageMutator).Parallel()
Stephen Craneba090d12017-05-09 15:44:35 -070065
66 ctx.TopDown("lto_deps", ltoDepsMutator)
67 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090068
Jooyung Han479ca172020-10-19 18:51:07 +090069 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090070 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070071 })
Colin Crossb98c8b02016-07-29 13:44:28 -070072
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080073 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
74 // sabi mutator needs to be run after apex mutator finishes.
75 ctx.TopDown("sabi_deps", sabiDepsMutator)
76 })
77
Colin Cross57898582020-10-29 18:25:19 -070078 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070079}
80
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050081// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
82// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
83// edges to these modules.
84// This object is constructed in DepsMutator, by calling to various module delegates to set
85// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
86// dependencies.
87// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
88// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080089type Deps struct {
90 SharedLibs, LateSharedLibs []string
91 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080092 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +080093 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -070094
Chris Parsons79d66a52020-06-05 17:26:16 -040095 // Used for data dependencies adjacent to tests
96 DataLibs []string
97
Yo Chiang219968c2020-09-22 18:45:04 +080098 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
99 SystemSharedLibs []string
100
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500101 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800102 StaticUnwinderIfLegacy bool
103
Colin Cross5950f382016-12-13 12:50:57 -0800104 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700105
Colin Cross81413472016-04-11 14:37:39 -0700106 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700107
Dan Willemsenb40aab62016-04-20 14:21:14 -0700108 GeneratedSources []string
109 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900110 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700111
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700112 ReexportGeneratedHeaders []string
113
Colin Crossc465efd2021-06-11 18:00:04 -0700114 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700115
116 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700117 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900118
119 // List of libs that need to be excluded for APEX variant
120 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700121}
122
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500123// PathDeps is a struct containing file paths to dependencies of a module.
124// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
125// It's used to construct flags for various build statements (such as for compiling and linking).
126// It is then passed to module decorator functions responsible for registering build statements
127// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800128type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700129 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900130 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700131 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900132 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700133 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700134 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700135
Colin Cross0de8a1e2020-09-18 14:15:30 -0700136 // Transitive static library dependencies of static libraries for use in ordering.
137 TranstiveStaticLibrariesForOrdering *android.DepSet
138
Colin Cross26c34ed2016-09-30 17:10:16 -0700139 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100140 Objs Objects
141 // Paths to .o files in dependencies that provide them. Note that these lists
142 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800143 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700144 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700145
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100146 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
147 // the libs from all whole_static_lib dependencies.
148 WholeStaticLibsFromPrebuilts android.Paths
149
Colin Cross26c34ed2016-09-30 17:10:16 -0700150 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700151 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900152 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700153
Inseob Kimd110f872019-12-06 13:15:38 +0900154 Flags []string
155 IncludeDirs android.Paths
156 SystemIncludeDirs android.Paths
157 ReexportedDirs android.Paths
158 ReexportedSystemDirs android.Paths
159 ReexportedFlags []string
160 ReexportedGeneratedHeaders android.Paths
161 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700162
Colin Cross26c34ed2016-09-30 17:10:16 -0700163 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700164 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700165
Dan Willemsena0790e32018-10-12 00:24:23 -0700166 // Path to the dynamic linker binary
167 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700168}
169
Colin Cross4af21ed2019-11-04 09:37:55 -0800170// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
171// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
172// command line so they can be overridden by the local module flags).
173type LocalOrGlobalFlags struct {
174 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700175 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800176 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700177 CFlags []string // Flags that apply to C and C++ source files
178 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
179 ConlyFlags []string // Flags that apply to C source files
180 CppFlags []string // Flags that apply to C++ source files
181 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700182 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800183}
184
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500185// Flags contains various types of command line flags (and settings) for use in building build
186// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800187type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500188 // Local flags (which individual modules are responsible for). These may override global flags.
189 Local LocalOrGlobalFlags
190 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800191 Global LocalOrGlobalFlags
192
193 aidlFlags []string // Flags that apply to aidl source files
194 rsFlags []string // Flags that apply to renderscript source files
195 libFlags []string // Flags to add libraries early to the link order
196 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
197 TidyFlags []string // Flags that apply to clang-tidy
198 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700199
Colin Crossc3199482017-03-30 15:03:04 -0700200 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800201 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700202 SystemIncludeFlags []string
203
Oliver Nguyen04526782020-04-21 12:40:27 -0700204 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500205 Tidy bool // True if clang-tidy is enabled.
206 GcovCoverage bool // True if coverage files should be generated.
207 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700208 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800209
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500210 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800211 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500212 // The target-device system path to the dynamic linker.
213 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800214
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700215 CFlagsDeps android.Paths // Files depended on by compiler flags
216 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800217
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500218 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700219 AssemblerWithCpp bool
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500220 // True if static libraries should be grouped (using `-Wl,--start-group` and `-Wl,--end-group`).
221 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800222
Colin Cross19878da2019-03-28 14:45:07 -0700223 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700224 protoC bool // Whether to use C instead of C++
225 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700226
227 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200228 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700229}
230
Colin Crossca860ac2016-01-04 14:34:37 -0800231// Properties used to compile all C or C++ modules
232type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700233 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800234 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700235
Jiyong Parkb35a8192020-08-10 15:59:36 +0900236 // The API level that this module is built against. The APIs of this API level will be
237 // visible at build time, but use of any APIs newer than min_sdk_version will render the
238 // module unloadable on older devices. In the future it will be possible to weakly-link new
239 // APIs, making the behavior match Java: such modules will load on older devices, but
240 // calling new APIs on devices that do not support them will result in a crash.
241 //
242 // This property has the same behavior as sdk_version does for Java modules. For those
243 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
244 // does for Java code.
245 //
246 // In addition, setting this property causes two variants to be built, one for the platform
247 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800248 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700249
Jiyong Parkb35a8192020-08-10 15:59:36 +0900250 // Minimum OS API level supported by this C or C++ module. This property becomes the value
251 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
252 // this property is also used to ensure that the min_sdk_version of the containing module is
253 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
254 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
255 // min_sdk_version of the containing APEX. When the module
256 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900257 Min_sdk_version *string
258
Colin Crossc511bc52020-04-07 16:50:32 +0000259 // If true, always create an sdk variant and don't create a platform variant.
260 Sdk_variant_only *bool
261
Jiyong Parkde866cb2018-12-07 23:08:36 +0900262 AndroidMkSharedLibs []string `blueprint:"mutated"`
263 AndroidMkStaticLibs []string `blueprint:"mutated"`
264 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
265 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700266 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900267 HideFromMake bool `blueprint:"mutated"`
268 PreventInstall bool `blueprint:"mutated"`
269 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700270
Yo Chiang219968c2020-09-22 18:45:04 +0800271 // Set by DepsMutator.
272 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
273
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200274 // The name of the image this module is built for, suffixed with a '.'
Justin Yun5f7f7e82019-11-18 19:52:14 +0900275 ImageVariationPrefix string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200276
277 // The VNDK version this module is built against. If empty, the module is not
278 // build against the VNDK.
279 VndkVersion string `blueprint:"mutated"`
280
281 // Suffix for the name of Android.mk entries generated by this module
282 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800283
284 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
285 // file
286 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900287
Yifan Hong39143a92020-10-26 12:43:12 -0700288 // Make this module available when building for ramdisk.
289 // On device without a dedicated recovery partition, the module is only
290 // available after switching root into
291 // /first_stage_ramdisk. To expose the module before switching root, install
292 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800293 Ramdisk_available *bool
294
Yifan Hong39143a92020-10-26 12:43:12 -0700295 // Make this module available when building for vendor ramdisk.
296 // On device without a dedicated recovery partition, the module is only
297 // available after switching root into
298 // /first_stage_ramdisk. To expose the module before switching root, install
299 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700300 Vendor_ramdisk_available *bool
301
Jiyong Parkf9332f12018-02-01 00:54:12 +0900302 // Make this module available when building for recovery
303 Recovery_available *bool
304
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200305 // Used by imageMutator, set by ImageMutatorBegin()
306 CoreVariantNeeded bool `blueprint:"mutated"`
307 RamdiskVariantNeeded bool `blueprint:"mutated"`
308 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
309 RecoveryVariantNeeded bool `blueprint:"mutated"`
310
311 // A list of variations for the "image" mutator of the form
312 //<image name> '.' <version char>, for example, 'vendor.S'
313 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900314
315 // Allows this module to use non-APEX version of libraries. Useful
316 // for building binaries that are started before APEXes are activated.
317 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900318
319 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
320 // see soong/cc/config/vndk.go
321 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900322
323 // Used by vendor snapshot to record dependencies from snapshot modules.
324 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900325 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900326 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000327
328 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000329
330 // Set by factories of module types that can only be referenced from variants compiled against
331 // the SDK.
332 AlwaysSdk bool `blueprint:"mutated"`
333
334 // Variant is an SDK variant created by sdkMutator
335 IsSdkVariant bool `blueprint:"mutated"`
336 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
337 // variant to have a ".sdk" suffix.
338 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700339
340 // Normally Soong uses the directory structure to decide which modules
341 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800342 // different snapshots (vendor, recovery, etc.), but this property
343 // allows a partner to exclude a module normally thought of as a
344 // framework module from the vendor snapshot.
345 Exclude_from_vendor_snapshot *bool
346
347 // Normally Soong uses the directory structure to decide which modules
348 // should be included (framework) or excluded (non-framework) from the
349 // different snapshots (vendor, recovery, etc.), but this property
350 // allows a partner to exclude a module normally thought of as a
351 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800352 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900353
354 // List of APEXes that this module has private access to for testing purpose. The module
355 // can depend on libraries that are not exported by the APEXes and use private symbols
356 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000357 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800358
359 Target struct {
360 Platform struct {
361 // List of modules required by the core variant.
362 Required []string `android:"arch_variant"`
363
364 // List of modules not required by the core variant.
365 Exclude_required []string `android:"arch_variant"`
366 } `android:"arch_variant"`
367
368 Recovery struct {
369 // List of modules required by the recovery variant.
370 Required []string `android:"arch_variant"`
371
372 // List of modules not required by the recovery variant.
373 Exclude_required []string `android:"arch_variant"`
374 } `android:"arch_variant"`
375 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700376}
377
378type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900379 // whether this module should be allowed to be directly depended by other
380 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900381 // If set to true, two variants will be built separately, one like
382 // normal, and the other limited to the set of libraries and headers
383 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700384 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900385 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700386 // so it shouldn't have any unversioned runtime dependencies, or
387 // make assumptions about the system that may not be true in the
388 // future.
389 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900390 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900391 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900392 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900393 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900394 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700395 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
396 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900397
Justin Yunebcf0c52021-01-08 18:00:19 +0900398 // This is the same as the "vendor_available" except that the install path
399 // of the vendor variant is /odm or /vendor/odm.
400 // By replacing "vendor_available: true" with "odm_available: true", the
401 // module will install its vendor variant to the /odm partition or /vendor/odm.
402 // As the modules with "odm_available: true" still create the vendor variants,
403 // they can link to the other vendor modules as the vendor_available modules do.
404 // Also, the vendor modules can link to odm_available modules.
405 //
406 // It may not be used for VNDK modules.
407 Odm_available *bool
408
Justin Yun63e9ec72020-10-29 16:49:43 +0900409 // whether this module should be allowed to be directly depended by other
410 // modules with `product_specific: true` or `product_available: true`.
411 // If set to true, an additional product variant will be built separately
412 // that is limited to the set of libraries and headers that are exposed to
413 // /product modules.
414 //
415 // The product variant may be used with a different (newer) /system,
416 // so it shouldn't have any unversioned runtime dependencies, or
417 // make assumptions about the system that may not be true in the
418 // future.
419 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900420 // If set to false, this module becomes inaccessible from /product modules.
421 //
422 // Different from the 'vendor_available' property, the modules with
423 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
424 // library without 'product_available' may not be depended on by any other
425 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900426 //
427 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
428 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
429 Product_available *bool
430
Jiyong Park5fb8c102018-04-09 12:03:06 +0900431 // whether this module is capable of being loaded with other instance
432 // (possibly an older version) of the same module in the same process.
433 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
434 // can be double loaded in a vendor process if the library is also a
435 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
436 // explicitly marked as `double_loadable: true` by the owner, or the dependency
437 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
438 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800439
440 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
441 IsLLNDK bool `blueprint:"mutated"`
442
Colin Cross78212242021-01-06 14:51:30 -0800443 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
444 // set and the module is not listed in VndkMustUseVendorVariantList.
445 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
446
447 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
448 IsVNDKCore bool `blueprint:"mutated"`
449
450 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
451 IsVNDKSP bool `blueprint:"mutated"`
452
453 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
454 // module sets the llndk.private property.
455 IsVNDKPrivate bool `blueprint:"mutated"`
456
457 // IsVNDKProduct is set if a VNDK module sets the product_available property.
458 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700459
460 // IsVendorPublicLibrary is set for the core and product variants of a library that has
461 // vendor_public_library stubs.
462 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800463}
464
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500465// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
466// to understanding details about the type of the current module.
467// For example, one might call these functions to determine whether the current module is a static
468// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800469type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800470 static() bool
471 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700472 testBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900473 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900474 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900475 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700476 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900477 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700478 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800479 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900480 minSdkVersion() string
481 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700482 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700483 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800484 IsLlndk() bool
485 IsLlndkPublic() bool
486 isImplementationForLLNDKPublic() bool
487 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900488 isVndk() bool
489 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500490 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700491 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900492 inProduct() bool
493 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800494 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700495 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900496 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700497 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700498 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800499 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800500 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800501 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800502 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800503 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700504 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700505 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900506 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800507 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700508 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700509 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800510 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800511 isCfiAssemblySupportEnabled() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800512}
513
514type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700515 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800516 ModuleContextIntf
517}
518
519type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700520 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800521 ModuleContextIntf
522}
523
Colin Cross37047f12016-12-13 17:06:13 -0800524type DepsContext interface {
525 android.BottomUpMutatorContext
526 ModuleContextIntf
527}
528
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500529// feature represents additional (optional) steps to building cc-related modules, such as invocation
530// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800531type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800532 flags(ctx ModuleContext, flags Flags) Flags
533 props() []interface{}
534}
535
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500536// compiler is the interface for a compiler helper object. Different module decorators may implement
537// this helper differently. For example, compiling a `cc_library` may use a different build
538// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800539type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700540 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800541 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800542 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700543 compilerProps() []interface{}
544
Colin Cross76fada02016-07-27 10:31:13 -0700545 appendCflags([]string)
546 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700547 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800548}
549
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500550// linker is the interface for a linker decorator object. Individual module types can provide
551// their own implementation for this decorator, and thus specify custom logic regarding build
552// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800553type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700554 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800555 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700556 linkerFlags(ctx ModuleContext, flags Flags) Flags
557 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800558 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700559
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700560 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700561 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900562 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700563
564 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900565 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000566
567 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000568 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
569}
570
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500571// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000572type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500573 sharedLibs []string
574 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
575 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700576 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800577}
578
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500579// installer is the interface for an installer helper object. This helper is responsible for
580// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800581type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700582 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700583 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000584 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800585 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700586 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700587 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900588 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100589 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900590 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800591}
592
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800593type xref interface {
594 XrefCcFiles() android.Paths
595}
596
Colin Cross6e511a92020-07-27 21:26:48 -0700597type libraryDependencyKind int
598
599const (
600 headerLibraryDependency = iota
601 sharedLibraryDependency
602 staticLibraryDependency
603)
604
605func (k libraryDependencyKind) String() string {
606 switch k {
607 case headerLibraryDependency:
608 return "headerLibraryDependency"
609 case sharedLibraryDependency:
610 return "sharedLibraryDependency"
611 case staticLibraryDependency:
612 return "staticLibraryDependency"
613 default:
614 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
615 }
616}
617
618type libraryDependencyOrder int
619
620const (
621 earlyLibraryDependency = -1
622 normalLibraryDependency = 0
623 lateLibraryDependency = 1
624)
625
626func (o libraryDependencyOrder) String() string {
627 switch o {
628 case earlyLibraryDependency:
629 return "earlyLibraryDependency"
630 case normalLibraryDependency:
631 return "normalLibraryDependency"
632 case lateLibraryDependency:
633 return "lateLibraryDependency"
634 default:
635 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
636 }
637}
638
639// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
640// tags that have a set of predefined tag objects that are reused for each dependency, a
641// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
642// That means that comparing a libraryDependencyTag for equality will only be equal if all
643// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
644// then check individual metadata fields instead.
645type libraryDependencyTag struct {
646 blueprint.BaseDependencyTag
647
648 // These are exported so that fmt.Printf("%#v") can call their String methods.
649 Kind libraryDependencyKind
650 Order libraryDependencyOrder
651
652 wholeStatic bool
653
654 reexportFlags bool
655 explicitlyVersioned bool
656 dataLib bool
657 ndk bool
658
659 staticUnwinder bool
660
661 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900662
Cindy Zhou18417cb2020-12-10 07:12:38 -0800663 // Whether or not this dependency should skip the apex dependency check
664 skipApexAllowedDependenciesCheck bool
665
Jiyong Parke3867542020-12-03 17:28:25 +0900666 // Whether or not this dependency has to be followed for the apex variants
667 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700668}
669
670// header returns true if the libraryDependencyTag is tagging a header lib dependency.
671func (d libraryDependencyTag) header() bool {
672 return d.Kind == headerLibraryDependency
673}
674
675// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
676func (d libraryDependencyTag) shared() bool {
677 return d.Kind == sharedLibraryDependency
678}
679
680// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
681func (d libraryDependencyTag) static() bool {
682 return d.Kind == staticLibraryDependency
683}
684
Colin Crosse9fe2942020-11-10 18:12:15 -0800685// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
686// binaries or other shared libraries are installed as dependencies.
687func (d libraryDependencyTag) InstallDepNeeded() bool {
688 return d.shared()
689}
690
691var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
692
693// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700694// libraryDependencyTag. Each tag object is created globally and reused for multiple
695// dependencies (although since the object contains no references, assigning a tag to a
696// variable and modifying it will not modify the original). Users can compare the tag
697// returned by ctx.OtherModuleDependencyTag against the global original
698type dependencyTag struct {
699 blueprint.BaseDependencyTag
700 name string
701}
702
Colin Crosse9fe2942020-11-10 18:12:15 -0800703// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
704// libraryDependencyTag, but where the dependency needs to be installed when the parent is
705// installed.
706type installDependencyTag struct {
707 blueprint.BaseDependencyTag
708 android.InstallAlwaysNeededDependencyTag
709 name string
710}
711
Colin Crossc99deeb2016-04-11 15:06:20 -0700712var (
Colin Cross6e511a92020-07-27 21:26:48 -0700713 genSourceDepTag = dependencyTag{name: "gen source"}
714 genHeaderDepTag = dependencyTag{name: "gen header"}
715 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
716 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900717 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700718 reuseObjTag = dependencyTag{name: "reuse objects"}
719 staticVariantTag = dependencyTag{name: "static variant"}
720 vndkExtDepTag = dependencyTag{name: "vndk extends"}
721 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800722 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700723 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700724 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700725)
726
Roland Levillainf89cd092019-07-29 16:22:59 +0100727func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700728 ccLibDepTag, ok := depTag.(libraryDependencyTag)
729 return ok && ccLibDepTag.shared()
730}
731
732func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
733 ccLibDepTag, ok := depTag.(libraryDependencyTag)
734 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100735}
736
Zach Johnson3df4e632020-11-06 11:56:27 -0800737func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
738 ccLibDepTag, ok := depTag.(libraryDependencyTag)
739 return ok && ccLibDepTag.header()
740}
741
Roland Levillainf89cd092019-07-29 16:22:59 +0100742func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800743 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100744}
745
746func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700747 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100748 return ok && ccDepTag == testPerSrcDepTag
749}
750
Colin Crossca860ac2016-01-04 14:34:37 -0800751// Module contains the properties and members used by all C/C++ module types, and implements
752// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500753// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
754// interface.
755//
756// To define a C/C++ related module, construct a new Module object and point its delegates to
757// type-specific structs. These delegates will be invoked to register module-specific build
758// statements which may be unique to the module type. For example, module.compiler.compile() should
759// be defined so as to register build statements which are responsible for compiling the module.
760//
761// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
762// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
763// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
764// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800765type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700766 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700767
Jiyong Parkd1063c12019-07-17 20:08:41 +0900768 android.SdkBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500769 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700770
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700771 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700772 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700773
Colin Crossca860ac2016-01-04 14:34:37 -0800774 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700775 hod android.HostOrDeviceSupported
776 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700777
Paul Duffina0843f62019-12-13 19:50:38 +0000778 // Allowable SdkMemberTypes of this module type.
779 sdkMemberTypes []android.SdkMemberType
780
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500781 // decorator delegates, initialize before calling Init
782 // these may contain module-specific implementations, and effectively allow for custom
783 // type-specific logic. These members may reference different objects or the same object.
784 // Functions of these decorators will be invoked to initialize and register type-specific
785 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500786 compiler compiler
787 linker linker
788 installer installer
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000789 bazelHandler android.BazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500790
791 features []feature
792 stl *stl
793 sanitize *sanitize
794 coverage *coverage
795 sabi *sabi
796 vndkdep *vndkdep
797 lto *lto
798 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800799
Colin Cross31076b32020-10-23 17:22:06 -0700800 library libraryInterface
801
Colin Cross635c3b02016-05-18 15:37:25 -0700802 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800803
Colin Crossb98c8b02016-07-29 13:44:28 -0700804 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700805
806 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800807
808 // Flags used to compile this module
809 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700810
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800811 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700812 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900813
814 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800815 // Kythe (source file indexer) paths for this compilation module
816 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900817
818 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700819 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700820
821 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700822}
823
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200824func (c *Module) AddJSONData(d *map[string]interface{}) {
825 c.AndroidModuleBase().AddJSONData(d)
826 (*d)["Cc"] = map[string]interface{}{
827 "SdkVersion": c.SdkVersion(),
828 "MinSdkVersion": c.MinSdkVersion(),
829 "VndkVersion": c.VndkVersion(),
830 "ProductSpecific": c.ProductSpecific(),
831 "SocSpecific": c.SocSpecific(),
832 "DeviceSpecific": c.DeviceSpecific(),
833 "InProduct": c.InProduct(),
834 "InVendor": c.InVendor(),
835 "InRamdisk": c.InRamdisk(),
836 "InVendorRamdisk": c.InVendorRamdisk(),
837 "InRecovery": c.InRecovery(),
838 "VendorAvailable": c.VendorAvailable(),
839 "ProductAvailable": c.ProductAvailable(),
840 "RamdiskAvailable": c.RamdiskAvailable(),
841 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
842 "RecoveryAvailable": c.RecoveryAvailable(),
843 "OdmAvailable": c.OdmAvailable(),
844 "InstallInData": c.InstallInData(),
845 "InstallInRamdisk": c.InstallInRamdisk(),
846 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
847 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
848 "InstallInRecovery": c.InstallInRecovery(),
849 "InstallInRoot": c.InstallInRoot(),
850 "IsVndk": c.IsVndk(),
851 "IsVndkExt": c.IsVndkExt(),
852 "IsVndkPrivate": c.IsVndkPrivate(),
853 "IsVndkSp": c.IsVndkSp(),
854 "IsLlndk": c.IsLlndk(),
855 "IsLlndkPublic": c.IsLlndkPublic(),
856 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
857 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
858 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
859 "ApexSdkVersion": c.apexSdkVersion,
860 "TestFor": c.TestFor(),
861 }
862}
863
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500864func (c *Module) SetPreventInstall() {
865 c.Properties.PreventInstall = true
866}
867
868func (c *Module) SetHideFromMake() {
869 c.Properties.HideFromMake = true
870}
871
Ivan Lozanod7586b62021-04-01 09:49:36 -0400872func (c *Module) HiddenFromMake() bool {
873 return c.Properties.HideFromMake
874}
875
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800876func (c *Module) RequiredModuleNames() []string {
877 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
878 if c.ImageVariation().Variation == android.CoreVariation {
879 required = append(required, c.Properties.Target.Platform.Required...)
880 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
881 } else if c.InRecovery() {
882 required = append(required, c.Properties.Target.Recovery.Required...)
883 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
884 }
885 return android.FirstUniqueStrings(required)
886}
887
Ivan Lozano52767be2019-10-18 14:49:46 -0700888func (c *Module) Toc() android.OptionalPath {
889 if c.linker != nil {
890 if library, ok := c.linker.(libraryInterface); ok {
891 return library.toc()
892 }
893 }
894 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
895}
896
897func (c *Module) ApiLevel() string {
898 if c.linker != nil {
899 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700900 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700901 }
902 }
903 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
904}
905
906func (c *Module) Static() bool {
907 if c.linker != nil {
908 if library, ok := c.linker.(libraryInterface); ok {
909 return library.static()
910 }
911 }
912 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
913}
914
915func (c *Module) Shared() bool {
916 if c.linker != nil {
917 if library, ok := c.linker.(libraryInterface); ok {
918 return library.shared()
919 }
920 }
921 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
922}
923
924func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000925 if c.stl != nil {
926 return c.stl.Properties.SelectedStl
927 }
928 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700929}
930
931func (c *Module) ToolchainLibrary() bool {
932 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
933 return true
934 }
935 return false
936}
937
938func (c *Module) NdkPrebuiltStl() bool {
939 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
940 return true
941 }
942 return false
943}
944
945func (c *Module) StubDecorator() bool {
946 if _, ok := c.linker.(*stubDecorator); ok {
947 return true
948 }
949 return false
950}
951
952func (c *Module) SdkVersion() string {
953 return String(c.Properties.Sdk_version)
954}
955
Artur Satayev480e25b2020-04-27 18:53:18 +0100956func (c *Module) MinSdkVersion() string {
957 return String(c.Properties.Min_sdk_version)
958}
959
Dan Albert92fe7402020-07-15 13:33:30 -0700960func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700961 if !c.canUseSdk() {
962 return false
963 }
Dan Albert92fe7402020-07-15 13:33:30 -0700964 if linker, ok := c.linker.(*objectLinker); ok {
965 return linker.isCrt()
966 }
967 return false
968}
969
Colin Crossc511bc52020-04-07 16:50:32 +0000970func (c *Module) AlwaysSdk() bool {
971 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
972}
973
Ivan Lozano183a3212019-10-18 14:18:45 -0700974func (c *Module) CcLibrary() bool {
975 if c.linker != nil {
976 if _, ok := c.linker.(*libraryDecorator); ok {
977 return true
978 }
Colin Crossd48fe732020-09-23 20:37:24 -0700979 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
980 return true
981 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700982 }
983 return false
984}
985
986func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700987 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700988 return true
989 }
990 return false
991}
992
Ivan Lozano2b262972019-11-21 12:30:50 -0800993func (c *Module) NonCcVariants() bool {
994 return false
995}
996
Ivan Lozano183a3212019-10-18 14:18:45 -0700997func (c *Module) SetStatic() {
998 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700999 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001000 library.setStatic()
1001 return
1002 }
1003 }
1004 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1005}
1006
1007func (c *Module) SetShared() {
1008 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001009 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001010 library.setShared()
1011 return
1012 }
1013 }
1014 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1015}
1016
1017func (c *Module) BuildStaticVariant() bool {
1018 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001019 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001020 return library.buildStatic()
1021 }
1022 }
1023 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1024}
1025
1026func (c *Module) BuildSharedVariant() bool {
1027 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001028 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001029 return library.buildShared()
1030 }
1031 }
1032 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1033}
1034
1035func (c *Module) Module() android.Module {
1036 return c
1037}
1038
Jiyong Parkc20eee32018-09-05 22:36:17 +09001039func (c *Module) OutputFile() android.OptionalPath {
1040 return c.outputFile
1041}
1042
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001043func (c *Module) CoverageFiles() android.Paths {
1044 if c.linker != nil {
1045 if library, ok := c.linker.(libraryInterface); ok {
1046 return library.objs().coverageFiles
1047 }
1048 }
1049 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1050}
1051
Ivan Lozano183a3212019-10-18 14:18:45 -07001052var _ LinkableInterface = (*Module)(nil)
1053
Jiyong Park719b4462019-01-13 00:39:51 +09001054func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001055 if c.linker != nil {
1056 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001057 }
1058 return nil
1059}
1060
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001061func (c *Module) CoverageOutputFile() android.OptionalPath {
1062 if c.linker != nil {
1063 return c.linker.coverageOutputFilePath()
1064 }
1065 return android.OptionalPath{}
1066}
1067
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001068func (c *Module) RelativeInstallPath() string {
1069 if c.installer != nil {
1070 return c.installer.relativeInstallPath()
1071 }
1072 return ""
1073}
1074
Jooyung Han344d5432019-08-23 11:17:39 +09001075func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001076 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001077}
1078
Colin Cross36242852017-06-23 15:06:31 -07001079func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001080 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001081 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001082 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001083 }
1084 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001085 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001086 }
1087 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001088 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001089 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001090 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001091 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001092 }
Colin Cross16b23492016-01-06 14:41:07 -08001093 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001094 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001095 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001096 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001097 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001098 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001099 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001100 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001101 }
Justin Yun8effde42017-06-23 19:24:43 +09001102 if c.vndkdep != nil {
1103 c.AddProperties(c.vndkdep.props()...)
1104 }
Stephen Craneba090d12017-05-09 15:44:35 -07001105 if c.lto != nil {
1106 c.AddProperties(c.lto.props()...)
1107 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001108 if c.pgo != nil {
1109 c.AddProperties(c.pgo.props()...)
1110 }
Colin Crossca860ac2016-01-04 14:34:37 -08001111 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001112 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001113 }
Colin Crossc472d572015-03-17 15:06:21 -07001114
Colin Cross36242852017-06-23 15:06:31 -07001115 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerea6666f2021-02-17 10:17:28 -05001116 android.InitBazelModule(c)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001117 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001118 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001119 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001120
Colin Cross36242852017-06-23 15:06:31 -07001121 return c
Colin Crossc472d572015-03-17 15:06:21 -07001122}
1123
Ivan Lozano52767be2019-10-18 14:49:46 -07001124func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001125 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001126}
1127
Colin Crossc511bc52020-04-07 16:50:32 +00001128func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001129 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1130 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001131}
1132
1133func (c *Module) UseSdk() bool {
1134 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001135 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001136 }
1137 return false
1138}
1139
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001140func (c *Module) isCoverageVariant() bool {
1141 return c.coverage.Properties.IsCoverageVariant
1142}
1143
Colin Cross95f1ca02020-10-29 20:47:22 -07001144func (c *Module) IsNdk(config android.Config) bool {
1145 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001146}
1147
Colin Cross127bb8b2020-12-16 16:46:01 -08001148func (c *Module) IsLlndk() bool {
1149 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001150}
1151
Colin Cross127bb8b2020-12-16 16:46:01 -08001152func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001153 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001154}
1155
Colin Cross1f3f1302021-04-26 18:37:44 -07001156func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001157 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001158 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001159}
1160
Colin Cross5271fea2021-04-27 13:06:04 -07001161func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1162 lib := moduleLibraryInterface(m)
1163 return lib != nil && (lib.hasVendorPublicLibrary())
1164}
1165
1166// IsVendorPublicLibrary returns true for vendor public libraries.
1167func (c *Module) IsVendorPublicLibrary() bool {
1168 return c.VendorProperties.IsVendorPublicLibrary
1169}
1170
Ivan Lozanod7586b62021-04-01 09:49:36 -04001171func (c *Module) HasLlndkStubs() bool {
1172 lib := moduleLibraryInterface(c)
1173 return lib != nil && lib.hasLLNDKStubs()
1174}
1175
1176func (c *Module) StubsVersion() string {
1177 if lib, ok := c.linker.(versionedInterface); ok {
1178 return lib.stubsVersion()
1179 }
1180 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1181}
1182
Colin Cross127bb8b2020-12-16 16:46:01 -08001183// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1184// and does not set llndk.vendor_available: false.
1185func (c *Module) isImplementationForLLNDKPublic() bool {
1186 library, _ := c.library.(*libraryDecorator)
1187 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001188 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001189}
1190
Justin Yunfd9e8042020-12-23 18:23:14 +09001191// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001192func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001193 // Check if VNDK-core-private or VNDK-SP-private
1194 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001195 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001196 }
1197
1198 // Check if LLNDK-private
1199 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001200 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001201 }
1202
1203 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001204}
1205
Ivan Lozano52767be2019-10-18 14:49:46 -07001206func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001207 if vndkdep := c.vndkdep; vndkdep != nil {
1208 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001209 }
1210 return false
1211}
1212
Yi Kong7e53c572018-02-14 18:16:12 +08001213func (c *Module) isPgoCompile() bool {
1214 if pgo := c.pgo; pgo != nil {
1215 return pgo.Properties.PgoCompile
1216 }
1217 return false
1218}
1219
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001220func (c *Module) isNDKStubLibrary() bool {
1221 if _, ok := c.compiler.(*stubDecorator); ok {
1222 return true
1223 }
1224 return false
1225}
1226
Ivan Lozanod7586b62021-04-01 09:49:36 -04001227func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001228 if vndkdep := c.vndkdep; vndkdep != nil {
1229 return vndkdep.isVndkSp()
1230 }
1231 return false
1232}
1233
Ivan Lozanof9e21722020-12-02 09:00:51 -05001234func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001235 if vndkdep := c.vndkdep; vndkdep != nil {
1236 return vndkdep.isVndkExt()
1237 }
1238 return false
1239}
1240
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001241func (c *Module) SubName() string {
1242 return c.Properties.SubName
1243}
1244
Ivan Lozano52767be2019-10-18 14:49:46 -07001245func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001246 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001247}
1248
Logan Chienf3511742017-10-31 18:04:35 +08001249func (c *Module) getVndkExtendsModuleName() string {
1250 if vndkdep := c.vndkdep; vndkdep != nil {
1251 return vndkdep.getVndkExtendsModuleName()
1252 }
1253 return ""
1254}
1255
Jiyong Park25fc6a92018-11-18 18:02:45 +09001256func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001257 if lib := c.library; lib != nil {
1258 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001259 }
1260 return false
1261}
1262
1263func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001264 if lib := c.library; lib != nil {
1265 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001266 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001267 return false
1268}
1269
Colin Cross0477b422020-10-13 18:43:54 -07001270// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1271// the implementation. If it is an implementation library it returns its own name.
1272func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1273 name := ctx.OtherModuleName(c)
1274 if versioned, ok := c.linker.(versionedInterface); ok {
1275 name = versioned.implementationModuleName(name)
1276 }
1277 return name
1278}
1279
Martin Stjernholm2856c662020-12-02 15:03:42 +00001280// Similar to ImplementationModuleName, but uses the Make variant of the module
1281// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1282// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1283// under the premise that the prebuilt module overrides its source counterpart
1284// if it is exposed to Make).
1285func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1286 name := c.BaseModuleName()
1287 if versioned, ok := c.linker.(versionedInterface); ok {
1288 name = versioned.implementationModuleName(name)
1289 }
1290 return name
1291}
1292
Jiyong Park7d55b612021-06-11 17:22:09 +09001293func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001294 return Bool(c.Properties.Bootstrap)
1295}
1296
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001297func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001298 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1299 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1300 return false
1301 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001302 return c.linker != nil && c.linker.nativeCoverage()
1303}
1304
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001305func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001306 if p, ok := c.linker.(SnapshotInterface); ok {
1307 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001308 }
1309 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001310}
1311
Bill Peckham945441c2020-08-31 16:07:58 -07001312func (c *Module) ExcludeFromVendorSnapshot() bool {
1313 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1314}
1315
Jose Galmesf7294582020-11-13 12:07:36 -08001316func (c *Module) ExcludeFromRecoverySnapshot() bool {
1317 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1318}
1319
Jiyong Parkf1194352019-02-25 11:05:47 +09001320func isBionic(name string) bool {
1321 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001322 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001323 return true
1324 }
1325 return false
1326}
1327
Martin Stjernholm279de572019-09-10 23:18:20 +01001328func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001329 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001330 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001331 }
1332 return isBionic(name)
1333}
1334
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001335func (c *Module) XrefCcFiles() android.Paths {
1336 return c.kytheFiles
1337}
1338
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001339func (c *Module) isCfiAssemblySupportEnabled() bool {
1340 return c.sanitize != nil &&
1341 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1342}
1343
Inseob Kim800d1142021-06-14 12:03:51 +09001344func (c *Module) InstallInRoot() bool {
1345 return c.installer != nil && c.installer.installInRoot()
1346}
1347
Colin Crossca860ac2016-01-04 14:34:37 -08001348type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001349 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001350 moduleContextImpl
1351}
1352
Colin Cross37047f12016-12-13 17:06:13 -08001353type depsContext struct {
1354 android.BottomUpMutatorContext
1355 moduleContextImpl
1356}
1357
Colin Crossca860ac2016-01-04 14:34:37 -08001358type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001359 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001360 moduleContextImpl
1361}
1362
1363type moduleContextImpl struct {
1364 mod *Module
1365 ctx BaseModuleContext
1366}
1367
Colin Crossb98c8b02016-07-29 13:44:28 -07001368func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001369 return ctx.mod.toolchain(ctx.ctx)
1370}
1371
1372func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001373 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001374}
1375
1376func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001377 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001378}
1379
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001380func (ctx *moduleContextImpl) testBinary() bool {
1381 return ctx.mod.testBinary()
1382}
1383
Jiyong Park1d1119f2019-07-29 21:27:18 +09001384func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001385 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001386}
1387
Inseob Kim7f283f42020-06-01 21:53:49 +09001388func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001389 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001390}
1391
Inseob Kim1042d292020-06-01 23:23:05 +09001392func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001393 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001394}
1395
Jooyung Hanccce2f22020-03-07 03:45:53 +09001396func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001397 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001398}
1399
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001400func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001401 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001402}
1403
1404func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001405 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001406 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001407 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001408 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001409 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001410 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001411 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001412 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001413 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001414 }
1415 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001416}
1417
Jiyong Parkb35a8192020-08-10 15:59:36 +09001418func (ctx *moduleContextImpl) minSdkVersion() string {
1419 ver := ctx.mod.MinSdkVersion()
1420 if ver == "apex_inherit" && !ctx.isForPlatform() {
1421 ver = ctx.apexSdkVersion().String()
1422 }
1423 if ver == "apex_inherit" || ver == "" {
1424 ver = ctx.sdkVersion()
1425 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001426 // For crt objects, the meaning of min_sdk_version is very different from other types of
1427 // module. For them, min_sdk_version defines the oldest version that the build system will
1428 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1429 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1430 // and min_sdk_version properties of the variants are set to the corresponding version
1431 // numbers. However, the platform (non-sdk) variant of the crt object is left untouched.
1432 // min_sdk_version: 16 doesn't actually mean that the platform variant has to support such
1433 // an old version. Since the variant is for the platform, it's preferred to target the
1434 // latest version.
1435 if ctx.mod.SplitPerApiLevel() && !ctx.isSdkVariant() {
1436 ver = strconv.Itoa(android.FutureApiLevelInt)
1437 }
1438
Jiyong Parkb35a8192020-08-10 15:59:36 +09001439 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1440 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1441 minSdkVersionInt, err2 := strconv.Atoi(ver)
1442 if err == nil && err2 == nil {
1443 if sdkVersionInt < minSdkVersionInt {
1444 return strconv.Itoa(sdkVersionInt)
1445 }
1446 }
1447 return ver
1448}
1449
1450func (ctx *moduleContextImpl) isSdkVariant() bool {
1451 return ctx.mod.IsSdkVariant()
1452}
1453
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001454func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001455 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001456}
Justin Yun8effde42017-06-23 19:24:43 +09001457
Colin Cross95f1ca02020-10-29 20:47:22 -07001458func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1459 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001460}
1461
Colin Cross127bb8b2020-12-16 16:46:01 -08001462func (ctx *moduleContextImpl) IsLlndk() bool {
1463 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001464}
1465
Colin Cross127bb8b2020-12-16 16:46:01 -08001466func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1467 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001468}
1469
Colin Cross127bb8b2020-12-16 16:46:01 -08001470func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1471 return ctx.mod.isImplementationForLLNDKPublic()
1472}
1473
1474func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1475 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001476}
1477
Logan Chienf3511742017-10-31 18:04:35 +08001478func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001479 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001480}
1481
Yi Kong7e53c572018-02-14 18:16:12 +08001482func (ctx *moduleContextImpl) isPgoCompile() bool {
1483 return ctx.mod.isPgoCompile()
1484}
1485
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001486func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1487 return ctx.mod.isNDKStubLibrary()
1488}
1489
Justin Yun8effde42017-06-23 19:24:43 +09001490func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001491 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001492}
1493
Ivan Lozanof9e21722020-12-02 09:00:51 -05001494func (ctx *moduleContextImpl) IsVndkExt() bool {
1495 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001496}
1497
Colin Cross5271fea2021-04-27 13:06:04 -07001498func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1499 return ctx.mod.IsVendorPublicLibrary()
1500}
1501
Vic Yangefd249e2018-11-12 20:19:56 -08001502func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001503 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001504}
1505
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001506func (ctx *moduleContextImpl) selectedStl() string {
1507 if stl := ctx.mod.stl; stl != nil {
1508 return stl.Properties.SelectedStl
1509 }
1510 return ""
1511}
1512
Ivan Lozanobd721262018-11-27 14:33:03 -08001513func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1514 return ctx.mod.linker.useClangLld(actx)
1515}
1516
Colin Crossce75d2c2016-10-06 16:12:58 -07001517func (ctx *moduleContextImpl) baseModuleName() string {
1518 return ctx.mod.ModuleBase.BaseModuleName()
1519}
1520
Logan Chienf3511742017-10-31 18:04:35 +08001521func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1522 return ctx.mod.getVndkExtendsModuleName()
1523}
1524
Logan Chiene274fc92019-12-03 11:18:32 -08001525func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001526 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001527}
1528
Colin Crosse07f2312020-08-13 11:24:56 -07001529func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001530 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001531}
1532
Dan Albertc8060532020-07-22 22:32:17 -07001533func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001534 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001535}
1536
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001537func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001538 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001539}
1540
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001541func (ctx *moduleContextImpl) nativeCoverage() bool {
1542 return ctx.mod.nativeCoverage()
1543}
1544
Colin Cross56a83212020-09-15 18:30:11 -07001545func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1546 return ctx.mod.DirectlyInAnyApex()
1547}
1548
Colin Cross95b07f22020-12-16 11:06:50 -08001549func (ctx *moduleContextImpl) isPreventInstall() bool {
1550 return ctx.mod.Properties.PreventInstall
1551}
1552
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001553func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1554 return ctx.mod.isCfiAssemblySupportEnabled()
1555}
1556
Colin Cross635c3b02016-05-18 15:37:25 -07001557func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001558 return &Module{
1559 hod: hod,
1560 multilib: multilib,
1561 }
1562}
1563
Colin Cross635c3b02016-05-18 15:37:25 -07001564func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001565 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001566 module.features = []feature{
1567 &tidyFeature{},
1568 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001569 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001570 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001571 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001572 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001573 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001574 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001575 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001576 return module
1577}
1578
Colin Crossce75d2c2016-10-06 16:12:58 -07001579func (c *Module) Prebuilt() *android.Prebuilt {
1580 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1581 return p.prebuilt()
1582 }
1583 return nil
1584}
1585
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001586func (c *Module) IsPrebuilt() bool {
1587 return c.Prebuilt() != nil
1588}
1589
Colin Crossce75d2c2016-10-06 16:12:58 -07001590func (c *Module) Name() string {
1591 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001592 if p, ok := c.linker.(interface {
1593 Name(string) string
1594 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001595 name = p.Name(name)
1596 }
1597 return name
1598}
1599
Alex Light3d673592019-01-18 14:37:31 -08001600func (c *Module) Symlinks() []string {
1601 if p, ok := c.installer.(interface {
1602 symlinkList() []string
1603 }); ok {
1604 return p.symlinkList()
1605 }
1606 return nil
1607}
1608
Roland Levillainf89cd092019-07-29 16:22:59 +01001609func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1610 test, ok := c.linker.(testPerSrc)
1611 return ok && test.isAllTestsVariation()
1612}
1613
Chris Parsons216e10a2020-07-09 17:12:52 -04001614func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001615 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001616 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001617 }); ok {
1618 return p.dataPaths()
1619 }
1620 return nil
1621}
1622
Justin Yun5f7f7e82019-11-18 19:52:14 +09001623func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1624 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1625 // "current", it will append the VNDK version to the name suffix.
1626 var vndkVersion string
1627 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001628 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001629 if c.ProductSpecific() {
1630 // If the module is product specific with 'product_specific: true',
1631 // do not add a name suffix because it is a base module.
1632 return ""
1633 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001634 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
Matthew Maurer52af5b02021-05-27 10:01:36 -07001635 nameSuffix = ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001636 } else {
1637 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001638 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001639 }
1640 if vndkVersion == "current" {
1641 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1642 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001643 if c.Properties.VndkVersion != vndkVersion && c.Properties.VndkVersion != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001644 // add version suffix only if the module is using different vndk version than the
1645 // version in product or vendor partition.
1646 nameSuffix += "." + c.Properties.VndkVersion
1647 }
1648 return nameSuffix
1649}
1650
Chris Parsons8d6e4332021-02-22 16:13:50 -05001651func (c *Module) setSubnameProperty(actx android.ModuleContext) {
Inseob Kim64c43952019-08-26 16:52:35 +09001652 c.Properties.SubName = ""
1653
1654 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07001655 c.Properties.SubName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001656 }
1657
Colin Cross127bb8b2020-12-16 16:46:01 -08001658 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001659 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001660 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1661 // added for product variant only when we have vendor and product variants with core
1662 // variant. The suffix is not added for vendor-only or product-only module.
1663 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
Colin Cross5271fea2021-04-27 13:06:04 -07001664 } else if c.IsVendorPublicLibrary() {
1665 c.Properties.SubName += vendorPublicLibrarySuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001666 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001667 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1668 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001669 c.Properties.SubName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001670 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07001671 c.Properties.SubName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001672 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001673 c.Properties.SubName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001674 } else if c.InRecovery() && !c.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08001675 c.Properties.SubName += RecoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001676 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001677 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001678 if c.SplitPerApiLevel() {
1679 c.Properties.SubName += "." + c.SdkVersion()
1680 }
Inseob Kim64c43952019-08-26 16:52:35 +09001681 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001682}
1683
1684// Returns true if Bazel was successfully used for the analysis of this module.
1685func (c *Module) maybeGenerateBazelActions(actx android.ModuleContext) bool {
Liz Kammerbdc60992021-02-24 16:55:11 -05001686 bazelModuleLabel := c.GetBazelLabel(actx, c)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001687 bazelActionsUsed := false
Chris Parsonsbab4d7e2021-04-15 17:27:08 -04001688 if c.MixedBuildsEnabled(actx) && c.bazelHandler != nil {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +00001689 bazelActionsUsed = c.bazelHandler.GenerateBazelBuildActions(actx, bazelModuleLabel)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001690 }
1691 return bazelActionsUsed
1692}
1693
1694func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1695 // TODO(cparsons): Any logic in this method occurring prior to querying Bazel should be
1696 // requested from Bazel instead.
1697
1698 // Handle the case of a test module split by `test_per_src` mutator.
1699 //
1700 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1701 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1702 // module and return early, as this module does not produce an output file per se.
1703 if c.IsTestPerSrcAllTestsVariation() {
1704 c.outputFile = android.OptionalPath{}
1705 return
1706 }
1707
1708 c.setSubnameProperty(actx)
1709 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1710 if !apexInfo.IsForPlatform() {
1711 c.hideApexVariantFromMake = true
1712 }
1713
Chris Parsonseefc9e62021-04-02 17:36:47 -04001714 c.makeLinkType = GetMakeLinkType(actx, c)
1715
Colin Crossca860ac2016-01-04 14:34:37 -08001716 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001717 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001718 moduleContextImpl: moduleContextImpl{
1719 mod: c,
1720 },
1721 }
1722 ctx.ctx = ctx
1723
Chris Parsons94a0bba2021-06-04 15:03:47 -04001724 if c.maybeGenerateBazelActions(actx) {
1725 c.maybeInstall(ctx, apexInfo)
1726 return
1727 }
1728
Colin Crossf18e1102017-11-16 14:33:08 -08001729 deps := c.depsToPaths(ctx)
1730 if ctx.Failed() {
1731 return
1732 }
1733
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001734 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1735 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1736 }
1737
Colin Crossca860ac2016-01-04 14:34:37 -08001738 flags := Flags{
1739 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001740 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001741 }
Colin Crossca860ac2016-01-04 14:34:37 -08001742 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001743 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001744 }
1745 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001746 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001747 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001748 if c.stl != nil {
1749 flags = c.stl.flags(ctx, flags)
1750 }
Colin Cross16b23492016-01-06 14:41:07 -08001751 if c.sanitize != nil {
1752 flags = c.sanitize.flags(ctx, flags)
1753 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001754 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001755 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001756 }
Stephen Craneba090d12017-05-09 15:44:35 -07001757 if c.lto != nil {
1758 flags = c.lto.flags(ctx, flags)
1759 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001760 if c.pgo != nil {
1761 flags = c.pgo.flags(ctx, flags)
1762 }
Colin Crossca860ac2016-01-04 14:34:37 -08001763 for _, feature := range c.features {
1764 flags = feature.flags(ctx, flags)
1765 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001766 if ctx.Failed() {
1767 return
1768 }
1769
Colin Cross4af21ed2019-11-04 09:37:55 -08001770 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1771 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1772 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001773
Colin Cross4af21ed2019-11-04 09:37:55 -08001774 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001775
1776 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001777 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001778 }
1779 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001780 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001781 }
1782
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001783 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001784 // We need access to all the flags seen by a source file.
1785 if c.sabi != nil {
1786 flags = c.sabi.flags(ctx, flags)
1787 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001788
Colin Cross4af21ed2019-11-04 09:37:55 -08001789 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001790
Colin Crossca860ac2016-01-04 14:34:37 -08001791 // Optimization to reduce size of build.ninja
1792 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001793 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1794 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1795 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1796 flags.Local.CFlags = []string{"$cflags"}
1797 flags.Local.CppFlags = []string{"$cppflags"}
1798 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001799
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001800 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001801 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001802 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001803 if ctx.Failed() {
1804 return
1805 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001806 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001807 }
1808
Colin Crossca860ac2016-01-04 14:34:37 -08001809 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001810 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001811 if ctx.Failed() {
1812 return
1813 }
Colin Cross635c3b02016-05-18 15:37:25 -07001814 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001815
Chris Parsons94a0bba2021-06-04 15:03:47 -04001816 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001817
Jose Galmes6f843bc2020-12-11 13:36:29 -08001818 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
1819 // RECOVERY_SNAPSHOT_VERSION is current.
1820 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001821 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001822 i.collectHeadersForSnapshot(ctx)
1823 }
1824 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001825 }
Colin Cross5049f022015-03-18 13:28:46 -07001826
Chris Parsons94a0bba2021-06-04 15:03:47 -04001827 c.maybeInstall(ctx, apexInfo)
1828}
1829
1830func (c *Module) maybeUnhideFromMake() {
1831 // If a lib is directly included in any of the APEXes or is not available to the
1832 // platform (which is often the case when the stub is provided as a prebuilt),
1833 // unhide the stubs variant having the latest version gets visible to make. In
1834 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1835 // force anything in the make world to link against the stubs library. (unless it
1836 // is explicitly referenced via .bootstrap suffix or the module is marked with
1837 // 'bootstrap: true').
1838 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
1839 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
1840 c.IsStubs() && !c.InVendorRamdisk() {
1841 c.Properties.HideFromMake = false // unhide
1842 // Note: this is still non-installable
1843 }
1844}
1845
1846func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001847 if !proptools.BoolDefault(c.Properties.Installable, true) {
1848 // If the module has been specifically configure to not be installed then
1849 // hide from make as otherwise it will break when running inside make
1850 // as the output path to install will not be specified. Not all uninstallable
1851 // modules can be hidden from make as some are needed for resolving make side
1852 // dependencies.
1853 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001854 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001855 c.SkipInstall()
1856 }
1857
1858 // Still call c.installer.install though, the installs will be stored as PackageSpecs
1859 // to allow using the outputs in a genrule.
1860 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001861 c.installer.install(ctx, c.outputFile.Path())
1862 if ctx.Failed() {
1863 return
Colin Crossca860ac2016-01-04 14:34:37 -08001864 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001865 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001866}
1867
Colin Cross0ea8ba82019-06-06 14:33:29 -07001868func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001869 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05001870 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08001871 }
Colin Crossca860ac2016-01-04 14:34:37 -08001872 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001873}
1874
Colin Crossca860ac2016-01-04 14:34:37 -08001875func (c *Module) begin(ctx BaseModuleContext) {
1876 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001877 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001878 }
Colin Crossca860ac2016-01-04 14:34:37 -08001879 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001880 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001881 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001882 if c.stl != nil {
1883 c.stl.begin(ctx)
1884 }
Colin Cross16b23492016-01-06 14:41:07 -08001885 if c.sanitize != nil {
1886 c.sanitize.begin(ctx)
1887 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001888 if c.coverage != nil {
1889 c.coverage.begin(ctx)
1890 }
Stephen Craneba090d12017-05-09 15:44:35 -07001891 if c.lto != nil {
1892 c.lto.begin(ctx)
1893 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001894 if c.pgo != nil {
1895 c.pgo.begin(ctx)
1896 }
Dan Albert92fe7402020-07-15 13:33:30 -07001897 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001898 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001899 if err != nil {
1900 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001901 c.Properties.Sdk_version = nil
1902 } else {
1903 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001904 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001905 }
Colin Crossca860ac2016-01-04 14:34:37 -08001906}
1907
Colin Cross37047f12016-12-13 17:06:13 -08001908func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001909 deps := Deps{}
1910
1911 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001912 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001913 }
1914 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001915 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001916 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001917 if c.stl != nil {
1918 deps = c.stl.deps(ctx, deps)
1919 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001920 if c.coverage != nil {
1921 deps = c.coverage.deps(ctx, deps)
1922 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001923
Colin Crossb6715442017-10-24 11:13:31 -07001924 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1925 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1926 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1927 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1928 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1929 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001930 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001931
Liz Kammer356f7d42021-01-26 09:18:53 -05001932 // In Bazel conversion mode, we dependency and build validations will occur in Bazel, so there is
1933 // no need to do so in Soong.
1934 if ctx.BazelConversionMode() {
1935 return deps
1936 }
1937
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001938 for _, lib := range deps.ReexportSharedLibHeaders {
1939 if !inList(lib, deps.SharedLibs) {
1940 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1941 }
1942 }
1943
1944 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00001945 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
1946 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 -07001947 }
1948 }
1949
Colin Cross5950f382016-12-13 12:50:57 -08001950 for _, lib := range deps.ReexportHeaderLibHeaders {
1951 if !inList(lib, deps.HeaderLibs) {
1952 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1953 }
1954 }
1955
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001956 for _, gen := range deps.ReexportGeneratedHeaders {
1957 if !inList(gen, deps.GeneratedHeaders) {
1958 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1959 }
1960 }
1961
Colin Crossc99deeb2016-04-11 15:06:20 -07001962 return deps
1963}
1964
Dan Albert7e9d2952016-08-04 13:02:36 -07001965func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001966 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001967 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001968 moduleContextImpl: moduleContextImpl{
1969 mod: c,
1970 },
1971 }
1972 ctx.ctx = ctx
1973
Colin Crossca860ac2016-01-04 14:34:37 -08001974 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001975}
1976
Jiyong Park7ed9de32018-10-15 22:25:07 +09001977// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001978func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001979 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1980 version := name[sharp+1:]
1981 libname := name[:sharp]
1982 return libname, version
1983 }
1984 return name, ""
1985}
1986
Dan Albert92fe7402020-07-15 13:33:30 -07001987func GetCrtVariations(ctx android.BottomUpMutatorContext,
1988 m LinkableInterface) []blueprint.Variation {
1989 if ctx.Os() != android.Android {
1990 return nil
1991 }
1992 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001993 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
1994 minSdkVersion := m.MinSdkVersion()
1995 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
1996 minSdkVersion = m.SdkVersion()
1997 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09001998 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
1999 if err != nil {
2000 ctx.PropertyErrorf("min_sdk_version", err.Error())
2001 }
Dan Albert92fe7402020-07-15 13:33:30 -07002002 return []blueprint.Variation{
2003 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002004 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002005 }
2006 }
2007 return []blueprint.Variation{
2008 {Mutator: "sdk", Variation: ""},
2009 }
2010}
2011
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002012func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2013 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002014
2015 variations = append([]blueprint.Variation(nil), variations...)
2016
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002017 if version != "" && CanBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002018 // Version is explicitly specified. i.e. libFoo#30
2019 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002020 if tag, ok := depTag.(libraryDependencyTag); ok {
2021 tag.explicitlyVersioned = true
2022 } else {
2023 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2024 }
Colin Crosse7257d22020-09-24 09:56:18 -07002025 }
Colin Crosse7257d22020-09-24 09:56:18 -07002026
Colin Cross0de8a1e2020-09-18 14:15:30 -07002027 if far {
2028 ctx.AddFarVariationDependencies(variations, depTag, name)
2029 } else {
2030 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002031 }
2032}
2033
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002034func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002035 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002036 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002037 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002038 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2039 // between the modules in the snapshot and the snapshot itself.
2040 var snapshotModule []blueprint.Module
2041 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2042 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2043 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2044 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2045 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002046 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002047 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2048 *snapshotInfo = &snapshot
2049 // republish the snapshot for use in later mutators on this module
2050 actx.SetProvider(SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002051 }
2052 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002053 if *snapshotInfo == nil {
2054 *snapshotInfo = &SnapshotInfo{}
2055 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002056 return **snapshotInfo
2057}
2058
2059func RewriteSnapshotLib(lib string, snapshotMap map[string]string) string {
2060 if snapshot, ok := snapshotMap[lib]; ok {
2061 return snapshot
2062 }
2063
2064 return lib
2065}
2066
2067// RewriteLibs takes a list of names of shared libraries and scans it for three types
2068// of names:
2069//
2070// 1. Name of an NDK library that refers to a prebuilt module.
2071// For each of these, it adds the name of the prebuilt module (which will be in
2072// prebuilts/ndk) to the list of nonvariant libs.
2073// 2. Name of an NDK library that refers to an ndk_library module.
2074// For each of these, it adds the name of the ndk_library module to the list of
2075// variant libs.
2076// 3. Anything else (so anything that isn't an NDK library).
2077// It adds these to the nonvariantLibs list.
2078//
2079// The caller can then know to add the variantLibs dependencies differently from the
2080// nonvariantLibs
2081func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2082 variantLibs = []string{}
2083
2084 nonvariantLibs = []string{}
2085 for _, entry := range list {
2086 // strip #version suffix out
2087 name, _ := StubsLibNameAndVersion(entry)
2088 if c.InRecovery() {
2089 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2090 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2091 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2092 } else if c.UseVndk() {
2093 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2094 } else {
2095 // put name#version back
2096 nonvariantLibs = append(nonvariantLibs, entry)
2097 }
2098 }
2099 return nonvariantLibs, variantLibs
2100}
2101
Colin Cross1e676be2016-10-12 14:38:15 -07002102func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002103 if !c.Enabled() {
2104 return
2105 }
2106
Colin Cross37047f12016-12-13 17:06:13 -08002107 ctx := &depsContext{
2108 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002109 moduleContextImpl: moduleContextImpl{
2110 mod: c,
2111 },
2112 }
2113 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002114
Colin Crossc99deeb2016-04-11 15:06:20 -07002115 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002116
Yo Chiang219968c2020-09-22 18:45:04 +08002117 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2118
Colin Crosse0edaf92021-01-11 17:31:17 -08002119 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002120
Dan Albert914449f2016-06-17 16:45:24 -07002121 variantNdkLibs := []string{}
2122 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002123 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002124 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2125 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2126 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002127
2128 for idx, lib := range deps.RuntimeLibs {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002129 deps.RuntimeLibs[idx] = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002130 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002131 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002132
Colin Cross32ec36c2016-12-15 07:39:51 -08002133 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002134 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002135 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002136 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002137 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002138
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002139 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002140
Jiyong Park1ad8e162020-12-01 23:40:09 +09002141 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002142 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002143 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002144 } else {
2145 actx.AddVariationDependencies(nil, depTag, lib)
2146 }
2147 }
2148
Dan Albertf1d14c72020-07-30 14:32:55 -07002149 if c.isNDKStubLibrary() {
2150 // NDK stubs depend on their implementation because the ABI dumps are
2151 // generated from the implementation library.
2152 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2153 c.ImageVariation(),
2154 blueprint.Variation{Mutator: "link", Variation: "shared"},
2155 ), stubImplementation, c.BaseModuleName())
2156 }
2157
Inseob Kim07def122020-11-23 14:43:02 +09002158 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
2159 // C++ implementation library and one Java implementation library. When a module links against
2160 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
2161 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
2162 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09002163 syspropImplLibraries := syspropImplLibraries(actx.Config())
2164
Jiyong Park5d1598f2019-02-25 22:14:17 +09002165 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002166 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09002167 if impl, ok := syspropImplLibraries[lib]; ok {
2168 lib = impl
2169 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002170
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002171 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002172
Jiyong Park5d1598f2019-02-25 22:14:17 +09002173 actx.AddVariationDependencies([]blueprint.Variation{
2174 {Mutator: "link", Variation: "static"},
2175 }, depTag, lib)
2176 }
2177
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002178 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002179 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002180 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002181 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002182 }
Jiyong Parke3867542020-12-03 17:28:25 +09002183 if inList(lib, deps.ExcludeLibsForApex) {
2184 depTag.excludeInApex = true
2185 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002186
2187 if impl, ok := syspropImplLibraries[lib]; ok {
2188 lib = impl
2189 }
2190
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002191 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002192
Dan Willemsen59339a22018-07-22 21:18:45 -07002193 actx.AddVariationDependencies([]blueprint.Variation{
2194 {Mutator: "link", Variation: "static"},
2195 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002196 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002197
Jooyung Han75568392020-03-20 04:29:24 +09002198 // staticUnwinderDep is treated as staticDep for Q apexes
2199 // so that native libraries/binaries are linked with static unwinder
2200 // because Q libc doesn't have unwinder APIs
2201 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002202 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002203 actx.AddVariationDependencies([]blueprint.Variation{
2204 {Mutator: "link", Variation: "static"},
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002205 }, depTag, RewriteSnapshotLib(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002206 }
2207
Jiyong Park7ed9de32018-10-15 22:25:07 +09002208 // shared lib names without the #version suffix
2209 var sharedLibNames []string
2210
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002211 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002212 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002213 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002214 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002215 }
Jiyong Parke3867542020-12-03 17:28:25 +09002216 if inList(lib, deps.ExcludeLibsForApex) {
2217 depTag.excludeInApex = true
2218 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002219
2220 if impl, ok := syspropImplLibraries[lib]; ok {
2221 lib = impl
2222 }
2223
Jiyong Park73c54ee2019-10-22 20:31:18 +09002224 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002225 sharedLibNames = append(sharedLibNames, name)
2226
Colin Crosse7257d22020-09-24 09:56:18 -07002227 variations := []blueprint.Variation{
2228 {Mutator: "link", Variation: "shared"},
2229 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002230 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002231 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002232
Colin Crossfe9acfe2021-06-14 16:13:03 -07002233 for _, lib := range deps.LateStaticLibs {
2234 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2235 actx.AddVariationDependencies([]blueprint.Variation{
2236 {Mutator: "link", Variation: "static"},
2237 }, depTag, RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
2238 }
2239
Jiyong Park7ed9de32018-10-15 22:25:07 +09002240 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002241 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002242 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2243 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2244 // linking against both the stubs lib and the non-stubs lib at the same time.
2245 continue
2246 }
Colin Cross6e511a92020-07-27 21:26:48 -07002247 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002248 variations := []blueprint.Variation{
2249 {Mutator: "link", Variation: "shared"},
2250 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002251 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002252 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002253
Dan Willemsen59339a22018-07-22 21:18:45 -07002254 actx.AddVariationDependencies([]blueprint.Variation{
2255 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002256 }, dataLibDepTag, deps.DataLibs...)
2257
2258 actx.AddVariationDependencies([]blueprint.Variation{
2259 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002260 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002261
Colin Cross68861832016-07-08 10:41:41 -07002262 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002263
2264 for _, gen := range deps.GeneratedHeaders {
2265 depTag := genHeaderDepTag
2266 if inList(gen, deps.ReexportGeneratedHeaders) {
2267 depTag = genHeaderExportDepTag
2268 }
2269 actx.AddDependency(c, depTag, gen)
2270 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002271
Dan Albert92fe7402020-07-15 13:33:30 -07002272 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002273 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002274 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002275 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002276 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002277 }
Colin Crossc465efd2021-06-11 18:00:04 -07002278 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002279 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002280 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002281 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002282 if deps.DynamicLinker != "" {
2283 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002284 }
Dan Albert914449f2016-06-17 16:45:24 -07002285
2286 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002287
2288 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002289 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002290 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002291 {Mutator: "link", Variation: "shared"},
2292 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002293
2294 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002295 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002296 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002297 {Mutator: "link", Variation: "shared"},
2298 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002299
2300 if vndkdep := c.vndkdep; vndkdep != nil {
2301 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002302 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002303 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002304 {Mutator: "link", Variation: "shared"},
Justin Yun27b95722021-07-28 17:04:44 +09002305 }, vndkExtDepTag, RewriteSnapshotLib(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002306 }
2307 }
Colin Cross6362e272015-10-29 15:25:03 -07002308}
Colin Cross21b9a242015-03-24 14:15:58 -07002309
Colin Crosse40b4ea2018-10-02 22:25:58 -07002310func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002311 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2312 c.beginMutator(ctx)
2313 }
2314}
2315
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002316// Whether a module can link to another module, taking into
2317// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002318func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002319 tag blueprint.DependencyTag) {
2320
2321 switch t := tag.(type) {
2322 case dependencyTag:
2323 if t != vndkExtDepTag {
2324 return
2325 }
2326 case libraryDependencyTag:
2327 default:
2328 return
2329 }
2330
Ivan Lozanof9e21722020-12-02 09:00:51 -05002331 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002332 // Host code is not restricted
2333 return
2334 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002335
2336 // VNDK is cc.Module supported only for now.
2337 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002338 // Though allowed dependency is limited by the image mutator,
2339 // each vendor and product module needs to check link-type
2340 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002341 if ccTo, ok := to.(*Module); ok {
2342 if ccFrom.vndkdep != nil {
2343 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2344 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002345 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002346 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002347 }
2348 return
2349 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002350 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002351 // Platform code can link to anything
2352 return
2353 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002354 if from.InRamdisk() {
2355 // Ramdisk code is not NDK
2356 return
2357 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002358 if from.InVendorRamdisk() {
2359 // Vendor ramdisk code is not NDK
2360 return
2361 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002362 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002363 // Recovery code is not NDK
2364 return
2365 }
Colin Cross31076b32020-10-23 17:22:06 -07002366 if c, ok := to.(*Module); ok {
2367 if c.ToolchainLibrary() {
2368 // These are always allowed
2369 return
2370 }
2371 if c.NdkPrebuiltStl() {
2372 // These are allowed, but they don't set sdk_version
2373 return
2374 }
2375 if c.StubDecorator() {
2376 // These aren't real libraries, but are the stub shared libraries that are included in
2377 // the NDK.
2378 return
2379 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002380 }
Logan Chien834b9a62019-01-14 15:39:03 +08002381
Ivan Lozano52767be2019-10-18 14:49:46 -07002382 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002383 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2384 // to link to libc++ (non-NDK and without sdk_version).
2385 return
2386 }
2387
Ivan Lozano52767be2019-10-18 14:49:46 -07002388 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002389 // NDK code linking to platform code is never okay.
2390 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002391 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002392 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002393 }
2394
2395 // At this point we know we have two NDK libraries, but we need to
2396 // check that we're not linking against anything built against a higher
2397 // API level, as it is only valid to link against older or equivalent
2398 // APIs.
2399
Inseob Kim01a28722018-04-11 09:48:45 +09002400 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002401 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002402 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002403 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002404 // Current can't be linked against by anything else.
2405 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002406 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002407 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002408 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002409 if err != nil {
2410 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002411 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002412 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002413 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002414 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002415 if err != nil {
2416 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002417 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002418 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002419 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002420
Inseob Kim01a28722018-04-11 09:48:45 +09002421 if toApi > fromApi {
2422 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002423 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002424 }
2425 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002426 }
Dan Albert202fe492017-12-15 13:56:59 -08002427
2428 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002429 fromStl := from.SelectedStl()
2430 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002431 if fromStl == "" || toStl == "" {
2432 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002433 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002434 // We can be permissive with the system "STL" since it is only the C++
2435 // ABI layer, but in the future we should make sure that everyone is
2436 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002437 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002438 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002439 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2440 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002441 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002442}
2443
Jooyung Han479ca172020-10-19 18:51:07 +09002444func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2445 if c, ok := ctx.Module().(*Module); ok {
2446 ctx.VisitDirectDeps(func(dep android.Module) {
2447 depTag := ctx.OtherModuleDependencyTag(dep)
2448 ccDep, ok := dep.(LinkableInterface)
2449 if ok {
2450 checkLinkType(ctx, c, ccDep, depTag)
2451 }
2452 })
2453 }
2454}
2455
Jiyong Park5fb8c102018-04-09 12:03:06 +09002456// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002457// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2458// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002459// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002460func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2461 check := func(child, parent android.Module) bool {
2462 to, ok := child.(*Module)
2463 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002464 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002465 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002466
Jooyung Hana70f0672019-01-18 15:20:43 +09002467 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2468 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002469 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002470
Jiyong Park0474e1f2021-01-14 14:26:06 +09002471 // These dependencies are not excercised at runtime. Tracking these will give us
2472 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002473 depTag := ctx.OtherModuleDependencyTag(child)
2474 if IsHeaderDepTag(depTag) {
2475 return false
2476 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002477 if depTag == staticVariantTag {
2478 return false
2479 }
2480 if depTag == stubImplDepTag {
2481 return false
2482 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002483
Justin Yun63e9ec72020-10-29 16:49:43 +09002484 // Even if target lib has no vendor variant, keep checking dependency
2485 // graph in case it depends on vendor_available or product_available
2486 // but not double_loadable transtively.
2487 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002488 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002489 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002490
Jiyong Park0474e1f2021-01-14 14:26:06 +09002491 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2492 // one.
2493 if Bool(to.VendorProperties.Double_loadable) {
2494 return true
2495 }
2496
Ivan Lozanod7586b62021-04-01 09:49:36 -04002497 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002498 return false
2499 }
2500
Jooyung Hana70f0672019-01-18 15:20:43 +09002501 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2502 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002503 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002504 return false
2505 }
2506 if module, ok := ctx.Module().(*Module); ok {
2507 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002508 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002509 ctx.WalkDeps(check)
2510 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002511 }
2512 }
2513}
2514
Colin Crossc99deeb2016-04-11 15:06:20 -07002515// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002516func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002517 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002518
Colin Cross0de8a1e2020-09-18 14:15:30 -07002519 var directStaticDeps []StaticLibraryInfo
2520 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002521
Colin Cross0de8a1e2020-09-18 14:15:30 -07002522 reexportExporter := func(exporter FlagExporterInfo) {
2523 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2524 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2525 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2526 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2527 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002528 }
2529
Jooyung Hande34d232020-07-23 13:04:15 +09002530 // For the dependency from platform to apex, use the latest stubs
2531 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002532 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2533 if !apexInfo.IsForPlatform() {
Jiyong Park4eab21d2021-04-15 15:17:54 +09002534 c.apexSdkVersion = apexInfo.MinSdkVersion
Jooyung Hande34d232020-07-23 13:04:15 +09002535 }
2536
2537 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2538 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2539 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2540 // (b/144430859)
2541 c.apexSdkVersion = android.FutureApiLevel
2542 }
2543
Colin Crossd11fcda2017-10-23 17:59:01 -07002544 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002545 depName := ctx.OtherModuleName(dep)
2546 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002547
Ivan Lozano52767be2019-10-18 14:49:46 -07002548 ccDep, ok := dep.(LinkableInterface)
2549 if !ok {
2550
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002551 // handling for a few module types that aren't cc Module but that are also supported
2552 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002553 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002554 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002555 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2556 genRule.GeneratedSourceFiles()...)
2557 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002558 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002559 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002560 // Support exported headers from a generated_sources dependency
2561 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002562 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002563 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002564 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002565 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002566 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002567 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002568 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002569 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002570 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2571 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002572 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002573 // 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 +09002574 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002575
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002576 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002577 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002578 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002579 }
Colin Crosscef792e2021-06-11 18:01:26 -07002580 case CrtBeginDepTag:
2581 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2582 case CrtEndDepTag:
2583 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002584 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002585 return
2586 }
2587
Colin Crossfe17f6f2019-03-28 19:30:56 -07002588 if depTag == android.ProtoPluginDepTag {
2589 return
2590 }
2591
Colin Crossd11fcda2017-10-23 17:59:01 -07002592 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002593 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2594 return
2595 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002596 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002597 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2598 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002599 return
2600 }
2601
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002602 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002603 // Skip reused objects for stub libraries, they use their own stub object file instead.
2604 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2605 // version mutator, so the stubs variant is created from the shared variant that
2606 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002607 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002608 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2609 objs := staticAnalogue.ReuseObjects
2610 depPaths.Objs = depPaths.Objs.Append(objs)
2611 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2612 reexportExporter(depExporterInfo)
2613 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002614 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002615 }
2616
Colin Cross6e511a92020-07-27 21:26:48 -07002617 linkFile := ccDep.OutputFile()
2618
2619 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2620 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002621 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002622 return
2623 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002624
Jiyong Parke3867542020-12-03 17:28:25 +09002625 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2626 return
2627 }
2628
Colin Cross0de8a1e2020-09-18 14:15:30 -07002629 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002630
Colin Cross6e511a92020-07-27 21:26:48 -07002631 var ptr *android.Paths
2632 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002633
Colin Cross6e511a92020-07-27 21:26:48 -07002634 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002635
Colin Cross6e511a92020-07-27 21:26:48 -07002636 switch {
2637 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002638 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2639 if !ctx.Config().AllowMissingDependencies() {
2640 ctx.ModuleErrorf("module %q is not a header library", depName)
2641 } else {
2642 ctx.AddMissingDependencies([]string{depName})
2643 }
2644 return
2645 }
Colin Cross6e511a92020-07-27 21:26:48 -07002646 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002647 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2648 if !ctx.Config().AllowMissingDependencies() {
2649 ctx.ModuleErrorf("module %q is not a shared library", depName)
2650 } else {
2651 ctx.AddMissingDependencies([]string{depName})
2652 }
2653 return
2654 }
Jiyong Parke3867542020-12-03 17:28:25 +09002655
Jiyong Park7d55b612021-06-11 17:22:09 +09002656 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
2657 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07002658
Jiyong Park1ad8e162020-12-01 23:40:09 +09002659 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2660 // linkFile, depFile, and ptr.
2661 if c.IsStubs() {
2662 break
2663 }
2664
Colin Cross0de8a1e2020-09-18 14:15:30 -07002665 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2666 depFile = sharedLibraryInfo.TableOfContents
2667
Colin Cross6e511a92020-07-27 21:26:48 -07002668 ptr = &depPaths.SharedLibs
2669 switch libDepTag.Order {
2670 case earlyLibraryDependency:
2671 ptr = &depPaths.EarlySharedLibs
2672 depPtr = &depPaths.EarlySharedLibsDeps
2673 case normalLibraryDependency:
2674 ptr = &depPaths.SharedLibs
2675 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002676 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002677 case lateLibraryDependency:
2678 ptr = &depPaths.LateSharedLibs
2679 depPtr = &depPaths.LateSharedLibsDeps
2680 default:
2681 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002682 }
Colin Cross6e511a92020-07-27 21:26:48 -07002683 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002684 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2685 if !ctx.Config().AllowMissingDependencies() {
2686 ctx.ModuleErrorf("module %q is not a static library", depName)
2687 } else {
2688 ctx.AddMissingDependencies([]string{depName})
2689 }
2690 return
2691 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002692
2693 // Stubs lib doesn't link to the static lib dependencies. Don't set
2694 // linkFile, depFile, and ptr.
2695 if c.IsStubs() {
2696 break
2697 }
2698
Colin Cross0de8a1e2020-09-18 14:15:30 -07002699 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2700 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002701 if libDepTag.wholeStatic {
2702 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002703 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2704 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002705 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002706 // This case normally catches prebuilt static
2707 // libraries, but it can also occur when
2708 // AllowMissingDependencies is on and the
2709 // dependencies has no sources of its own
2710 // but has a whole_static_libs dependency
2711 // on a missing library. We want to depend
2712 // on the .a file so that there is something
2713 // in the dependency tree that contains the
2714 // error rule for the missing transitive
2715 // dependency.
2716 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002717 }
Colin Cross6e511a92020-07-27 21:26:48 -07002718 } else {
2719 switch libDepTag.Order {
2720 case earlyLibraryDependency:
2721 panic(fmt.Errorf("early static libs not suppported"))
2722 case normalLibraryDependency:
2723 // static dependencies will be handled separately so they can be ordered
2724 // using transitive dependencies.
2725 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002726 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002727 case lateLibraryDependency:
2728 ptr = &depPaths.LateStaticLibs
2729 default:
2730 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002731 }
2732 }
2733 }
2734
Colin Cross6e511a92020-07-27 21:26:48 -07002735 if libDepTag.static() && !libDepTag.wholeStatic {
2736 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2737 ctx.ModuleErrorf("module %q not a static library", depName)
2738 return
2739 }
Logan Chien43d34c32017-12-20 01:17:32 +08002740
Colin Cross6e511a92020-07-27 21:26:48 -07002741 // When combining coverage files for shared libraries and executables, coverage files
2742 // in static libraries act as if they were whole static libraries. The same goes for
2743 // source based Abi dump files.
2744 if c, ok := ccDep.(*Module); ok {
2745 staticLib := c.linker.(libraryInterface)
2746 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2747 staticLib.objs().coverageFiles...)
2748 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2749 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002750 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002751 // Handle non-CC modules here
2752 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002753 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002754 }
2755 }
2756
Colin Cross6e511a92020-07-27 21:26:48 -07002757 if ptr != nil {
2758 if !linkFile.Valid() {
2759 if !ctx.Config().AllowMissingDependencies() {
2760 ctx.ModuleErrorf("module %q missing output file", depName)
2761 } else {
2762 ctx.AddMissingDependencies([]string{depName})
2763 }
2764 return
2765 }
2766 *ptr = append(*ptr, linkFile.Path())
2767 }
2768
2769 if depPtr != nil {
2770 dep := depFile
2771 if !dep.Valid() {
2772 dep = linkFile
2773 }
2774 *depPtr = append(*depPtr, dep.Path())
2775 }
2776
Colin Cross0de8a1e2020-09-18 14:15:30 -07002777 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2778 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2779 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2780 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2781
2782 if libDepTag.reexportFlags {
2783 reexportExporter(depExporterInfo)
2784 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2785 // Re-exported shared library headers must be included as well since they can help us with type information
2786 // about template instantiations (instantiated from their headers).
2787 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2788 // scripts.
2789 c.sabi.Properties.ReexportedIncludes = append(
2790 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2791 }
2792
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002793 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002794 switch {
2795 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002796 c.Properties.AndroidMkHeaderLibs = append(
2797 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002798 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002799 if lib := moduleLibraryInterface(dep); lib != nil {
2800 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002801 // Add the dependency to the APEX(es) providing the library so that
2802 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002803 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09002804 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07002805 c.Properties.ApexesProvidingSharedLibs = append(
2806 c.Properties.ApexesProvidingSharedLibs, an)
2807 }
2808 }
2809 }
2810
2811 // Note: the order of libs in this list is not important because
2812 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002813 c.Properties.AndroidMkSharedLibs = append(
2814 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002815 // Record BaseLibName for snapshots.
2816 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002817 case libDepTag.static():
2818 if libDepTag.wholeStatic {
2819 c.Properties.AndroidMkWholeStaticLibs = append(
2820 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2821 } else {
2822 c.Properties.AndroidMkStaticLibs = append(
2823 c.Properties.AndroidMkStaticLibs, makeLibName)
2824 }
Justin Yun5e035862021-06-29 20:50:37 +09002825 // Record BaseLibName for snapshots.
2826 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002827 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002828 } else if !c.IsStubs() {
2829 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2830
Colin Cross6e511a92020-07-27 21:26:48 -07002831 switch depTag {
2832 case runtimeDepTag:
2833 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002834 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002835 // Record BaseLibName for snapshots.
2836 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002837 case objDepTag:
2838 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2839 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002840 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002841 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002842 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002843 case dynamicLinkerDepTag:
2844 depPaths.DynamicLinker = linkFile
2845 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002846 }
Colin Crossca860ac2016-01-04 14:34:37 -08002847 })
2848
Jeff Gaston294356f2017-09-27 17:05:30 -07002849 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002850 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2851 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2852 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002853
Colin Crossdd84e052017-05-17 13:44:16 -07002854 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002855 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002856 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2857 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002858 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002859 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2860 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002861 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002862 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002863 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002864
2865 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002866 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002867 }
Colin Crossdd84e052017-05-17 13:44:16 -07002868
Colin Crossca860ac2016-01-04 14:34:37 -08002869 return depPaths
2870}
2871
Jiyong Park7d55b612021-06-11 17:22:09 +09002872// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
2873// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
2874// dependency. The stub variant is selected when the dependency crosses a boundary where each side
2875// has different level of updatability. For example, if a library foo in an APEX depends on a
2876// library bar which provides stable interface and exists in the platform, foo uses the stub variant
2877// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
2878// same APEX as foo, the non-stub variant of bar is used.
2879func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
2880 depName := ctx.OtherModuleName(dep)
2881 depTag := ctx.OtherModuleDependencyTag(dep)
2882 libDepTag, ok := depTag.(libraryDependencyTag)
2883 if !ok || !libDepTag.shared() {
2884 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2885 }
2886
2887 thisModule, ok := ctx.Module().(android.ApexModule)
2888 if !ok {
2889 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
2890 }
2891
2892 useVndk := false
2893 bootstrap := false
2894 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
2895 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
2896 } else {
2897 useVndk = linkable.UseVndk()
2898 bootstrap = linkable.Bootstrap()
2899 }
2900
2901 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2902 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2903 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
2904 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2905
2906 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
2907 useStubs := false
2908
2909 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
2910 if !apexInfo.IsForPlatform() {
2911 // For platform libraries, use current version of LLNDK
2912 // If this is for use_vendor apex we will apply the same rules
2913 // of apex sdk enforcement below to choose right version.
2914 useStubs = true
2915 }
Jiyong Park9477c262021-06-22 20:23:05 +09002916 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
2917 // If not building for APEX or the containing APEX allows the use of
2918 // platform APIs, use stubs only when it is from an APEX (and not from
2919 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
2920 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09002921 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
2922 if useStubs {
2923 // Another exception: if this module is a test for an APEX, then
2924 // it is linked with the non-stub variant of a module in the APEX
2925 // as if this is part of the APEX.
2926 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2927 for _, apexContents := range testFor.ApexContents {
2928 if apexContents.DirectlyInApex(depName) {
2929 useStubs = false
2930 break
2931 }
2932 }
2933 }
2934 if useStubs {
2935 // Yet another exception: If this module and the dependency are
2936 // available to the same APEXes then skip stubs between their
2937 // platform variants. This complements the test_for case above,
2938 // which avoids the stubs on a direct APEX library dependency, by
2939 // avoiding stubs for indirect test dependencies as well.
2940 //
2941 // TODO(b/183882457): This doesn't work if the two libraries have
2942 // only partially overlapping apex_available. For that test_for
2943 // modules would need to be split into APEX variants and resolved
2944 // separately for each APEX they have access to.
2945 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
2946 useStubs = false
2947 }
2948 }
2949 } else {
2950 // If building for APEX, use stubs when the parent is in any APEX that
2951 // the child is not in.
2952 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2953 }
2954
2955 // when to use (unspecified) stubs, use the latest one.
2956 if useStubs {
2957 stubs := sharedLibraryStubsInfo.SharedStubLibraries
2958 toUse := stubs[len(stubs)-1]
2959 sharedLibraryInfo = toUse.SharedLibraryInfo
2960 depExporterInfo = toUse.FlagExporterInfo
2961 }
2962 }
2963 return sharedLibraryInfo, depExporterInfo
2964}
2965
Colin Cross0de8a1e2020-09-18 14:15:30 -07002966// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2967// to match the topological order of the dependency tree, including any static analogues of
2968// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2969// of the transitive dependencies.
2970func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2971 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2972 var staticPaths android.Paths
2973 for _, staticDep := range staticDeps {
2974 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2975 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2976 }
2977 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04002978 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
2979 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002980 }
2981 }
2982 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2983
2984 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2985
2986 // reorder the dependencies based on transitive dependencies
2987 staticPaths = android.FirstUniquePaths(staticPaths)
2988 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2989
2990 if len(orderedStaticPaths) != len(staticPaths) {
2991 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2992 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2993 }
2994
2995 return orderedStaticPaths, transitiveStaticLibs
2996}
2997
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002998// BaseLibName trims known prefixes and suffixes
2999func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003000 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3001 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003002 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003003 return libName
3004}
3005
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003006func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003007 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003008 ccDepModule, _ := ccDep.(*Module)
3009 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003010 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003011
Justin Yuncbca3732021-02-03 19:24:13 +09003012 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003013 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07003014 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003015 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003016 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003017
Ivan Lozanod1dec542021-05-26 15:33:11 -04003018 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003019 }
3020 }
3021
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003022 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3023 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003024 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3025 // core module instead.
3026 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003027 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003028 // The vendor and product modules in Make will have been renamed to not conflict with the
3029 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003030 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003031 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003032 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003033 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003034 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003035 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003036 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003037 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003038 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003039 } else {
3040 return libName
3041 }
3042}
3043
Colin Crossca860ac2016-01-04 14:34:37 -08003044func (c *Module) InstallInData() bool {
3045 if c.installer == nil {
3046 return false
3047 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003048 return c.installer.inData()
3049}
3050
3051func (c *Module) InstallInSanitizerDir() bool {
3052 if c.installer == nil {
3053 return false
3054 }
3055 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003056 return true
3057 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003058 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003059}
3060
Yifan Hong1b3348d2020-01-21 15:53:22 -08003061func (c *Module) InstallInRamdisk() bool {
3062 return c.InRamdisk()
3063}
3064
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003065func (c *Module) InstallInVendorRamdisk() bool {
3066 return c.InVendorRamdisk()
3067}
3068
Jiyong Parkf9332f12018-02-01 00:54:12 +09003069func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003070 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003071}
3072
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003073func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003074 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003075 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003076 return
3077 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003078 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003079}
3080
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003081func (c *Module) HostToolPath() android.OptionalPath {
3082 if c.installer == nil {
3083 return android.OptionalPath{}
3084 }
3085 return c.installer.hostToolPath()
3086}
3087
Nan Zhangd4e641b2017-07-12 12:55:28 -07003088func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3089 return c.outputFile
3090}
3091
Colin Cross41955e82019-05-29 14:40:35 -07003092func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3093 switch tag {
3094 case "":
3095 if c.outputFile.Valid() {
3096 return android.Paths{c.outputFile.Path()}, nil
3097 }
3098 return android.Paths{}, nil
3099 default:
3100 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003101 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003102}
3103
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003104func (c *Module) static() bool {
3105 if static, ok := c.linker.(interface {
3106 static() bool
3107 }); ok {
3108 return static.static()
3109 }
3110 return false
3111}
3112
Jiyong Park379de2f2018-12-19 02:47:14 +09003113func (c *Module) staticBinary() bool {
3114 if static, ok := c.linker.(interface {
3115 staticBinary() bool
3116 }); ok {
3117 return static.staticBinary()
3118 }
3119 return false
3120}
3121
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003122func (c *Module) testBinary() bool {
3123 if test, ok := c.linker.(interface {
3124 testBinary() bool
3125 }); ok {
3126 return test.testBinary()
3127 }
3128 return false
3129}
3130
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003131// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3132func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003133 if h, ok := c.linker.(interface {
3134 header() bool
3135 }); ok {
3136 return h.header()
3137 }
3138 return false
3139}
3140
Ivan Lozanod7586b62021-04-01 09:49:36 -04003141func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003142 if b, ok := c.linker.(interface {
3143 binary() bool
3144 }); ok {
3145 return b.binary()
3146 }
3147 return false
3148}
3149
Justin Yun5e035862021-06-29 20:50:37 +09003150func (c *Module) StaticExecutable() bool {
3151 if b, ok := c.linker.(*binaryDecorator); ok {
3152 return b.static()
3153 }
3154 return false
3155}
3156
Ivan Lozanod7586b62021-04-01 09:49:36 -04003157func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003158 if o, ok := c.linker.(interface {
3159 object() bool
3160 }); ok {
3161 return o.object()
3162 }
3163 return false
3164}
3165
Ivan Lozanof9e21722020-12-02 09:00:51 -05003166func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003167 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003168 if c.IsLlndk() {
3169 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003170 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003171 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003172 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003173 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003174 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003175 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003176 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003177 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003178 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003179 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003180 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003181 return "native:product"
3182 }
Jooyung Han38002912019-05-16 04:01:54 +09003183 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003184 } else if c.InRamdisk() {
3185 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003186 } else if c.InVendorRamdisk() {
3187 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003188 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003189 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003190 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003191 return "native:ndk:none:none"
3192 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3193 //family, link := getNdkStlFamilyAndLinkType(c)
3194 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003195 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003196 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003197 } else {
3198 return "native:platform"
3199 }
3200}
3201
Jiyong Park9d452992018-10-03 00:38:19 +09003202// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003203// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003204func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003205 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003206 // Stub libs and prebuilt libs in a versioned SDK are not
3207 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07003208 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01003209 } else if _, ok := c.linker.(testPerSrc); ok {
3210 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003211 }
3212 return false
3213}
3214
Jiyong Parka90ca002019-10-07 15:47:24 +09003215func (c *Module) AvailableFor(what string) bool {
3216 if linker, ok := c.linker.(interface {
3217 availableFor(string) bool
3218 }); ok {
3219 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3220 } else {
3221 return c.ApexModuleBase.AvailableFor(what)
3222 }
3223}
3224
Jiyong Park62304bb2020-04-13 16:19:48 +09003225func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003226 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003227}
3228
Colin Crossaede88c2020-08-11 12:17:01 -07003229func (c *Module) UniqueApexVariations() bool {
3230 if u, ok := c.compiler.(interface {
3231 uniqueApexVariations() bool
3232 }); ok {
3233 return u.uniqueApexVariations()
3234 } else {
3235 return false
3236 }
3237}
3238
Paul Duffin0cb37b92020-03-04 14:52:46 +00003239func (c *Module) EverInstallable() bool {
3240 return c.installer != nil &&
3241 // Check to see whether the module is actually ever installable.
3242 c.installer.everInstallable()
3243}
3244
Ivan Lozanod7586b62021-04-01 09:49:36 -04003245func (c *Module) PreventInstall() bool {
3246 return c.Properties.PreventInstall
3247}
3248
3249func (c *Module) Installable() *bool {
3250 return c.Properties.Installable
3251}
3252
3253func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003254 ret := c.EverInstallable() &&
3255 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003256 proptools.BoolDefault(c.Installable(), true) &&
3257 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003258
3259 // The platform variant doesn't need further condition. Apex variants however might not
3260 // be installable because it will likely to be included in the APEX and won't appear
3261 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003262 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003263 return ret
3264 }
3265
3266 // Special case for modules that are configured to be installed to /data, which includes
3267 // test modules. For these modules, both APEX and non-APEX variants are considered as
3268 // installable. This is because even the APEX variants won't be included in the APEX, but
3269 // will anyway be installed to /data/*.
3270 // See b/146995717
3271 if c.InstallInData() {
3272 return ret
3273 }
3274
3275 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003276}
3277
Logan Chien41eabe62019-04-10 13:33:58 +08003278func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3279 if c.linker != nil {
3280 if library, ok := c.linker.(*libraryDecorator); ok {
3281 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3282 }
3283 }
3284}
3285
Jiyong Park45bf82e2020-12-15 22:29:02 +09003286var _ android.ApexModule = (*Module)(nil)
3287
3288// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003289func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003290 depTag := ctx.OtherModuleDependencyTag(dep)
3291 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3292
3293 if cc, ok := dep.(*Module); ok {
3294 if cc.HasStubsVariants() {
3295 if isLibDepTag && libDepTag.shared() {
3296 // dynamic dep to a stubs lib crosses APEX boundary
3297 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003298 }
Colin Cross6e511a92020-07-27 21:26:48 -07003299 if IsRuntimeDepTag(depTag) {
3300 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003301 return false
3302 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003303 }
Zhijun Heec285872021-04-24 10:47:08 -07003304 if cc.IsLlndk() {
3305 return false
3306 }
Colin Crossaac32222020-07-29 12:51:56 -07003307 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003308 // shared_lib dependency from a static lib is considered as crossing
3309 // the APEX boundary because the dependency doesn't actually is
3310 // linked; the dependency is used only during the compilation phase.
3311 return false
3312 }
Jiyong Parke3867542020-12-03 17:28:25 +09003313
3314 if isLibDepTag && libDepTag.excludeInApex {
3315 return false
3316 }
Colin Cross6e511a92020-07-27 21:26:48 -07003317 }
Colin Crossc1b36442021-05-06 13:42:48 -07003318 if depTag == stubImplDepTag {
3319 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003320 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003321 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003322 if depTag == staticVariantTag {
3323 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3324 // actually mean that the static lib (and its dependencies) are copied into the
3325 // APEX.
3326 return false
3327 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003328 return true
3329}
3330
Jiyong Park45bf82e2020-12-15 22:29:02 +09003331// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003332func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3333 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003334 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3335 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3336 return nil
3337 }
3338 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3339 if c.ToolchainLibrary() {
3340 return nil
3341 }
3342 // We don't check for prebuilt modules
3343 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3344 return nil
3345 }
3346 minSdkVersion := c.MinSdkVersion()
3347 if minSdkVersion == "apex_inherit" {
3348 return nil
3349 }
3350 if minSdkVersion == "" {
3351 // JNI libs within APK-in-APEX fall into here
3352 // Those are okay to set sdk_version instead
3353 // We don't have to check if this is a SDK variant because
3354 // non-SDK variant resets sdk_version, which works too.
3355 minSdkVersion = c.SdkVersion()
3356 }
Dan Albertc8060532020-07-22 22:32:17 -07003357 if minSdkVersion == "" {
3358 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3359 }
3360 // Not using nativeApiLevelFromUser because the context here is not
3361 // necessarily a native context.
3362 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003363 if err != nil {
3364 return err
3365 }
Dan Albertc8060532020-07-22 22:32:17 -07003366
3367 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003368 return fmt.Errorf("newer SDK(%v)", ver)
3369 }
3370 return nil
3371}
3372
Paul Duffinb5769c12021-05-12 16:16:51 +01003373// Implements android.ApexModule
3374func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3375 // stub libraries and native bridge libraries are always available to platform
3376 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3377}
3378
Colin Cross2ba19d92015-05-07 15:44:20 -07003379//
Colin Crosscfad1192015-11-02 16:43:11 -08003380// Defaults
3381//
Colin Crossca860ac2016-01-04 14:34:37 -08003382type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003383 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003384 android.DefaultsModuleBase
Liz Kammer3cf52112021-03-31 15:42:03 -04003385 // Included to support setting bazel_module.label for multiple Soong modules to the same Bazel
3386 // target. This is primarily useful for modules that were architecture specific and instead are
3387 // handled in Bazel as a select().
3388 android.BazelModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003389 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003390}
3391
Patrice Arrudac249c712019-03-19 17:00:29 -07003392// cc_defaults provides a set of properties that can be inherited by other cc
3393// modules. A module can use the properties from a cc_defaults using
3394// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3395// merged (when possible) by prepending the default module's values to the
3396// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003397func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003398 return DefaultsFactory()
3399}
3400
Colin Cross36242852017-06-23 15:06:31 -07003401func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003402 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003403
Colin Cross36242852017-06-23 15:06:31 -07003404 module.AddProperties(props...)
3405 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003406 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003407 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003408 &BaseCompilerProperties{},
3409 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003410 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003411 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003412 &StaticProperties{},
3413 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003414 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003415 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003416 &TestProperties{},
3417 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003418 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07003419 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003420 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003421 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003422 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003423 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003424 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003425 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003426 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003427 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003428 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003429 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003430 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003431 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3432 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003433 )
Colin Crosscfad1192015-11-02 16:43:11 -08003434
Liz Kammer3cf52112021-03-31 15:42:03 -04003435 // Bazel module must be initialized _before_ Defaults to be included in cc_defaults module.
3436 android.InitBazelModule(module)
Jooyung Hancc372c52019-09-25 15:18:44 +09003437 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003438
3439 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003440}
3441
Jiyong Park2286afd2020-06-16 21:58:53 +09003442func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003443 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003444}
3445
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003446func kytheExtractAllFactory() android.Singleton {
3447 return &kytheExtractAllSingleton{}
3448}
3449
3450type kytheExtractAllSingleton struct {
3451}
3452
3453func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3454 var xrefTargets android.Paths
3455 ctx.VisitAllModules(func(module android.Module) {
3456 if ccModule, ok := module.(xref); ok {
3457 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3458 }
3459 })
3460 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3461 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003462 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003463 }
3464}
3465
Colin Cross06a931b2015-10-28 17:23:31 -07003466var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003467var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003468var BoolPtr = proptools.BoolPtr
3469var String = proptools.String
3470var StringPtr = proptools.StringPtr