blob: e4f4761c2c7d65e64f1610d89f1575e0ca1c90cd [file] [log] [blame]
Colin Cross5049f022015-03-18 13:28:46 -07001// Copyright 2015 Google Inc. All rights reserved.
Colin Cross3f40fa42015-01-30 17:27:36 -08002//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17// This file contains the module types for compiling C/C++ for Android, and converts the properties
18// into the flags and filenames necessary to pass to the compiler. The final creation of the rules
19// is handled in builder.go
20
21import (
Colin Cross41955e82019-05-29 14:40:35 -070022 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080023 "io"
Dan Albert9e10cd42016-08-03 14:12:14 -070024 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "strings"
26
Colin Cross97ba0732015-03-23 17:50:24 -070027 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070028 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070029
Colin Cross635c3b02016-05-18 15:37:25 -070030 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070031 "android/soong/cc/config"
Colin Cross5049f022015-03-18 13:28:46 -070032 "android/soong/genrule"
Colin Cross3f40fa42015-01-30 17:27:36 -080033)
34
Colin Cross463a90e2015-06-17 14:20:06 -070035func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000036 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070037
Paul Duffin036e7002019-12-19 19:16:28 +000038 pctx.Import("android/soong/cc/config")
39}
40
41func RegisterCCBuildComponents(ctx android.RegistrationContext) {
42 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
43
44 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000045 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090046 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070047 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010048 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070049 ctx.BottomUp("version_selector", versionSelectorMutator).Parallel()
50 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070051 ctx.BottomUp("begin", BeginMutator).Parallel()
Inseob Kimac1e9862019-12-09 18:15:47 +090052 ctx.BottomUp("sysprop_cc", SyspropMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070053 })
Colin Cross16b23492016-01-06 14:41:07 -080054
Paul Duffin036e7002019-12-19 19:16:28 +000055 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040056 for _, san := range Sanitizers {
57 san.registerMutators(ctx)
58 }
Dan Willemsen581341d2017-02-09 16:16:31 -080059
Colin Cross0b908332019-06-19 23:00:20 -070060 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090061 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080062
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080063 ctx.BottomUp("coverage", coverageMutator).Parallel()
Stephen Craneba090d12017-05-09 15:44:35 -070064
65 ctx.TopDown("lto_deps", ltoDepsMutator)
66 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090067
Jooyung Han479ca172020-10-19 18:51:07 +090068 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090069 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070070 })
Colin Crossb98c8b02016-07-29 13:44:28 -070071
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080072 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
73 // sabi mutator needs to be run after apex mutator finishes.
74 ctx.TopDown("sabi_deps", sabiDepsMutator)
75 })
76
Colin Cross57898582020-10-29 18:25:19 -070077 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070078}
79
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050080// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
81// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
82// edges to these modules.
83// This object is constructed in DepsMutator, by calling to various module delegates to set
84// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
85// dependencies.
86// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
87// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080088type Deps struct {
89 SharedLibs, LateSharedLibs []string
90 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080091 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +080092 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -070093
Chris Parsons79d66a52020-06-05 17:26:16 -040094 // Used for data dependencies adjacent to tests
95 DataLibs []string
96
Yo Chiang219968c2020-09-22 18:45:04 +080097 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
98 SystemSharedLibs []string
99
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500100 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800101 StaticUnwinderIfLegacy bool
102
Colin Cross5950f382016-12-13 12:50:57 -0800103 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700104
Colin Cross81413472016-04-11 14:37:39 -0700105 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700106
Dan Willemsenb40aab62016-04-20 14:21:14 -0700107 GeneratedSources []string
108 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900109 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700110
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700111 ReexportGeneratedHeaders []string
112
Colin Crossc465efd2021-06-11 18:00:04 -0700113 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700114
115 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700116 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900117
118 // List of libs that need to be excluded for APEX variant
119 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700120}
121
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500122// PathDeps is a struct containing file paths to dependencies of a module.
123// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
124// It's used to construct flags for various build statements (such as for compiling and linking).
125// It is then passed to module decorator functions responsible for registering build statements
126// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800127type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700128 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900129 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700130 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900131 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700132 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700133 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700134
Colin Cross0de8a1e2020-09-18 14:15:30 -0700135 // Transitive static library dependencies of static libraries for use in ordering.
136 TranstiveStaticLibrariesForOrdering *android.DepSet
137
Colin Cross26c34ed2016-09-30 17:10:16 -0700138 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100139 Objs Objects
140 // Paths to .o files in dependencies that provide them. Note that these lists
141 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800142 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700143 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700144
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100145 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
146 // the libs from all whole_static_lib dependencies.
147 WholeStaticLibsFromPrebuilts android.Paths
148
Colin Cross26c34ed2016-09-30 17:10:16 -0700149 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700150 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900151 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700152
Inseob Kimd110f872019-12-06 13:15:38 +0900153 Flags []string
154 IncludeDirs android.Paths
155 SystemIncludeDirs android.Paths
156 ReexportedDirs android.Paths
157 ReexportedSystemDirs android.Paths
158 ReexportedFlags []string
159 ReexportedGeneratedHeaders android.Paths
160 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700161
Colin Cross26c34ed2016-09-30 17:10:16 -0700162 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700163 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700164
Dan Willemsena0790e32018-10-12 00:24:23 -0700165 // Path to the dynamic linker binary
166 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700167}
168
Colin Cross4af21ed2019-11-04 09:37:55 -0800169// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
170// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
171// command line so they can be overridden by the local module flags).
172type LocalOrGlobalFlags struct {
173 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700174 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800175 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700176 CFlags []string // Flags that apply to C and C++ source files
177 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
178 ConlyFlags []string // Flags that apply to C source files
179 CppFlags []string // Flags that apply to C++ source files
180 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700181 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800182}
183
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500184// Flags contains various types of command line flags (and settings) for use in building build
185// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800186type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500187 // Local flags (which individual modules are responsible for). These may override global flags.
188 Local LocalOrGlobalFlags
189 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800190 Global LocalOrGlobalFlags
191
192 aidlFlags []string // Flags that apply to aidl source files
193 rsFlags []string // Flags that apply to renderscript source files
194 libFlags []string // Flags to add libraries early to the link order
195 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
196 TidyFlags []string // Flags that apply to clang-tidy
197 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700198
Colin Crossc3199482017-03-30 15:03:04 -0700199 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800200 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700201 SystemIncludeFlags []string
202
Oliver Nguyen04526782020-04-21 12:40:27 -0700203 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500204 Tidy bool // True if clang-tidy is enabled.
205 GcovCoverage bool // True if coverage files should be generated.
206 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700207 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800208
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500209 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800210 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500211 // The target-device system path to the dynamic linker.
212 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800213
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700214 CFlagsDeps android.Paths // Files depended on by compiler flags
215 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800216
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500217 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700218 AssemblerWithCpp bool
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500219 // True if static libraries should be grouped (using `-Wl,--start-group` and `-Wl,--end-group`).
220 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800221
Colin Cross19878da2019-03-28 14:45:07 -0700222 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700223 protoC bool // Whether to use C instead of C++
224 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700225
226 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200227 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700228}
229
Colin Crossca860ac2016-01-04 14:34:37 -0800230// Properties used to compile all C or C++ modules
231type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700232 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800233 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700234
Jiyong Parkb35a8192020-08-10 15:59:36 +0900235 // The API level that this module is built against. The APIs of this API level will be
236 // visible at build time, but use of any APIs newer than min_sdk_version will render the
237 // module unloadable on older devices. In the future it will be possible to weakly-link new
238 // APIs, making the behavior match Java: such modules will load on older devices, but
239 // calling new APIs on devices that do not support them will result in a crash.
240 //
241 // This property has the same behavior as sdk_version does for Java modules. For those
242 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
243 // does for Java code.
244 //
245 // In addition, setting this property causes two variants to be built, one for the platform
246 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800247 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700248
Jiyong Parkb35a8192020-08-10 15:59:36 +0900249 // Minimum OS API level supported by this C or C++ module. This property becomes the value
250 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
251 // this property is also used to ensure that the min_sdk_version of the containing module is
252 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
253 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
254 // min_sdk_version of the containing APEX. When the module
255 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900256 Min_sdk_version *string
257
Colin Crossc511bc52020-04-07 16:50:32 +0000258 // If true, always create an sdk variant and don't create a platform variant.
259 Sdk_variant_only *bool
260
Jiyong Parkde866cb2018-12-07 23:08:36 +0900261 AndroidMkSharedLibs []string `blueprint:"mutated"`
262 AndroidMkStaticLibs []string `blueprint:"mutated"`
263 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
264 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700265 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900266 HideFromMake bool `blueprint:"mutated"`
267 PreventInstall bool `blueprint:"mutated"`
268 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700269
Yo Chiang219968c2020-09-22 18:45:04 +0800270 // Set by DepsMutator.
271 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
272
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200273 // The name of the image this module is built for, suffixed with a '.'
Justin Yun5f7f7e82019-11-18 19:52:14 +0900274 ImageVariationPrefix string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200275
276 // The VNDK version this module is built against. If empty, the module is not
277 // build against the VNDK.
278 VndkVersion string `blueprint:"mutated"`
279
280 // Suffix for the name of Android.mk entries generated by this module
281 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800282
283 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
284 // file
285 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900286
Yifan Hong39143a92020-10-26 12:43:12 -0700287 // Make this module available when building for ramdisk.
288 // On device without a dedicated recovery partition, the module is only
289 // available after switching root into
290 // /first_stage_ramdisk. To expose the module before switching root, install
291 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800292 Ramdisk_available *bool
293
Yifan Hong39143a92020-10-26 12:43:12 -0700294 // Make this module available when building for vendor ramdisk.
295 // On device without a dedicated recovery partition, the module is only
296 // available after switching root into
297 // /first_stage_ramdisk. To expose the module before switching root, install
298 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700299 Vendor_ramdisk_available *bool
300
Jiyong Parkf9332f12018-02-01 00:54:12 +0900301 // Make this module available when building for recovery
302 Recovery_available *bool
303
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200304 // Used by imageMutator, set by ImageMutatorBegin()
305 CoreVariantNeeded bool `blueprint:"mutated"`
306 RamdiskVariantNeeded bool `blueprint:"mutated"`
307 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
308 RecoveryVariantNeeded bool `blueprint:"mutated"`
309
310 // A list of variations for the "image" mutator of the form
311 //<image name> '.' <version char>, for example, 'vendor.S'
312 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900313
314 // Allows this module to use non-APEX version of libraries. Useful
315 // for building binaries that are started before APEXes are activated.
316 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900317
318 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
319 // see soong/cc/config/vndk.go
320 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900321
322 // Used by vendor snapshot to record dependencies from snapshot modules.
323 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900324 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900325 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000326
327 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000328
329 // Set by factories of module types that can only be referenced from variants compiled against
330 // the SDK.
331 AlwaysSdk bool `blueprint:"mutated"`
332
333 // Variant is an SDK variant created by sdkMutator
334 IsSdkVariant bool `blueprint:"mutated"`
335 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
336 // variant to have a ".sdk" suffix.
337 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700338
339 // Normally Soong uses the directory structure to decide which modules
340 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800341 // different snapshots (vendor, recovery, etc.), but this property
342 // allows a partner to exclude a module normally thought of as a
343 // framework module from the vendor snapshot.
344 Exclude_from_vendor_snapshot *bool
345
346 // Normally Soong uses the directory structure to decide which modules
347 // should be included (framework) or excluded (non-framework) from the
348 // different snapshots (vendor, recovery, etc.), but this property
349 // allows a partner to exclude a module normally thought of as a
350 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800351 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900352
353 // List of APEXes that this module has private access to for testing purpose. The module
354 // can depend on libraries that are not exported by the APEXes and use private symbols
355 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000356 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800357
358 Target struct {
359 Platform struct {
360 // List of modules required by the core variant.
361 Required []string `android:"arch_variant"`
362
363 // List of modules not required by the core variant.
364 Exclude_required []string `android:"arch_variant"`
365 } `android:"arch_variant"`
366
367 Recovery struct {
368 // List of modules required by the recovery variant.
369 Required []string `android:"arch_variant"`
370
371 // List of modules not required by the recovery variant.
372 Exclude_required []string `android:"arch_variant"`
373 } `android:"arch_variant"`
374 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700375}
376
377type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900378 // whether this module should be allowed to be directly depended by other
379 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900380 // If set to true, two variants will be built separately, one like
381 // normal, and the other limited to the set of libraries and headers
382 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700383 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900384 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700385 // so it shouldn't have any unversioned runtime dependencies, or
386 // make assumptions about the system that may not be true in the
387 // future.
388 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900389 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900390 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900391 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900392 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900393 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700394 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
395 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900396
Justin Yunebcf0c52021-01-08 18:00:19 +0900397 // This is the same as the "vendor_available" except that the install path
398 // of the vendor variant is /odm or /vendor/odm.
399 // By replacing "vendor_available: true" with "odm_available: true", the
400 // module will install its vendor variant to the /odm partition or /vendor/odm.
401 // As the modules with "odm_available: true" still create the vendor variants,
402 // they can link to the other vendor modules as the vendor_available modules do.
403 // Also, the vendor modules can link to odm_available modules.
404 //
405 // It may not be used for VNDK modules.
406 Odm_available *bool
407
Justin Yun63e9ec72020-10-29 16:49:43 +0900408 // whether this module should be allowed to be directly depended by other
409 // modules with `product_specific: true` or `product_available: true`.
410 // If set to true, an additional product variant will be built separately
411 // that is limited to the set of libraries and headers that are exposed to
412 // /product modules.
413 //
414 // The product variant may be used with a different (newer) /system,
415 // so it shouldn't have any unversioned runtime dependencies, or
416 // make assumptions about the system that may not be true in the
417 // future.
418 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900419 // If set to false, this module becomes inaccessible from /product modules.
420 //
421 // Different from the 'vendor_available' property, the modules with
422 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
423 // library without 'product_available' may not be depended on by any other
424 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900425 //
426 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
427 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
428 Product_available *bool
429
Jiyong Park5fb8c102018-04-09 12:03:06 +0900430 // whether this module is capable of being loaded with other instance
431 // (possibly an older version) of the same module in the same process.
432 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
433 // can be double loaded in a vendor process if the library is also a
434 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
435 // explicitly marked as `double_loadable: true` by the owner, or the dependency
436 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
437 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800438
439 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
440 IsLLNDK bool `blueprint:"mutated"`
441
Colin Cross78212242021-01-06 14:51:30 -0800442 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
443 // set and the module is not listed in VndkMustUseVendorVariantList.
444 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
445
446 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
447 IsVNDKCore bool `blueprint:"mutated"`
448
449 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
450 IsVNDKSP bool `blueprint:"mutated"`
451
452 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
453 // module sets the llndk.private property.
454 IsVNDKPrivate bool `blueprint:"mutated"`
455
456 // IsVNDKProduct is set if a VNDK module sets the product_available property.
457 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700458
459 // IsVendorPublicLibrary is set for the core and product variants of a library that has
460 // vendor_public_library stubs.
461 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800462}
463
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500464// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
465// to understanding details about the type of the current module.
466// For example, one might call these functions to determine whether the current module is a static
467// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800468type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800469 static() bool
470 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700471 testBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900472 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900473 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900474 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700475 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900476 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700477 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800478 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900479 minSdkVersion() string
480 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700481 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700482 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800483 IsLlndk() bool
484 IsLlndkPublic() bool
485 isImplementationForLLNDKPublic() bool
486 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900487 isVndk() bool
488 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500489 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700490 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900491 inProduct() bool
492 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800493 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700494 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900495 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700496 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700497 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800498 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800499 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800500 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800501 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800502 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700503 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700504 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900505 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800506 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700507 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700508 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800509 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800510 isCfiAssemblySupportEnabled() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800511}
512
513type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700514 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800515 ModuleContextIntf
516}
517
518type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700519 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800520 ModuleContextIntf
521}
522
Colin Cross37047f12016-12-13 17:06:13 -0800523type DepsContext interface {
524 android.BottomUpMutatorContext
525 ModuleContextIntf
526}
527
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500528// feature represents additional (optional) steps to building cc-related modules, such as invocation
529// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800530type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800531 flags(ctx ModuleContext, flags Flags) Flags
532 props() []interface{}
533}
534
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500535// compiler is the interface for a compiler helper object. Different module decorators may implement
536// this helper differently. For example, compiling a `cc_library` may use a different build
537// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800538type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700539 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800540 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800541 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700542 compilerProps() []interface{}
543
Colin Cross76fada02016-07-27 10:31:13 -0700544 appendCflags([]string)
545 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700546 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800547}
548
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500549// linker is the interface for a linker decorator object. Individual module types can provide
550// their own implementation for this decorator, and thus specify custom logic regarding build
551// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800552type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700553 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800554 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700555 linkerFlags(ctx ModuleContext, flags Flags) Flags
556 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800557 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700558
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700559 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700560 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900561 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700562
563 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900564 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000565
566 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000567 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
568}
569
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500570// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000571type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500572 sharedLibs []string
573 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
574 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700575 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800576}
577
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500578// installer is the interface for an installer helper object. This helper is responsible for
579// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800580type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700581 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700582 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000583 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800584 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700585 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700586 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900587 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100588 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900589 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800590}
591
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800592type xref interface {
593 XrefCcFiles() android.Paths
594}
595
Colin Cross6e511a92020-07-27 21:26:48 -0700596type libraryDependencyKind int
597
598const (
599 headerLibraryDependency = iota
600 sharedLibraryDependency
601 staticLibraryDependency
602)
603
604func (k libraryDependencyKind) String() string {
605 switch k {
606 case headerLibraryDependency:
607 return "headerLibraryDependency"
608 case sharedLibraryDependency:
609 return "sharedLibraryDependency"
610 case staticLibraryDependency:
611 return "staticLibraryDependency"
612 default:
613 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
614 }
615}
616
617type libraryDependencyOrder int
618
619const (
620 earlyLibraryDependency = -1
621 normalLibraryDependency = 0
622 lateLibraryDependency = 1
623)
624
625func (o libraryDependencyOrder) String() string {
626 switch o {
627 case earlyLibraryDependency:
628 return "earlyLibraryDependency"
629 case normalLibraryDependency:
630 return "normalLibraryDependency"
631 case lateLibraryDependency:
632 return "lateLibraryDependency"
633 default:
634 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
635 }
636}
637
638// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
639// tags that have a set of predefined tag objects that are reused for each dependency, a
640// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
641// That means that comparing a libraryDependencyTag for equality will only be equal if all
642// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
643// then check individual metadata fields instead.
644type libraryDependencyTag struct {
645 blueprint.BaseDependencyTag
646
647 // These are exported so that fmt.Printf("%#v") can call their String methods.
648 Kind libraryDependencyKind
649 Order libraryDependencyOrder
650
651 wholeStatic bool
652
653 reexportFlags bool
654 explicitlyVersioned bool
655 dataLib bool
656 ndk bool
657
658 staticUnwinder bool
659
660 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900661
Cindy Zhou18417cb2020-12-10 07:12:38 -0800662 // Whether or not this dependency should skip the apex dependency check
663 skipApexAllowedDependenciesCheck bool
664
Jiyong Parke3867542020-12-03 17:28:25 +0900665 // Whether or not this dependency has to be followed for the apex variants
666 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700667}
668
669// header returns true if the libraryDependencyTag is tagging a header lib dependency.
670func (d libraryDependencyTag) header() bool {
671 return d.Kind == headerLibraryDependency
672}
673
674// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
675func (d libraryDependencyTag) shared() bool {
676 return d.Kind == sharedLibraryDependency
677}
678
679// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
680func (d libraryDependencyTag) static() bool {
681 return d.Kind == staticLibraryDependency
682}
683
Colin Crosse9fe2942020-11-10 18:12:15 -0800684// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
685// binaries or other shared libraries are installed as dependencies.
686func (d libraryDependencyTag) InstallDepNeeded() bool {
687 return d.shared()
688}
689
690var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
691
692// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700693// libraryDependencyTag. Each tag object is created globally and reused for multiple
694// dependencies (although since the object contains no references, assigning a tag to a
695// variable and modifying it will not modify the original). Users can compare the tag
696// returned by ctx.OtherModuleDependencyTag against the global original
697type dependencyTag struct {
698 blueprint.BaseDependencyTag
699 name string
700}
701
Colin Crosse9fe2942020-11-10 18:12:15 -0800702// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
703// libraryDependencyTag, but where the dependency needs to be installed when the parent is
704// installed.
705type installDependencyTag struct {
706 blueprint.BaseDependencyTag
707 android.InstallAlwaysNeededDependencyTag
708 name string
709}
710
Colin Crossc99deeb2016-04-11 15:06:20 -0700711var (
Colin Cross6e511a92020-07-27 21:26:48 -0700712 genSourceDepTag = dependencyTag{name: "gen source"}
713 genHeaderDepTag = dependencyTag{name: "gen header"}
714 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
715 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900716 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700717 reuseObjTag = dependencyTag{name: "reuse objects"}
718 staticVariantTag = dependencyTag{name: "static variant"}
719 vndkExtDepTag = dependencyTag{name: "vndk extends"}
720 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800721 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700722 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700723 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700724)
725
Roland Levillainf89cd092019-07-29 16:22:59 +0100726func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700727 ccLibDepTag, ok := depTag.(libraryDependencyTag)
728 return ok && ccLibDepTag.shared()
729}
730
731func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
732 ccLibDepTag, ok := depTag.(libraryDependencyTag)
733 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100734}
735
Zach Johnson3df4e632020-11-06 11:56:27 -0800736func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
737 ccLibDepTag, ok := depTag.(libraryDependencyTag)
738 return ok && ccLibDepTag.header()
739}
740
Roland Levillainf89cd092019-07-29 16:22:59 +0100741func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800742 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100743}
744
745func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700746 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100747 return ok && ccDepTag == testPerSrcDepTag
748}
749
Colin Crossca860ac2016-01-04 14:34:37 -0800750// Module contains the properties and members used by all C/C++ module types, and implements
751// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500752// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
753// interface.
754//
755// To define a C/C++ related module, construct a new Module object and point its delegates to
756// type-specific structs. These delegates will be invoked to register module-specific build
757// statements which may be unique to the module type. For example, module.compiler.compile() should
758// be defined so as to register build statements which are responsible for compiling the module.
759//
760// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
761// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
762// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
763// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800764type Module struct {
hamzeh41ad8812021-07-07 14:00:07 -0700765 FuzzModule
766
Jiyong Parkd1063c12019-07-17 20:08:41 +0900767 android.SdkBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500768 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700769
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700770 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700771 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700772
Colin Crossca860ac2016-01-04 14:34:37 -0800773 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700774 hod android.HostOrDeviceSupported
775 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700776
Paul Duffina0843f62019-12-13 19:50:38 +0000777 // Allowable SdkMemberTypes of this module type.
778 sdkMemberTypes []android.SdkMemberType
779
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500780 // decorator delegates, initialize before calling Init
781 // these may contain module-specific implementations, and effectively allow for custom
782 // type-specific logic. These members may reference different objects or the same object.
783 // Functions of these decorators will be invoked to initialize and register type-specific
784 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500785 compiler compiler
786 linker linker
787 installer installer
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000788 bazelHandler android.BazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500789
790 features []feature
791 stl *stl
792 sanitize *sanitize
793 coverage *coverage
794 sabi *sabi
795 vndkdep *vndkdep
796 lto *lto
797 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800798
Colin Cross31076b32020-10-23 17:22:06 -0700799 library libraryInterface
800
Colin Cross635c3b02016-05-18 15:37:25 -0700801 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800802
Colin Crossb98c8b02016-07-29 13:44:28 -0700803 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700804
805 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800806
807 // Flags used to compile this module
808 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700809
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800810 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700811 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900812
813 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800814 // Kythe (source file indexer) paths for this compilation module
815 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900816
817 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700818 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700819
820 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700821}
822
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200823func (c *Module) AddJSONData(d *map[string]interface{}) {
824 c.AndroidModuleBase().AddJSONData(d)
825 (*d)["Cc"] = map[string]interface{}{
826 "SdkVersion": c.SdkVersion(),
827 "MinSdkVersion": c.MinSdkVersion(),
828 "VndkVersion": c.VndkVersion(),
829 "ProductSpecific": c.ProductSpecific(),
830 "SocSpecific": c.SocSpecific(),
831 "DeviceSpecific": c.DeviceSpecific(),
832 "InProduct": c.InProduct(),
833 "InVendor": c.InVendor(),
834 "InRamdisk": c.InRamdisk(),
835 "InVendorRamdisk": c.InVendorRamdisk(),
836 "InRecovery": c.InRecovery(),
837 "VendorAvailable": c.VendorAvailable(),
838 "ProductAvailable": c.ProductAvailable(),
839 "RamdiskAvailable": c.RamdiskAvailable(),
840 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
841 "RecoveryAvailable": c.RecoveryAvailable(),
842 "OdmAvailable": c.OdmAvailable(),
843 "InstallInData": c.InstallInData(),
844 "InstallInRamdisk": c.InstallInRamdisk(),
845 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
846 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
847 "InstallInRecovery": c.InstallInRecovery(),
848 "InstallInRoot": c.InstallInRoot(),
849 "IsVndk": c.IsVndk(),
850 "IsVndkExt": c.IsVndkExt(),
851 "IsVndkPrivate": c.IsVndkPrivate(),
852 "IsVndkSp": c.IsVndkSp(),
853 "IsLlndk": c.IsLlndk(),
854 "IsLlndkPublic": c.IsLlndkPublic(),
855 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
856 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
857 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
858 "ApexSdkVersion": c.apexSdkVersion,
859 "TestFor": c.TestFor(),
860 }
861}
862
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500863func (c *Module) SetPreventInstall() {
864 c.Properties.PreventInstall = true
865}
866
867func (c *Module) SetHideFromMake() {
868 c.Properties.HideFromMake = true
869}
870
Ivan Lozanod7586b62021-04-01 09:49:36 -0400871func (c *Module) HiddenFromMake() bool {
872 return c.Properties.HideFromMake
873}
874
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800875func (c *Module) RequiredModuleNames() []string {
876 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
877 if c.ImageVariation().Variation == android.CoreVariation {
878 required = append(required, c.Properties.Target.Platform.Required...)
879 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
880 } else if c.InRecovery() {
881 required = append(required, c.Properties.Target.Recovery.Required...)
882 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
883 }
884 return android.FirstUniqueStrings(required)
885}
886
Ivan Lozano52767be2019-10-18 14:49:46 -0700887func (c *Module) Toc() android.OptionalPath {
888 if c.linker != nil {
889 if library, ok := c.linker.(libraryInterface); ok {
890 return library.toc()
891 }
892 }
893 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
894}
895
896func (c *Module) ApiLevel() string {
897 if c.linker != nil {
898 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700899 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700900 }
901 }
902 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
903}
904
905func (c *Module) Static() bool {
906 if c.linker != nil {
907 if library, ok := c.linker.(libraryInterface); ok {
908 return library.static()
909 }
910 }
911 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
912}
913
914func (c *Module) Shared() bool {
915 if c.linker != nil {
916 if library, ok := c.linker.(libraryInterface); ok {
917 return library.shared()
918 }
919 }
920 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
921}
922
923func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000924 if c.stl != nil {
925 return c.stl.Properties.SelectedStl
926 }
927 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700928}
929
930func (c *Module) ToolchainLibrary() bool {
931 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
932 return true
933 }
934 return false
935}
936
937func (c *Module) NdkPrebuiltStl() bool {
938 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
939 return true
940 }
941 return false
942}
943
944func (c *Module) StubDecorator() bool {
945 if _, ok := c.linker.(*stubDecorator); ok {
946 return true
947 }
948 return false
949}
950
951func (c *Module) SdkVersion() string {
952 return String(c.Properties.Sdk_version)
953}
954
Artur Satayev480e25b2020-04-27 18:53:18 +0100955func (c *Module) MinSdkVersion() string {
956 return String(c.Properties.Min_sdk_version)
957}
958
Dan Albert92fe7402020-07-15 13:33:30 -0700959func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700960 if !c.canUseSdk() {
961 return false
962 }
Dan Albert92fe7402020-07-15 13:33:30 -0700963 if linker, ok := c.linker.(*objectLinker); ok {
964 return linker.isCrt()
965 }
966 return false
967}
968
Colin Crossc511bc52020-04-07 16:50:32 +0000969func (c *Module) AlwaysSdk() bool {
970 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
971}
972
Ivan Lozano183a3212019-10-18 14:18:45 -0700973func (c *Module) CcLibrary() bool {
974 if c.linker != nil {
975 if _, ok := c.linker.(*libraryDecorator); ok {
976 return true
977 }
Colin Crossd48fe732020-09-23 20:37:24 -0700978 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
979 return true
980 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700981 }
982 return false
983}
984
985func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700986 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700987 return true
988 }
989 return false
990}
991
Ivan Lozano2b262972019-11-21 12:30:50 -0800992func (c *Module) NonCcVariants() bool {
993 return false
994}
995
Ivan Lozano183a3212019-10-18 14:18:45 -0700996func (c *Module) SetStatic() {
997 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700998 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700999 library.setStatic()
1000 return
1001 }
1002 }
1003 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1004}
1005
1006func (c *Module) SetShared() {
1007 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001008 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001009 library.setShared()
1010 return
1011 }
1012 }
1013 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1014}
1015
1016func (c *Module) BuildStaticVariant() bool {
1017 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001018 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001019 return library.buildStatic()
1020 }
1021 }
1022 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1023}
1024
1025func (c *Module) BuildSharedVariant() bool {
1026 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001027 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001028 return library.buildShared()
1029 }
1030 }
1031 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1032}
1033
1034func (c *Module) Module() android.Module {
1035 return c
1036}
1037
Jiyong Parkc20eee32018-09-05 22:36:17 +09001038func (c *Module) OutputFile() android.OptionalPath {
1039 return c.outputFile
1040}
1041
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001042func (c *Module) CoverageFiles() android.Paths {
1043 if c.linker != nil {
1044 if library, ok := c.linker.(libraryInterface); ok {
1045 return library.objs().coverageFiles
1046 }
1047 }
1048 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1049}
1050
Ivan Lozano183a3212019-10-18 14:18:45 -07001051var _ LinkableInterface = (*Module)(nil)
1052
Jiyong Park719b4462019-01-13 00:39:51 +09001053func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001054 if c.linker != nil {
1055 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001056 }
1057 return nil
1058}
1059
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001060func (c *Module) CoverageOutputFile() android.OptionalPath {
1061 if c.linker != nil {
1062 return c.linker.coverageOutputFilePath()
1063 }
1064 return android.OptionalPath{}
1065}
1066
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001067func (c *Module) RelativeInstallPath() string {
1068 if c.installer != nil {
1069 return c.installer.relativeInstallPath()
1070 }
1071 return ""
1072}
1073
Jooyung Han344d5432019-08-23 11:17:39 +09001074func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001075 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001076}
1077
Colin Cross36242852017-06-23 15:06:31 -07001078func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001079 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001080 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001081 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001082 }
1083 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001084 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001085 }
1086 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001087 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001088 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001089 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001090 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001091 }
Colin Cross16b23492016-01-06 14:41:07 -08001092 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001093 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001094 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001095 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001096 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001097 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001098 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001099 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001100 }
Justin Yun8effde42017-06-23 19:24:43 +09001101 if c.vndkdep != nil {
1102 c.AddProperties(c.vndkdep.props()...)
1103 }
Stephen Craneba090d12017-05-09 15:44:35 -07001104 if c.lto != nil {
1105 c.AddProperties(c.lto.props()...)
1106 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001107 if c.pgo != nil {
1108 c.AddProperties(c.pgo.props()...)
1109 }
Colin Crossca860ac2016-01-04 14:34:37 -08001110 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001111 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001112 }
Colin Crossc472d572015-03-17 15:06:21 -07001113
Colin Cross36242852017-06-23 15:06:31 -07001114 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerea6666f2021-02-17 10:17:28 -05001115 android.InitBazelModule(c)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001116 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001117 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001118 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001119
Colin Cross36242852017-06-23 15:06:31 -07001120 return c
Colin Crossc472d572015-03-17 15:06:21 -07001121}
1122
Ivan Lozano52767be2019-10-18 14:49:46 -07001123func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001124 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001125}
1126
Colin Crossc511bc52020-04-07 16:50:32 +00001127func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001128 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1129 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001130}
1131
1132func (c *Module) UseSdk() bool {
1133 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001134 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001135 }
1136 return false
1137}
1138
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001139func (c *Module) isCoverageVariant() bool {
1140 return c.coverage.Properties.IsCoverageVariant
1141}
1142
Colin Cross95f1ca02020-10-29 20:47:22 -07001143func (c *Module) IsNdk(config android.Config) bool {
1144 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001145}
1146
Colin Cross127bb8b2020-12-16 16:46:01 -08001147func (c *Module) IsLlndk() bool {
1148 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001149}
1150
Colin Cross127bb8b2020-12-16 16:46:01 -08001151func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001152 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001153}
1154
Colin Cross1f3f1302021-04-26 18:37:44 -07001155func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001156 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001157 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001158}
1159
Colin Cross5271fea2021-04-27 13:06:04 -07001160func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1161 lib := moduleLibraryInterface(m)
1162 return lib != nil && (lib.hasVendorPublicLibrary())
1163}
1164
1165// IsVendorPublicLibrary returns true for vendor public libraries.
1166func (c *Module) IsVendorPublicLibrary() bool {
1167 return c.VendorProperties.IsVendorPublicLibrary
1168}
1169
Ivan Lozanod7586b62021-04-01 09:49:36 -04001170func (c *Module) HasLlndkStubs() bool {
1171 lib := moduleLibraryInterface(c)
1172 return lib != nil && lib.hasLLNDKStubs()
1173}
1174
1175func (c *Module) StubsVersion() string {
1176 if lib, ok := c.linker.(versionedInterface); ok {
1177 return lib.stubsVersion()
1178 }
1179 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1180}
1181
Colin Cross127bb8b2020-12-16 16:46:01 -08001182// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1183// and does not set llndk.vendor_available: false.
1184func (c *Module) isImplementationForLLNDKPublic() bool {
1185 library, _ := c.library.(*libraryDecorator)
1186 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001187 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001188}
1189
Justin Yunfd9e8042020-12-23 18:23:14 +09001190// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001191func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001192 // Check if VNDK-core-private or VNDK-SP-private
1193 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001194 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001195 }
1196
1197 // Check if LLNDK-private
1198 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001199 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001200 }
1201
1202 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001203}
1204
Ivan Lozano52767be2019-10-18 14:49:46 -07001205func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001206 if vndkdep := c.vndkdep; vndkdep != nil {
1207 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001208 }
1209 return false
1210}
1211
Yi Kong7e53c572018-02-14 18:16:12 +08001212func (c *Module) isPgoCompile() bool {
1213 if pgo := c.pgo; pgo != nil {
1214 return pgo.Properties.PgoCompile
1215 }
1216 return false
1217}
1218
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001219func (c *Module) isNDKStubLibrary() bool {
1220 if _, ok := c.compiler.(*stubDecorator); ok {
1221 return true
1222 }
1223 return false
1224}
1225
Ivan Lozanod7586b62021-04-01 09:49:36 -04001226func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001227 if vndkdep := c.vndkdep; vndkdep != nil {
1228 return vndkdep.isVndkSp()
1229 }
1230 return false
1231}
1232
Ivan Lozanof9e21722020-12-02 09:00:51 -05001233func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001234 if vndkdep := c.vndkdep; vndkdep != nil {
1235 return vndkdep.isVndkExt()
1236 }
1237 return false
1238}
1239
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001240func (c *Module) SubName() string {
1241 return c.Properties.SubName
1242}
1243
Ivan Lozano52767be2019-10-18 14:49:46 -07001244func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001245 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001246}
1247
Logan Chienf3511742017-10-31 18:04:35 +08001248func (c *Module) getVndkExtendsModuleName() string {
1249 if vndkdep := c.vndkdep; vndkdep != nil {
1250 return vndkdep.getVndkExtendsModuleName()
1251 }
1252 return ""
1253}
1254
Jiyong Park25fc6a92018-11-18 18:02:45 +09001255func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001256 if lib := c.library; lib != nil {
1257 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001258 }
1259 return false
1260}
1261
1262func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001263 if lib := c.library; lib != nil {
1264 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001265 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001266 return false
1267}
1268
Colin Cross0477b422020-10-13 18:43:54 -07001269// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1270// the implementation. If it is an implementation library it returns its own name.
1271func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1272 name := ctx.OtherModuleName(c)
1273 if versioned, ok := c.linker.(versionedInterface); ok {
1274 name = versioned.implementationModuleName(name)
1275 }
1276 return name
1277}
1278
Martin Stjernholm2856c662020-12-02 15:03:42 +00001279// Similar to ImplementationModuleName, but uses the Make variant of the module
1280// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1281// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1282// under the premise that the prebuilt module overrides its source counterpart
1283// if it is exposed to Make).
1284func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1285 name := c.BaseModuleName()
1286 if versioned, ok := c.linker.(versionedInterface); ok {
1287 name = versioned.implementationModuleName(name)
1288 }
1289 return name
1290}
1291
Jiyong Park7d55b612021-06-11 17:22:09 +09001292func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001293 return Bool(c.Properties.Bootstrap)
1294}
1295
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001296func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001297 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1298 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1299 return false
1300 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001301 return c.linker != nil && c.linker.nativeCoverage()
1302}
1303
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001304func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001305 if p, ok := c.linker.(SnapshotInterface); ok {
1306 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001307 }
1308 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001309}
1310
Bill Peckham945441c2020-08-31 16:07:58 -07001311func (c *Module) ExcludeFromVendorSnapshot() bool {
1312 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1313}
1314
Jose Galmesf7294582020-11-13 12:07:36 -08001315func (c *Module) ExcludeFromRecoverySnapshot() bool {
1316 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1317}
1318
Jiyong Parkf1194352019-02-25 11:05:47 +09001319func isBionic(name string) bool {
1320 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001321 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001322 return true
1323 }
1324 return false
1325}
1326
Martin Stjernholm279de572019-09-10 23:18:20 +01001327func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001328 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001329 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001330 }
1331 return isBionic(name)
1332}
1333
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001334func (c *Module) XrefCcFiles() android.Paths {
1335 return c.kytheFiles
1336}
1337
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001338func (c *Module) isCfiAssemblySupportEnabled() bool {
1339 return c.sanitize != nil &&
1340 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1341}
1342
Inseob Kim800d1142021-06-14 12:03:51 +09001343func (c *Module) InstallInRoot() bool {
1344 return c.installer != nil && c.installer.installInRoot()
1345}
1346
Colin Crossca860ac2016-01-04 14:34:37 -08001347type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001348 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001349 moduleContextImpl
1350}
1351
Colin Cross37047f12016-12-13 17:06:13 -08001352type depsContext struct {
1353 android.BottomUpMutatorContext
1354 moduleContextImpl
1355}
1356
Colin Crossca860ac2016-01-04 14:34:37 -08001357type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001358 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001359 moduleContextImpl
1360}
1361
1362type moduleContextImpl struct {
1363 mod *Module
1364 ctx BaseModuleContext
1365}
1366
Colin Crossb98c8b02016-07-29 13:44:28 -07001367func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001368 return ctx.mod.toolchain(ctx.ctx)
1369}
1370
1371func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001372 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001373}
1374
1375func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001376 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001377}
1378
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001379func (ctx *moduleContextImpl) testBinary() bool {
1380 return ctx.mod.testBinary()
1381}
1382
Jiyong Park1d1119f2019-07-29 21:27:18 +09001383func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001384 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001385}
1386
Inseob Kim7f283f42020-06-01 21:53:49 +09001387func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001388 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001389}
1390
Inseob Kim1042d292020-06-01 23:23:05 +09001391func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001392 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001393}
1394
Jooyung Hanccce2f22020-03-07 03:45:53 +09001395func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001396 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001397}
1398
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001399func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001400 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001401}
1402
1403func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001404 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001405 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001406 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001407 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001408 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001409 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001410 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001411 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001412 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001413 }
1414 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001415}
1416
Jiyong Parkb35a8192020-08-10 15:59:36 +09001417func (ctx *moduleContextImpl) minSdkVersion() string {
1418 ver := ctx.mod.MinSdkVersion()
1419 if ver == "apex_inherit" && !ctx.isForPlatform() {
1420 ver = ctx.apexSdkVersion().String()
1421 }
1422 if ver == "apex_inherit" || ver == "" {
1423 ver = ctx.sdkVersion()
1424 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001425 // For crt objects, the meaning of min_sdk_version is very different from other types of
1426 // module. For them, min_sdk_version defines the oldest version that the build system will
1427 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1428 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1429 // and min_sdk_version properties of the variants are set to the corresponding version
1430 // numbers. However, the platform (non-sdk) variant of the crt object is left untouched.
1431 // min_sdk_version: 16 doesn't actually mean that the platform variant has to support such
1432 // an old version. Since the variant is for the platform, it's preferred to target the
1433 // latest version.
1434 if ctx.mod.SplitPerApiLevel() && !ctx.isSdkVariant() {
1435 ver = strconv.Itoa(android.FutureApiLevelInt)
1436 }
1437
Jiyong Parkb35a8192020-08-10 15:59:36 +09001438 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1439 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1440 minSdkVersionInt, err2 := strconv.Atoi(ver)
1441 if err == nil && err2 == nil {
1442 if sdkVersionInt < minSdkVersionInt {
1443 return strconv.Itoa(sdkVersionInt)
1444 }
1445 }
1446 return ver
1447}
1448
1449func (ctx *moduleContextImpl) isSdkVariant() bool {
1450 return ctx.mod.IsSdkVariant()
1451}
1452
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001453func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001454 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001455}
Justin Yun8effde42017-06-23 19:24:43 +09001456
Colin Cross95f1ca02020-10-29 20:47:22 -07001457func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1458 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001459}
1460
Colin Cross127bb8b2020-12-16 16:46:01 -08001461func (ctx *moduleContextImpl) IsLlndk() bool {
1462 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001463}
1464
Colin Cross127bb8b2020-12-16 16:46:01 -08001465func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1466 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001467}
1468
Colin Cross127bb8b2020-12-16 16:46:01 -08001469func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1470 return ctx.mod.isImplementationForLLNDKPublic()
1471}
1472
1473func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1474 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001475}
1476
Logan Chienf3511742017-10-31 18:04:35 +08001477func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001478 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001479}
1480
Yi Kong7e53c572018-02-14 18:16:12 +08001481func (ctx *moduleContextImpl) isPgoCompile() bool {
1482 return ctx.mod.isPgoCompile()
1483}
1484
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001485func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1486 return ctx.mod.isNDKStubLibrary()
1487}
1488
Justin Yun8effde42017-06-23 19:24:43 +09001489func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001490 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001491}
1492
Ivan Lozanof9e21722020-12-02 09:00:51 -05001493func (ctx *moduleContextImpl) IsVndkExt() bool {
1494 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001495}
1496
Colin Cross5271fea2021-04-27 13:06:04 -07001497func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1498 return ctx.mod.IsVendorPublicLibrary()
1499}
1500
Vic Yangefd249e2018-11-12 20:19:56 -08001501func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001502 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001503}
1504
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001505func (ctx *moduleContextImpl) selectedStl() string {
1506 if stl := ctx.mod.stl; stl != nil {
1507 return stl.Properties.SelectedStl
1508 }
1509 return ""
1510}
1511
Ivan Lozanobd721262018-11-27 14:33:03 -08001512func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1513 return ctx.mod.linker.useClangLld(actx)
1514}
1515
Colin Crossce75d2c2016-10-06 16:12:58 -07001516func (ctx *moduleContextImpl) baseModuleName() string {
1517 return ctx.mod.ModuleBase.BaseModuleName()
1518}
1519
Logan Chienf3511742017-10-31 18:04:35 +08001520func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1521 return ctx.mod.getVndkExtendsModuleName()
1522}
1523
Logan Chiene274fc92019-12-03 11:18:32 -08001524func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001525 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001526}
1527
Colin Crosse07f2312020-08-13 11:24:56 -07001528func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001529 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001530}
1531
Dan Albertc8060532020-07-22 22:32:17 -07001532func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001533 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001534}
1535
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001536func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001537 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001538}
1539
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001540func (ctx *moduleContextImpl) nativeCoverage() bool {
1541 return ctx.mod.nativeCoverage()
1542}
1543
Colin Cross56a83212020-09-15 18:30:11 -07001544func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1545 return ctx.mod.DirectlyInAnyApex()
1546}
1547
Colin Cross95b07f22020-12-16 11:06:50 -08001548func (ctx *moduleContextImpl) isPreventInstall() bool {
1549 return ctx.mod.Properties.PreventInstall
1550}
1551
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001552func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1553 return ctx.mod.isCfiAssemblySupportEnabled()
1554}
1555
Colin Cross635c3b02016-05-18 15:37:25 -07001556func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001557 return &Module{
1558 hod: hod,
1559 multilib: multilib,
1560 }
1561}
1562
Colin Cross635c3b02016-05-18 15:37:25 -07001563func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001564 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001565 module.features = []feature{
1566 &tidyFeature{},
1567 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001568 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001569 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001570 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001571 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001572 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001573 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001574 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001575 return module
1576}
1577
Colin Crossce75d2c2016-10-06 16:12:58 -07001578func (c *Module) Prebuilt() *android.Prebuilt {
1579 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1580 return p.prebuilt()
1581 }
1582 return nil
1583}
1584
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001585func (c *Module) IsPrebuilt() bool {
1586 return c.Prebuilt() != nil
1587}
1588
Colin Crossce75d2c2016-10-06 16:12:58 -07001589func (c *Module) Name() string {
1590 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001591 if p, ok := c.linker.(interface {
1592 Name(string) string
1593 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001594 name = p.Name(name)
1595 }
1596 return name
1597}
1598
Alex Light3d673592019-01-18 14:37:31 -08001599func (c *Module) Symlinks() []string {
1600 if p, ok := c.installer.(interface {
1601 symlinkList() []string
1602 }); ok {
1603 return p.symlinkList()
1604 }
1605 return nil
1606}
1607
Roland Levillainf89cd092019-07-29 16:22:59 +01001608func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1609 test, ok := c.linker.(testPerSrc)
1610 return ok && test.isAllTestsVariation()
1611}
1612
Chris Parsons216e10a2020-07-09 17:12:52 -04001613func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001614 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001615 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001616 }); ok {
1617 return p.dataPaths()
1618 }
1619 return nil
1620}
1621
Justin Yun5f7f7e82019-11-18 19:52:14 +09001622func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1623 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1624 // "current", it will append the VNDK version to the name suffix.
1625 var vndkVersion string
1626 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001627 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001628 if c.ProductSpecific() {
1629 // If the module is product specific with 'product_specific: true',
1630 // do not add a name suffix because it is a base module.
1631 return ""
1632 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001633 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1634 nameSuffix = productSuffix
1635 } else {
1636 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001637 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001638 }
1639 if vndkVersion == "current" {
1640 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1641 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001642 if c.Properties.VndkVersion != vndkVersion && c.Properties.VndkVersion != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001643 // add version suffix only if the module is using different vndk version than the
1644 // version in product or vendor partition.
1645 nameSuffix += "." + c.Properties.VndkVersion
1646 }
1647 return nameSuffix
1648}
1649
Chris Parsons8d6e4332021-02-22 16:13:50 -05001650func (c *Module) setSubnameProperty(actx android.ModuleContext) {
Inseob Kim64c43952019-08-26 16:52:35 +09001651 c.Properties.SubName = ""
1652
1653 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1654 c.Properties.SubName += nativeBridgeSuffix
1655 }
1656
Colin Cross127bb8b2020-12-16 16:46:01 -08001657 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001658 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001659 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1660 // added for product variant only when we have vendor and product variants with core
1661 // variant. The suffix is not added for vendor-only or product-only module.
1662 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
Colin Cross5271fea2021-04-27 13:06:04 -07001663 } else if c.IsVendorPublicLibrary() {
1664 c.Properties.SubName += vendorPublicLibrarySuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001665 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001666 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1667 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001668 c.Properties.SubName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001669 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1670 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001671 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001672 c.Properties.SubName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001673 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001674 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001675 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001676 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001677 if c.SplitPerApiLevel() {
1678 c.Properties.SubName += "." + c.SdkVersion()
1679 }
Inseob Kim64c43952019-08-26 16:52:35 +09001680 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001681}
1682
1683// Returns true if Bazel was successfully used for the analysis of this module.
1684func (c *Module) maybeGenerateBazelActions(actx android.ModuleContext) bool {
Liz Kammerbdc60992021-02-24 16:55:11 -05001685 bazelModuleLabel := c.GetBazelLabel(actx, c)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001686 bazelActionsUsed := false
Chris Parsonsbab4d7e2021-04-15 17:27:08 -04001687 if c.MixedBuildsEnabled(actx) && c.bazelHandler != nil {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +00001688 bazelActionsUsed = c.bazelHandler.GenerateBazelBuildActions(actx, bazelModuleLabel)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001689 }
1690 return bazelActionsUsed
1691}
1692
1693func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1694 // TODO(cparsons): Any logic in this method occurring prior to querying Bazel should be
1695 // requested from Bazel instead.
1696
1697 // Handle the case of a test module split by `test_per_src` mutator.
1698 //
1699 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1700 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1701 // module and return early, as this module does not produce an output file per se.
1702 if c.IsTestPerSrcAllTestsVariation() {
1703 c.outputFile = android.OptionalPath{}
1704 return
1705 }
1706
1707 c.setSubnameProperty(actx)
1708 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1709 if !apexInfo.IsForPlatform() {
1710 c.hideApexVariantFromMake = true
1711 }
1712
Chris Parsonseefc9e62021-04-02 17:36:47 -04001713 c.makeLinkType = GetMakeLinkType(actx, c)
1714
Colin Crossca860ac2016-01-04 14:34:37 -08001715 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001716 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001717 moduleContextImpl: moduleContextImpl{
1718 mod: c,
1719 },
1720 }
1721 ctx.ctx = ctx
1722
Chris Parsons94a0bba2021-06-04 15:03:47 -04001723 if c.maybeGenerateBazelActions(actx) {
1724 c.maybeInstall(ctx, apexInfo)
1725 return
1726 }
1727
Colin Crossf18e1102017-11-16 14:33:08 -08001728 deps := c.depsToPaths(ctx)
1729 if ctx.Failed() {
1730 return
1731 }
1732
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001733 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1734 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1735 }
1736
Colin Crossca860ac2016-01-04 14:34:37 -08001737 flags := Flags{
1738 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001739 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001740 }
Colin Crossca860ac2016-01-04 14:34:37 -08001741 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001742 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001743 }
1744 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001745 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001746 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001747 if c.stl != nil {
1748 flags = c.stl.flags(ctx, flags)
1749 }
Colin Cross16b23492016-01-06 14:41:07 -08001750 if c.sanitize != nil {
1751 flags = c.sanitize.flags(ctx, flags)
1752 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001753 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001754 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001755 }
Stephen Craneba090d12017-05-09 15:44:35 -07001756 if c.lto != nil {
1757 flags = c.lto.flags(ctx, flags)
1758 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001759 if c.pgo != nil {
1760 flags = c.pgo.flags(ctx, flags)
1761 }
Colin Crossca860ac2016-01-04 14:34:37 -08001762 for _, feature := range c.features {
1763 flags = feature.flags(ctx, flags)
1764 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001765 if ctx.Failed() {
1766 return
1767 }
1768
Colin Cross4af21ed2019-11-04 09:37:55 -08001769 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1770 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1771 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001772
Colin Cross4af21ed2019-11-04 09:37:55 -08001773 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001774
1775 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001776 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001777 }
1778 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001779 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001780 }
1781
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001782 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001783 // We need access to all the flags seen by a source file.
1784 if c.sabi != nil {
1785 flags = c.sabi.flags(ctx, flags)
1786 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001787
Colin Cross4af21ed2019-11-04 09:37:55 -08001788 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001789
Colin Crossca860ac2016-01-04 14:34:37 -08001790 // Optimization to reduce size of build.ninja
1791 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001792 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1793 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1794 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1795 flags.Local.CFlags = []string{"$cflags"}
1796 flags.Local.CppFlags = []string{"$cppflags"}
1797 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001798
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001799 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001800 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001801 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001802 if ctx.Failed() {
1803 return
1804 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001805 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001806 }
1807
Colin Crossca860ac2016-01-04 14:34:37 -08001808 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001809 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001810 if ctx.Failed() {
1811 return
1812 }
Colin Cross635c3b02016-05-18 15:37:25 -07001813 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001814
Chris Parsons94a0bba2021-06-04 15:03:47 -04001815 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001816
Jose Galmes6f843bc2020-12-11 13:36:29 -08001817 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
1818 // RECOVERY_SNAPSHOT_VERSION is current.
1819 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001820 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001821 i.collectHeadersForSnapshot(ctx)
1822 }
1823 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001824 }
Colin Cross5049f022015-03-18 13:28:46 -07001825
Chris Parsons94a0bba2021-06-04 15:03:47 -04001826 c.maybeInstall(ctx, apexInfo)
1827}
1828
1829func (c *Module) maybeUnhideFromMake() {
1830 // If a lib is directly included in any of the APEXes or is not available to the
1831 // platform (which is often the case when the stub is provided as a prebuilt),
1832 // unhide the stubs variant having the latest version gets visible to make. In
1833 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1834 // force anything in the make world to link against the stubs library. (unless it
1835 // is explicitly referenced via .bootstrap suffix or the module is marked with
1836 // 'bootstrap: true').
1837 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
1838 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
1839 c.IsStubs() && !c.InVendorRamdisk() {
1840 c.Properties.HideFromMake = false // unhide
1841 // Note: this is still non-installable
1842 }
1843}
1844
1845func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001846 if !proptools.BoolDefault(c.Properties.Installable, true) {
1847 // If the module has been specifically configure to not be installed then
1848 // hide from make as otherwise it will break when running inside make
1849 // as the output path to install will not be specified. Not all uninstallable
1850 // modules can be hidden from make as some are needed for resolving make side
1851 // dependencies.
1852 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001853 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001854 c.SkipInstall()
1855 }
1856
1857 // Still call c.installer.install though, the installs will be stored as PackageSpecs
1858 // to allow using the outputs in a genrule.
1859 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001860 c.installer.install(ctx, c.outputFile.Path())
1861 if ctx.Failed() {
1862 return
Colin Crossca860ac2016-01-04 14:34:37 -08001863 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001864 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001865}
1866
Colin Cross0ea8ba82019-06-06 14:33:29 -07001867func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001868 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05001869 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08001870 }
Colin Crossca860ac2016-01-04 14:34:37 -08001871 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001872}
1873
Colin Crossca860ac2016-01-04 14:34:37 -08001874func (c *Module) begin(ctx BaseModuleContext) {
1875 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001876 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001877 }
Colin Crossca860ac2016-01-04 14:34:37 -08001878 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001879 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001880 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001881 if c.stl != nil {
1882 c.stl.begin(ctx)
1883 }
Colin Cross16b23492016-01-06 14:41:07 -08001884 if c.sanitize != nil {
1885 c.sanitize.begin(ctx)
1886 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001887 if c.coverage != nil {
1888 c.coverage.begin(ctx)
1889 }
Stephen Craneba090d12017-05-09 15:44:35 -07001890 if c.lto != nil {
1891 c.lto.begin(ctx)
1892 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001893 if c.pgo != nil {
1894 c.pgo.begin(ctx)
1895 }
Dan Albert92fe7402020-07-15 13:33:30 -07001896 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001897 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001898 if err != nil {
1899 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001900 c.Properties.Sdk_version = nil
1901 } else {
1902 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001903 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001904 }
Colin Crossca860ac2016-01-04 14:34:37 -08001905}
1906
Colin Cross37047f12016-12-13 17:06:13 -08001907func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001908 deps := Deps{}
1909
1910 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001911 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001912 }
1913 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001914 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001915 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001916 if c.stl != nil {
1917 deps = c.stl.deps(ctx, deps)
1918 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001919 if c.coverage != nil {
1920 deps = c.coverage.deps(ctx, deps)
1921 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001922
Colin Crossb6715442017-10-24 11:13:31 -07001923 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1924 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1925 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1926 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1927 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1928 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001929 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001930
Liz Kammer356f7d42021-01-26 09:18:53 -05001931 // In Bazel conversion mode, we dependency and build validations will occur in Bazel, so there is
1932 // no need to do so in Soong.
1933 if ctx.BazelConversionMode() {
1934 return deps
1935 }
1936
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001937 for _, lib := range deps.ReexportSharedLibHeaders {
1938 if !inList(lib, deps.SharedLibs) {
1939 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1940 }
1941 }
1942
1943 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00001944 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
1945 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 -07001946 }
1947 }
1948
Colin Cross5950f382016-12-13 12:50:57 -08001949 for _, lib := range deps.ReexportHeaderLibHeaders {
1950 if !inList(lib, deps.HeaderLibs) {
1951 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1952 }
1953 }
1954
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001955 for _, gen := range deps.ReexportGeneratedHeaders {
1956 if !inList(gen, deps.GeneratedHeaders) {
1957 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1958 }
1959 }
1960
Colin Crossc99deeb2016-04-11 15:06:20 -07001961 return deps
1962}
1963
Dan Albert7e9d2952016-08-04 13:02:36 -07001964func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001965 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001966 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001967 moduleContextImpl: moduleContextImpl{
1968 mod: c,
1969 },
1970 }
1971 ctx.ctx = ctx
1972
Colin Crossca860ac2016-01-04 14:34:37 -08001973 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001974}
1975
Jiyong Park7ed9de32018-10-15 22:25:07 +09001976// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001977func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001978 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1979 version := name[sharp+1:]
1980 libname := name[:sharp]
1981 return libname, version
1982 }
1983 return name, ""
1984}
1985
Dan Albert92fe7402020-07-15 13:33:30 -07001986func GetCrtVariations(ctx android.BottomUpMutatorContext,
1987 m LinkableInterface) []blueprint.Variation {
1988 if ctx.Os() != android.Android {
1989 return nil
1990 }
1991 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001992 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
1993 minSdkVersion := m.MinSdkVersion()
1994 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
1995 minSdkVersion = m.SdkVersion()
1996 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09001997 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
1998 if err != nil {
1999 ctx.PropertyErrorf("min_sdk_version", err.Error())
2000 }
Dan Albert92fe7402020-07-15 13:33:30 -07002001 return []blueprint.Variation{
2002 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002003 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002004 }
2005 }
2006 return []blueprint.Variation{
2007 {Mutator: "sdk", Variation: ""},
2008 }
2009}
2010
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002011func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2012 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002013
2014 variations = append([]blueprint.Variation(nil), variations...)
2015
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002016 if version != "" && CanBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002017 // Version is explicitly specified. i.e. libFoo#30
2018 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002019 if tag, ok := depTag.(libraryDependencyTag); ok {
2020 tag.explicitlyVersioned = true
2021 } else {
2022 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2023 }
Colin Crosse7257d22020-09-24 09:56:18 -07002024 }
Colin Crosse7257d22020-09-24 09:56:18 -07002025
Colin Cross0de8a1e2020-09-18 14:15:30 -07002026 if far {
2027 ctx.AddFarVariationDependencies(variations, depTag, name)
2028 } else {
2029 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002030 }
2031}
2032
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002033func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002034 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002035 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002036 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002037 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2038 // between the modules in the snapshot and the snapshot itself.
2039 var snapshotModule []blueprint.Module
2040 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2041 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2042 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2043 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2044 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002045 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002046 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2047 *snapshotInfo = &snapshot
2048 // republish the snapshot for use in later mutators on this module
2049 actx.SetProvider(SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002050 }
2051 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002052 if *snapshotInfo == nil {
2053 *snapshotInfo = &SnapshotInfo{}
2054 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002055 return **snapshotInfo
2056}
2057
2058func RewriteSnapshotLib(lib string, snapshotMap map[string]string) string {
2059 if snapshot, ok := snapshotMap[lib]; ok {
2060 return snapshot
2061 }
2062
2063 return lib
2064}
2065
2066// RewriteLibs takes a list of names of shared libraries and scans it for three types
2067// of names:
2068//
2069// 1. Name of an NDK library that refers to a prebuilt module.
2070// For each of these, it adds the name of the prebuilt module (which will be in
2071// prebuilts/ndk) to the list of nonvariant libs.
2072// 2. Name of an NDK library that refers to an ndk_library module.
2073// For each of these, it adds the name of the ndk_library module to the list of
2074// variant libs.
2075// 3. Anything else (so anything that isn't an NDK library).
2076// It adds these to the nonvariantLibs list.
2077//
2078// The caller can then know to add the variantLibs dependencies differently from the
2079// nonvariantLibs
2080func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2081 variantLibs = []string{}
2082
2083 nonvariantLibs = []string{}
2084 for _, entry := range list {
2085 // strip #version suffix out
2086 name, _ := StubsLibNameAndVersion(entry)
2087 if c.InRecovery() {
2088 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2089 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2090 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2091 } else if c.UseVndk() {
2092 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2093 } else {
2094 // put name#version back
2095 nonvariantLibs = append(nonvariantLibs, entry)
2096 }
2097 }
2098 return nonvariantLibs, variantLibs
2099}
2100
Colin Cross1e676be2016-10-12 14:38:15 -07002101func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002102 if !c.Enabled() {
2103 return
2104 }
2105
Colin Cross37047f12016-12-13 17:06:13 -08002106 ctx := &depsContext{
2107 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002108 moduleContextImpl: moduleContextImpl{
2109 mod: c,
2110 },
2111 }
2112 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002113
Colin Crossc99deeb2016-04-11 15:06:20 -07002114 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002115
Yo Chiang219968c2020-09-22 18:45:04 +08002116 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2117
Colin Crosse0edaf92021-01-11 17:31:17 -08002118 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002119
Dan Albert914449f2016-06-17 16:45:24 -07002120 variantNdkLibs := []string{}
2121 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002122 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002123 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2124 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2125 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002126
2127 for idx, lib := range deps.RuntimeLibs {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002128 deps.RuntimeLibs[idx] = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002129 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002130 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002131
Colin Cross32ec36c2016-12-15 07:39:51 -08002132 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002133 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002134 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002135 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002136 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002137
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002138 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002139
Jiyong Park1ad8e162020-12-01 23:40:09 +09002140 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002141 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002142 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002143 } else {
2144 actx.AddVariationDependencies(nil, depTag, lib)
2145 }
2146 }
2147
Dan Albertf1d14c72020-07-30 14:32:55 -07002148 if c.isNDKStubLibrary() {
2149 // NDK stubs depend on their implementation because the ABI dumps are
2150 // generated from the implementation library.
2151 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2152 c.ImageVariation(),
2153 blueprint.Variation{Mutator: "link", Variation: "shared"},
2154 ), stubImplementation, c.BaseModuleName())
2155 }
2156
Inseob Kim07def122020-11-23 14:43:02 +09002157 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
2158 // C++ implementation library and one Java implementation library. When a module links against
2159 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
2160 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
2161 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09002162 syspropImplLibraries := syspropImplLibraries(actx.Config())
2163
Jiyong Park5d1598f2019-02-25 22:14:17 +09002164 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002165 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09002166 if impl, ok := syspropImplLibraries[lib]; ok {
2167 lib = impl
2168 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002169
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002170 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002171
Jiyong Park5d1598f2019-02-25 22:14:17 +09002172 actx.AddVariationDependencies([]blueprint.Variation{
2173 {Mutator: "link", Variation: "static"},
2174 }, depTag, lib)
2175 }
2176
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002177 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002178 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002179 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002180 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002181 }
Jiyong Parke3867542020-12-03 17:28:25 +09002182 if inList(lib, deps.ExcludeLibsForApex) {
2183 depTag.excludeInApex = true
2184 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002185
2186 if impl, ok := syspropImplLibraries[lib]; ok {
2187 lib = impl
2188 }
2189
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002190 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002191
Dan Willemsen59339a22018-07-22 21:18:45 -07002192 actx.AddVariationDependencies([]blueprint.Variation{
2193 {Mutator: "link", Variation: "static"},
2194 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002195 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002196
Jooyung Han75568392020-03-20 04:29:24 +09002197 // staticUnwinderDep is treated as staticDep for Q apexes
2198 // so that native libraries/binaries are linked with static unwinder
2199 // because Q libc doesn't have unwinder APIs
2200 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002201 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002202 actx.AddVariationDependencies([]blueprint.Variation{
2203 {Mutator: "link", Variation: "static"},
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002204 }, depTag, RewriteSnapshotLib(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002205 }
2206
Jiyong Park7ed9de32018-10-15 22:25:07 +09002207 // shared lib names without the #version suffix
2208 var sharedLibNames []string
2209
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002210 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002211 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002212 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002213 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002214 }
Jiyong Parke3867542020-12-03 17:28:25 +09002215 if inList(lib, deps.ExcludeLibsForApex) {
2216 depTag.excludeInApex = true
2217 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002218
2219 if impl, ok := syspropImplLibraries[lib]; ok {
2220 lib = impl
2221 }
2222
Jiyong Park73c54ee2019-10-22 20:31:18 +09002223 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002224 sharedLibNames = append(sharedLibNames, name)
2225
Colin Crosse7257d22020-09-24 09:56:18 -07002226 variations := []blueprint.Variation{
2227 {Mutator: "link", Variation: "shared"},
2228 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002229 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002230 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002231
Colin Crossfe9acfe2021-06-14 16:13:03 -07002232 for _, lib := range deps.LateStaticLibs {
2233 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2234 actx.AddVariationDependencies([]blueprint.Variation{
2235 {Mutator: "link", Variation: "static"},
2236 }, depTag, RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
2237 }
2238
Jiyong Park7ed9de32018-10-15 22:25:07 +09002239 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002240 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002241 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2242 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2243 // linking against both the stubs lib and the non-stubs lib at the same time.
2244 continue
2245 }
Colin Cross6e511a92020-07-27 21:26:48 -07002246 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002247 variations := []blueprint.Variation{
2248 {Mutator: "link", Variation: "shared"},
2249 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002250 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002251 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002252
Dan Willemsen59339a22018-07-22 21:18:45 -07002253 actx.AddVariationDependencies([]blueprint.Variation{
2254 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002255 }, dataLibDepTag, deps.DataLibs...)
2256
2257 actx.AddVariationDependencies([]blueprint.Variation{
2258 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002259 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002260
Colin Cross68861832016-07-08 10:41:41 -07002261 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002262
2263 for _, gen := range deps.GeneratedHeaders {
2264 depTag := genHeaderDepTag
2265 if inList(gen, deps.ReexportGeneratedHeaders) {
2266 depTag = genHeaderExportDepTag
2267 }
2268 actx.AddDependency(c, depTag, gen)
2269 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002270
Dan Albert92fe7402020-07-15 13:33:30 -07002271 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002272 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002273 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002274 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002275 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002276 }
Colin Crossc465efd2021-06-11 18:00:04 -07002277 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002278 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002279 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002280 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002281 if deps.DynamicLinker != "" {
2282 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002283 }
Dan Albert914449f2016-06-17 16:45:24 -07002284
2285 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002286
2287 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002288 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002289 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002290 {Mutator: "link", Variation: "shared"},
2291 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002292
2293 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002294 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002295 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002296 {Mutator: "link", Variation: "shared"},
2297 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002298
2299 if vndkdep := c.vndkdep; vndkdep != nil {
2300 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002301 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002302 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002303 {Mutator: "link", Variation: "shared"},
Justin Yun27b95722021-07-28 17:04:44 +09002304 }, vndkExtDepTag, RewriteSnapshotLib(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002305 }
2306 }
Colin Cross6362e272015-10-29 15:25:03 -07002307}
Colin Cross21b9a242015-03-24 14:15:58 -07002308
Colin Crosse40b4ea2018-10-02 22:25:58 -07002309func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002310 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2311 c.beginMutator(ctx)
2312 }
2313}
2314
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002315// Whether a module can link to another module, taking into
2316// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002317func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002318 tag blueprint.DependencyTag) {
2319
2320 switch t := tag.(type) {
2321 case dependencyTag:
2322 if t != vndkExtDepTag {
2323 return
2324 }
2325 case libraryDependencyTag:
2326 default:
2327 return
2328 }
2329
Ivan Lozanof9e21722020-12-02 09:00:51 -05002330 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002331 // Host code is not restricted
2332 return
2333 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002334
2335 // VNDK is cc.Module supported only for now.
2336 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002337 // Though allowed dependency is limited by the image mutator,
2338 // each vendor and product module needs to check link-type
2339 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002340 if ccTo, ok := to.(*Module); ok {
2341 if ccFrom.vndkdep != nil {
2342 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2343 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002344 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002345 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002346 }
2347 return
2348 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002349 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002350 // Platform code can link to anything
2351 return
2352 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002353 if from.InRamdisk() {
2354 // Ramdisk code is not NDK
2355 return
2356 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002357 if from.InVendorRamdisk() {
2358 // Vendor ramdisk code is not NDK
2359 return
2360 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002361 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002362 // Recovery code is not NDK
2363 return
2364 }
Colin Cross31076b32020-10-23 17:22:06 -07002365 if c, ok := to.(*Module); ok {
2366 if c.ToolchainLibrary() {
2367 // These are always allowed
2368 return
2369 }
2370 if c.NdkPrebuiltStl() {
2371 // These are allowed, but they don't set sdk_version
2372 return
2373 }
2374 if c.StubDecorator() {
2375 // These aren't real libraries, but are the stub shared libraries that are included in
2376 // the NDK.
2377 return
2378 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002379 }
Logan Chien834b9a62019-01-14 15:39:03 +08002380
Ivan Lozano52767be2019-10-18 14:49:46 -07002381 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002382 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2383 // to link to libc++ (non-NDK and without sdk_version).
2384 return
2385 }
2386
Ivan Lozano52767be2019-10-18 14:49:46 -07002387 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002388 // NDK code linking to platform code is never okay.
2389 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002390 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002391 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002392 }
2393
2394 // At this point we know we have two NDK libraries, but we need to
2395 // check that we're not linking against anything built against a higher
2396 // API level, as it is only valid to link against older or equivalent
2397 // APIs.
2398
Inseob Kim01a28722018-04-11 09:48:45 +09002399 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002400 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002401 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002402 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002403 // Current can't be linked against by anything else.
2404 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002405 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002406 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002407 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002408 if err != nil {
2409 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002410 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002411 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002412 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002413 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002414 if err != nil {
2415 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002416 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002417 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002418 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002419
Inseob Kim01a28722018-04-11 09:48:45 +09002420 if toApi > fromApi {
2421 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002422 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002423 }
2424 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002425 }
Dan Albert202fe492017-12-15 13:56:59 -08002426
2427 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002428 fromStl := from.SelectedStl()
2429 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002430 if fromStl == "" || toStl == "" {
2431 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002432 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002433 // We can be permissive with the system "STL" since it is only the C++
2434 // ABI layer, but in the future we should make sure that everyone is
2435 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002436 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002437 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002438 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2439 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002440 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002441}
2442
Jooyung Han479ca172020-10-19 18:51:07 +09002443func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2444 if c, ok := ctx.Module().(*Module); ok {
2445 ctx.VisitDirectDeps(func(dep android.Module) {
2446 depTag := ctx.OtherModuleDependencyTag(dep)
2447 ccDep, ok := dep.(LinkableInterface)
2448 if ok {
2449 checkLinkType(ctx, c, ccDep, depTag)
2450 }
2451 })
2452 }
2453}
2454
Jiyong Park5fb8c102018-04-09 12:03:06 +09002455// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002456// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2457// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002458// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002459func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2460 check := func(child, parent android.Module) bool {
2461 to, ok := child.(*Module)
2462 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002463 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002464 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002465
Jooyung Hana70f0672019-01-18 15:20:43 +09002466 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2467 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002468 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002469
Jiyong Park0474e1f2021-01-14 14:26:06 +09002470 // These dependencies are not excercised at runtime. Tracking these will give us
2471 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002472 depTag := ctx.OtherModuleDependencyTag(child)
2473 if IsHeaderDepTag(depTag) {
2474 return false
2475 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002476 if depTag == staticVariantTag {
2477 return false
2478 }
2479 if depTag == stubImplDepTag {
2480 return false
2481 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002482
Justin Yun63e9ec72020-10-29 16:49:43 +09002483 // Even if target lib has no vendor variant, keep checking dependency
2484 // graph in case it depends on vendor_available or product_available
2485 // but not double_loadable transtively.
2486 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002487 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002488 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002489
Jiyong Park0474e1f2021-01-14 14:26:06 +09002490 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2491 // one.
2492 if Bool(to.VendorProperties.Double_loadable) {
2493 return true
2494 }
2495
Ivan Lozanod7586b62021-04-01 09:49:36 -04002496 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002497 return false
2498 }
2499
Jooyung Hana70f0672019-01-18 15:20:43 +09002500 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2501 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002502 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002503 return false
2504 }
2505 if module, ok := ctx.Module().(*Module); ok {
2506 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002507 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002508 ctx.WalkDeps(check)
2509 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002510 }
2511 }
2512}
2513
Colin Crossc99deeb2016-04-11 15:06:20 -07002514// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002515func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002516 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002517
Colin Cross0de8a1e2020-09-18 14:15:30 -07002518 var directStaticDeps []StaticLibraryInfo
2519 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002520
Colin Cross0de8a1e2020-09-18 14:15:30 -07002521 reexportExporter := func(exporter FlagExporterInfo) {
2522 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2523 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2524 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2525 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2526 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002527 }
2528
Jooyung Hande34d232020-07-23 13:04:15 +09002529 // For the dependency from platform to apex, use the latest stubs
2530 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002531 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2532 if !apexInfo.IsForPlatform() {
Jiyong Park4eab21d2021-04-15 15:17:54 +09002533 c.apexSdkVersion = apexInfo.MinSdkVersion
Jooyung Hande34d232020-07-23 13:04:15 +09002534 }
2535
2536 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2537 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2538 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2539 // (b/144430859)
2540 c.apexSdkVersion = android.FutureApiLevel
2541 }
2542
Colin Crossd11fcda2017-10-23 17:59:01 -07002543 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002544 depName := ctx.OtherModuleName(dep)
2545 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002546
Ivan Lozano52767be2019-10-18 14:49:46 -07002547 ccDep, ok := dep.(LinkableInterface)
2548 if !ok {
2549
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002550 // handling for a few module types that aren't cc Module but that are also supported
2551 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002552 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002553 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002554 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2555 genRule.GeneratedSourceFiles()...)
2556 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002557 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002558 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002559 // Support exported headers from a generated_sources dependency
2560 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002561 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002562 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002563 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002564 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002565 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002566 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002567 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002568 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002569 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2570 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002571 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002572 // 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 +09002573 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002574
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002575 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002576 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002577 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002578 }
Colin Crosscef792e2021-06-11 18:01:26 -07002579 case CrtBeginDepTag:
2580 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2581 case CrtEndDepTag:
2582 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002583 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002584 return
2585 }
2586
Colin Crossfe17f6f2019-03-28 19:30:56 -07002587 if depTag == android.ProtoPluginDepTag {
2588 return
2589 }
2590
Colin Crossd11fcda2017-10-23 17:59:01 -07002591 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002592 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2593 return
2594 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002595 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002596 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2597 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002598 return
2599 }
2600
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002601 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002602 // Skip reused objects for stub libraries, they use their own stub object file instead.
2603 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2604 // version mutator, so the stubs variant is created from the shared variant that
2605 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002606 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002607 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2608 objs := staticAnalogue.ReuseObjects
2609 depPaths.Objs = depPaths.Objs.Append(objs)
2610 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2611 reexportExporter(depExporterInfo)
2612 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002613 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002614 }
2615
Colin Cross6e511a92020-07-27 21:26:48 -07002616 linkFile := ccDep.OutputFile()
2617
2618 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2619 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002620 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002621 return
2622 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002623
Jiyong Parke3867542020-12-03 17:28:25 +09002624 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2625 return
2626 }
2627
Colin Cross0de8a1e2020-09-18 14:15:30 -07002628 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002629
Colin Cross6e511a92020-07-27 21:26:48 -07002630 var ptr *android.Paths
2631 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002632
Colin Cross6e511a92020-07-27 21:26:48 -07002633 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002634
Colin Cross6e511a92020-07-27 21:26:48 -07002635 switch {
2636 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002637 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2638 if !ctx.Config().AllowMissingDependencies() {
2639 ctx.ModuleErrorf("module %q is not a header library", depName)
2640 } else {
2641 ctx.AddMissingDependencies([]string{depName})
2642 }
2643 return
2644 }
Colin Cross6e511a92020-07-27 21:26:48 -07002645 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002646 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2647 if !ctx.Config().AllowMissingDependencies() {
2648 ctx.ModuleErrorf("module %q is not a shared library", depName)
2649 } else {
2650 ctx.AddMissingDependencies([]string{depName})
2651 }
2652 return
2653 }
Jiyong Parke3867542020-12-03 17:28:25 +09002654
Jiyong Park7d55b612021-06-11 17:22:09 +09002655 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
2656 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07002657
Jiyong Park1ad8e162020-12-01 23:40:09 +09002658 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2659 // linkFile, depFile, and ptr.
2660 if c.IsStubs() {
2661 break
2662 }
2663
Colin Cross0de8a1e2020-09-18 14:15:30 -07002664 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2665 depFile = sharedLibraryInfo.TableOfContents
2666
Colin Cross6e511a92020-07-27 21:26:48 -07002667 ptr = &depPaths.SharedLibs
2668 switch libDepTag.Order {
2669 case earlyLibraryDependency:
2670 ptr = &depPaths.EarlySharedLibs
2671 depPtr = &depPaths.EarlySharedLibsDeps
2672 case normalLibraryDependency:
2673 ptr = &depPaths.SharedLibs
2674 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002675 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002676 case lateLibraryDependency:
2677 ptr = &depPaths.LateSharedLibs
2678 depPtr = &depPaths.LateSharedLibsDeps
2679 default:
2680 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002681 }
Colin Cross6e511a92020-07-27 21:26:48 -07002682 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002683 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2684 if !ctx.Config().AllowMissingDependencies() {
2685 ctx.ModuleErrorf("module %q is not a static library", depName)
2686 } else {
2687 ctx.AddMissingDependencies([]string{depName})
2688 }
2689 return
2690 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002691
2692 // Stubs lib doesn't link to the static lib dependencies. Don't set
2693 // linkFile, depFile, and ptr.
2694 if c.IsStubs() {
2695 break
2696 }
2697
Colin Cross0de8a1e2020-09-18 14:15:30 -07002698 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2699 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002700 if libDepTag.wholeStatic {
2701 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002702 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2703 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002704 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002705 // This case normally catches prebuilt static
2706 // libraries, but it can also occur when
2707 // AllowMissingDependencies is on and the
2708 // dependencies has no sources of its own
2709 // but has a whole_static_libs dependency
2710 // on a missing library. We want to depend
2711 // on the .a file so that there is something
2712 // in the dependency tree that contains the
2713 // error rule for the missing transitive
2714 // dependency.
2715 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002716 }
Colin Cross6e511a92020-07-27 21:26:48 -07002717 } else {
2718 switch libDepTag.Order {
2719 case earlyLibraryDependency:
2720 panic(fmt.Errorf("early static libs not suppported"))
2721 case normalLibraryDependency:
2722 // static dependencies will be handled separately so they can be ordered
2723 // using transitive dependencies.
2724 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002725 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002726 case lateLibraryDependency:
2727 ptr = &depPaths.LateStaticLibs
2728 default:
2729 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002730 }
2731 }
2732 }
2733
Colin Cross6e511a92020-07-27 21:26:48 -07002734 if libDepTag.static() && !libDepTag.wholeStatic {
2735 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2736 ctx.ModuleErrorf("module %q not a static library", depName)
2737 return
2738 }
Logan Chien43d34c32017-12-20 01:17:32 +08002739
Colin Cross6e511a92020-07-27 21:26:48 -07002740 // When combining coverage files for shared libraries and executables, coverage files
2741 // in static libraries act as if they were whole static libraries. The same goes for
2742 // source based Abi dump files.
2743 if c, ok := ccDep.(*Module); ok {
2744 staticLib := c.linker.(libraryInterface)
2745 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2746 staticLib.objs().coverageFiles...)
2747 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2748 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002749 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002750 // Handle non-CC modules here
2751 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002752 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002753 }
2754 }
2755
Colin Cross6e511a92020-07-27 21:26:48 -07002756 if ptr != nil {
2757 if !linkFile.Valid() {
2758 if !ctx.Config().AllowMissingDependencies() {
2759 ctx.ModuleErrorf("module %q missing output file", depName)
2760 } else {
2761 ctx.AddMissingDependencies([]string{depName})
2762 }
2763 return
2764 }
2765 *ptr = append(*ptr, linkFile.Path())
2766 }
2767
2768 if depPtr != nil {
2769 dep := depFile
2770 if !dep.Valid() {
2771 dep = linkFile
2772 }
2773 *depPtr = append(*depPtr, dep.Path())
2774 }
2775
Colin Cross0de8a1e2020-09-18 14:15:30 -07002776 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2777 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2778 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2779 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2780
2781 if libDepTag.reexportFlags {
2782 reexportExporter(depExporterInfo)
2783 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2784 // Re-exported shared library headers must be included as well since they can help us with type information
2785 // about template instantiations (instantiated from their headers).
2786 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2787 // scripts.
2788 c.sabi.Properties.ReexportedIncludes = append(
2789 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2790 }
2791
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002792 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002793 switch {
2794 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002795 c.Properties.AndroidMkHeaderLibs = append(
2796 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002797 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002798 if lib := moduleLibraryInterface(dep); lib != nil {
2799 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002800 // Add the dependency to the APEX(es) providing the library so that
2801 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002802 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09002803 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07002804 c.Properties.ApexesProvidingSharedLibs = append(
2805 c.Properties.ApexesProvidingSharedLibs, an)
2806 }
2807 }
2808 }
2809
2810 // Note: the order of libs in this list is not important because
2811 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002812 c.Properties.AndroidMkSharedLibs = append(
2813 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002814 // Record BaseLibName for snapshots.
2815 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002816 case libDepTag.static():
2817 if libDepTag.wholeStatic {
2818 c.Properties.AndroidMkWholeStaticLibs = append(
2819 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2820 } else {
2821 c.Properties.AndroidMkStaticLibs = append(
2822 c.Properties.AndroidMkStaticLibs, makeLibName)
2823 }
Justin Yun5e035862021-06-29 20:50:37 +09002824 // Record BaseLibName for snapshots.
2825 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002826 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002827 } else if !c.IsStubs() {
2828 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2829
Colin Cross6e511a92020-07-27 21:26:48 -07002830 switch depTag {
2831 case runtimeDepTag:
2832 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002833 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002834 // Record BaseLibName for snapshots.
2835 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002836 case objDepTag:
2837 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2838 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002839 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002840 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002841 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002842 case dynamicLinkerDepTag:
2843 depPaths.DynamicLinker = linkFile
2844 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002845 }
Colin Crossca860ac2016-01-04 14:34:37 -08002846 })
2847
Jeff Gaston294356f2017-09-27 17:05:30 -07002848 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002849 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2850 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2851 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002852
Colin Crossdd84e052017-05-17 13:44:16 -07002853 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002854 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002855 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2856 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002857 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002858 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2859 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002860 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002861 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002862 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002863
2864 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002865 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002866 }
Colin Crossdd84e052017-05-17 13:44:16 -07002867
Colin Crossca860ac2016-01-04 14:34:37 -08002868 return depPaths
2869}
2870
Jiyong Park7d55b612021-06-11 17:22:09 +09002871// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
2872// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
2873// dependency. The stub variant is selected when the dependency crosses a boundary where each side
2874// has different level of updatability. For example, if a library foo in an APEX depends on a
2875// library bar which provides stable interface and exists in the platform, foo uses the stub variant
2876// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
2877// same APEX as foo, the non-stub variant of bar is used.
2878func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
2879 depName := ctx.OtherModuleName(dep)
2880 depTag := ctx.OtherModuleDependencyTag(dep)
2881 libDepTag, ok := depTag.(libraryDependencyTag)
2882 if !ok || !libDepTag.shared() {
2883 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2884 }
2885
2886 thisModule, ok := ctx.Module().(android.ApexModule)
2887 if !ok {
2888 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
2889 }
2890
2891 useVndk := false
2892 bootstrap := false
2893 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
2894 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
2895 } else {
2896 useVndk = linkable.UseVndk()
2897 bootstrap = linkable.Bootstrap()
2898 }
2899
2900 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2901 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2902 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
2903 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2904
2905 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
2906 useStubs := false
2907
2908 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
2909 if !apexInfo.IsForPlatform() {
2910 // For platform libraries, use current version of LLNDK
2911 // If this is for use_vendor apex we will apply the same rules
2912 // of apex sdk enforcement below to choose right version.
2913 useStubs = true
2914 }
Jiyong Park9477c262021-06-22 20:23:05 +09002915 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
2916 // If not building for APEX or the containing APEX allows the use of
2917 // platform APIs, use stubs only when it is from an APEX (and not from
2918 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
2919 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09002920 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
2921 if useStubs {
2922 // Another exception: if this module is a test for an APEX, then
2923 // it is linked with the non-stub variant of a module in the APEX
2924 // as if this is part of the APEX.
2925 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2926 for _, apexContents := range testFor.ApexContents {
2927 if apexContents.DirectlyInApex(depName) {
2928 useStubs = false
2929 break
2930 }
2931 }
2932 }
2933 if useStubs {
2934 // Yet another exception: If this module and the dependency are
2935 // available to the same APEXes then skip stubs between their
2936 // platform variants. This complements the test_for case above,
2937 // which avoids the stubs on a direct APEX library dependency, by
2938 // avoiding stubs for indirect test dependencies as well.
2939 //
2940 // TODO(b/183882457): This doesn't work if the two libraries have
2941 // only partially overlapping apex_available. For that test_for
2942 // modules would need to be split into APEX variants and resolved
2943 // separately for each APEX they have access to.
2944 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
2945 useStubs = false
2946 }
2947 }
2948 } else {
2949 // If building for APEX, use stubs when the parent is in any APEX that
2950 // the child is not in.
2951 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2952 }
2953
2954 // when to use (unspecified) stubs, use the latest one.
2955 if useStubs {
2956 stubs := sharedLibraryStubsInfo.SharedStubLibraries
2957 toUse := stubs[len(stubs)-1]
2958 sharedLibraryInfo = toUse.SharedLibraryInfo
2959 depExporterInfo = toUse.FlagExporterInfo
2960 }
2961 }
2962 return sharedLibraryInfo, depExporterInfo
2963}
2964
Colin Cross0de8a1e2020-09-18 14:15:30 -07002965// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2966// to match the topological order of the dependency tree, including any static analogues of
2967// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2968// of the transitive dependencies.
2969func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2970 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2971 var staticPaths android.Paths
2972 for _, staticDep := range staticDeps {
2973 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2974 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2975 }
2976 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04002977 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
2978 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002979 }
2980 }
2981 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2982
2983 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2984
2985 // reorder the dependencies based on transitive dependencies
2986 staticPaths = android.FirstUniquePaths(staticPaths)
2987 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2988
2989 if len(orderedStaticPaths) != len(staticPaths) {
2990 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2991 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2992 }
2993
2994 return orderedStaticPaths, transitiveStaticLibs
2995}
2996
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002997// BaseLibName trims known prefixes and suffixes
2998func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07002999 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3000 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003001 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003002 return libName
3003}
3004
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003005func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003006 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003007 ccDepModule, _ := ccDep.(*Module)
3008 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003009 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003010
Justin Yuncbca3732021-02-03 19:24:13 +09003011 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003012 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07003013 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003014 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003015 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003016
Ivan Lozanod1dec542021-05-26 15:33:11 -04003017 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003018 }
3019 }
3020
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003021 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3022 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003023 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3024 // core module instead.
3025 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003026 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003027 // The vendor and product modules in Make will have been renamed to not conflict with the
3028 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003029 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003030 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
3031 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003032 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003033 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003034 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
3035 return libName + recoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003036 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Colin Cross6e511a92020-07-27 21:26:48 -07003037 return libName + nativeBridgeSuffix
3038 } else {
3039 return libName
3040 }
3041}
3042
Colin Crossca860ac2016-01-04 14:34:37 -08003043func (c *Module) InstallInData() bool {
3044 if c.installer == nil {
3045 return false
3046 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003047 return c.installer.inData()
3048}
3049
3050func (c *Module) InstallInSanitizerDir() bool {
3051 if c.installer == nil {
3052 return false
3053 }
3054 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003055 return true
3056 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003057 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003058}
3059
Yifan Hong1b3348d2020-01-21 15:53:22 -08003060func (c *Module) InstallInRamdisk() bool {
3061 return c.InRamdisk()
3062}
3063
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003064func (c *Module) InstallInVendorRamdisk() bool {
3065 return c.InVendorRamdisk()
3066}
3067
Jiyong Parkf9332f12018-02-01 00:54:12 +09003068func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003069 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003070}
3071
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003072func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003073 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003074 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003075 return
3076 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003077 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003078}
3079
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003080func (c *Module) HostToolPath() android.OptionalPath {
3081 if c.installer == nil {
3082 return android.OptionalPath{}
3083 }
3084 return c.installer.hostToolPath()
3085}
3086
Nan Zhangd4e641b2017-07-12 12:55:28 -07003087func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3088 return c.outputFile
3089}
3090
Colin Cross41955e82019-05-29 14:40:35 -07003091func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3092 switch tag {
3093 case "":
3094 if c.outputFile.Valid() {
3095 return android.Paths{c.outputFile.Path()}, nil
3096 }
3097 return android.Paths{}, nil
3098 default:
3099 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003100 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003101}
3102
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003103func (c *Module) static() bool {
3104 if static, ok := c.linker.(interface {
3105 static() bool
3106 }); ok {
3107 return static.static()
3108 }
3109 return false
3110}
3111
Jiyong Park379de2f2018-12-19 02:47:14 +09003112func (c *Module) staticBinary() bool {
3113 if static, ok := c.linker.(interface {
3114 staticBinary() bool
3115 }); ok {
3116 return static.staticBinary()
3117 }
3118 return false
3119}
3120
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003121func (c *Module) testBinary() bool {
3122 if test, ok := c.linker.(interface {
3123 testBinary() bool
3124 }); ok {
3125 return test.testBinary()
3126 }
3127 return false
3128}
3129
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003130// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3131func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003132 if h, ok := c.linker.(interface {
3133 header() bool
3134 }); ok {
3135 return h.header()
3136 }
3137 return false
3138}
3139
Ivan Lozanod7586b62021-04-01 09:49:36 -04003140func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003141 if b, ok := c.linker.(interface {
3142 binary() bool
3143 }); ok {
3144 return b.binary()
3145 }
3146 return false
3147}
3148
Justin Yun5e035862021-06-29 20:50:37 +09003149func (c *Module) StaticExecutable() bool {
3150 if b, ok := c.linker.(*binaryDecorator); ok {
3151 return b.static()
3152 }
3153 return false
3154}
3155
Ivan Lozanod7586b62021-04-01 09:49:36 -04003156func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003157 if o, ok := c.linker.(interface {
3158 object() bool
3159 }); ok {
3160 return o.object()
3161 }
3162 return false
3163}
3164
Ivan Lozanof9e21722020-12-02 09:00:51 -05003165func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003166 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003167 if c.IsLlndk() {
3168 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003169 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003170 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003171 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003172 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003173 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003174 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003175 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003176 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003177 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003178 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003179 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003180 return "native:product"
3181 }
Jooyung Han38002912019-05-16 04:01:54 +09003182 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003183 } else if c.InRamdisk() {
3184 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003185 } else if c.InVendorRamdisk() {
3186 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003187 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003188 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003189 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003190 return "native:ndk:none:none"
3191 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3192 //family, link := getNdkStlFamilyAndLinkType(c)
3193 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003194 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003195 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003196 } else {
3197 return "native:platform"
3198 }
3199}
3200
Jiyong Park9d452992018-10-03 00:38:19 +09003201// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003202// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003203func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003204 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003205 // Stub libs and prebuilt libs in a versioned SDK are not
3206 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07003207 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01003208 } else if _, ok := c.linker.(testPerSrc); ok {
3209 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003210 }
3211 return false
3212}
3213
Jiyong Parka90ca002019-10-07 15:47:24 +09003214func (c *Module) AvailableFor(what string) bool {
3215 if linker, ok := c.linker.(interface {
3216 availableFor(string) bool
3217 }); ok {
3218 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3219 } else {
3220 return c.ApexModuleBase.AvailableFor(what)
3221 }
3222}
3223
Jiyong Park62304bb2020-04-13 16:19:48 +09003224func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003225 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003226}
3227
Colin Crossaede88c2020-08-11 12:17:01 -07003228func (c *Module) UniqueApexVariations() bool {
3229 if u, ok := c.compiler.(interface {
3230 uniqueApexVariations() bool
3231 }); ok {
3232 return u.uniqueApexVariations()
3233 } else {
3234 return false
3235 }
3236}
3237
Paul Duffin0cb37b92020-03-04 14:52:46 +00003238func (c *Module) EverInstallable() bool {
3239 return c.installer != nil &&
3240 // Check to see whether the module is actually ever installable.
3241 c.installer.everInstallable()
3242}
3243
Ivan Lozanod7586b62021-04-01 09:49:36 -04003244func (c *Module) PreventInstall() bool {
3245 return c.Properties.PreventInstall
3246}
3247
3248func (c *Module) Installable() *bool {
3249 return c.Properties.Installable
3250}
3251
3252func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003253 ret := c.EverInstallable() &&
3254 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003255 proptools.BoolDefault(c.Installable(), true) &&
3256 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003257
3258 // The platform variant doesn't need further condition. Apex variants however might not
3259 // be installable because it will likely to be included in the APEX and won't appear
3260 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003261 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003262 return ret
3263 }
3264
3265 // Special case for modules that are configured to be installed to /data, which includes
3266 // test modules. For these modules, both APEX and non-APEX variants are considered as
3267 // installable. This is because even the APEX variants won't be included in the APEX, but
3268 // will anyway be installed to /data/*.
3269 // See b/146995717
3270 if c.InstallInData() {
3271 return ret
3272 }
3273
3274 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003275}
3276
Logan Chien41eabe62019-04-10 13:33:58 +08003277func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3278 if c.linker != nil {
3279 if library, ok := c.linker.(*libraryDecorator); ok {
3280 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3281 }
3282 }
3283}
3284
Jiyong Park45bf82e2020-12-15 22:29:02 +09003285var _ android.ApexModule = (*Module)(nil)
3286
3287// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003288func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003289 depTag := ctx.OtherModuleDependencyTag(dep)
3290 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3291
3292 if cc, ok := dep.(*Module); ok {
3293 if cc.HasStubsVariants() {
3294 if isLibDepTag && libDepTag.shared() {
3295 // dynamic dep to a stubs lib crosses APEX boundary
3296 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003297 }
Colin Cross6e511a92020-07-27 21:26:48 -07003298 if IsRuntimeDepTag(depTag) {
3299 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003300 return false
3301 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003302 }
Zhijun Heec285872021-04-24 10:47:08 -07003303 if cc.IsLlndk() {
3304 return false
3305 }
Colin Crossaac32222020-07-29 12:51:56 -07003306 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003307 // shared_lib dependency from a static lib is considered as crossing
3308 // the APEX boundary because the dependency doesn't actually is
3309 // linked; the dependency is used only during the compilation phase.
3310 return false
3311 }
Jiyong Parke3867542020-12-03 17:28:25 +09003312
3313 if isLibDepTag && libDepTag.excludeInApex {
3314 return false
3315 }
Colin Cross6e511a92020-07-27 21:26:48 -07003316 }
Colin Crossc1b36442021-05-06 13:42:48 -07003317 if depTag == stubImplDepTag {
3318 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003319 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003320 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003321 if depTag == staticVariantTag {
3322 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3323 // actually mean that the static lib (and its dependencies) are copied into the
3324 // APEX.
3325 return false
3326 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003327 return true
3328}
3329
Jiyong Park45bf82e2020-12-15 22:29:02 +09003330// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003331func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3332 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003333 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3334 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3335 return nil
3336 }
3337 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3338 if c.ToolchainLibrary() {
3339 return nil
3340 }
3341 // We don't check for prebuilt modules
3342 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3343 return nil
3344 }
3345 minSdkVersion := c.MinSdkVersion()
3346 if minSdkVersion == "apex_inherit" {
3347 return nil
3348 }
3349 if minSdkVersion == "" {
3350 // JNI libs within APK-in-APEX fall into here
3351 // Those are okay to set sdk_version instead
3352 // We don't have to check if this is a SDK variant because
3353 // non-SDK variant resets sdk_version, which works too.
3354 minSdkVersion = c.SdkVersion()
3355 }
Dan Albertc8060532020-07-22 22:32:17 -07003356 if minSdkVersion == "" {
3357 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3358 }
3359 // Not using nativeApiLevelFromUser because the context here is not
3360 // necessarily a native context.
3361 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003362 if err != nil {
3363 return err
3364 }
Dan Albertc8060532020-07-22 22:32:17 -07003365
3366 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003367 return fmt.Errorf("newer SDK(%v)", ver)
3368 }
3369 return nil
3370}
3371
Paul Duffinb5769c12021-05-12 16:16:51 +01003372// Implements android.ApexModule
3373func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3374 // stub libraries and native bridge libraries are always available to platform
3375 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3376}
3377
Colin Cross2ba19d92015-05-07 15:44:20 -07003378//
Colin Crosscfad1192015-11-02 16:43:11 -08003379// Defaults
3380//
Colin Crossca860ac2016-01-04 14:34:37 -08003381type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003382 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003383 android.DefaultsModuleBase
Liz Kammer3cf52112021-03-31 15:42:03 -04003384 // Included to support setting bazel_module.label for multiple Soong modules to the same Bazel
3385 // target. This is primarily useful for modules that were architecture specific and instead are
3386 // handled in Bazel as a select().
3387 android.BazelModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003388 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003389}
3390
Patrice Arrudac249c712019-03-19 17:00:29 -07003391// cc_defaults provides a set of properties that can be inherited by other cc
3392// modules. A module can use the properties from a cc_defaults using
3393// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3394// merged (when possible) by prepending the default module's values to the
3395// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003396func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003397 return DefaultsFactory()
3398}
3399
Colin Cross36242852017-06-23 15:06:31 -07003400func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003401 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003402
Colin Cross36242852017-06-23 15:06:31 -07003403 module.AddProperties(props...)
3404 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003405 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003406 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003407 &BaseCompilerProperties{},
3408 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003409 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003410 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003411 &StaticProperties{},
3412 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003413 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003414 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003415 &TestProperties{},
3416 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003417 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003418 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003419 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003420 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003421 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003422 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003423 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003424 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003425 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003426 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003427 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003428 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003429 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003430 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3431 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003432 )
Colin Crosscfad1192015-11-02 16:43:11 -08003433
Liz Kammer3cf52112021-03-31 15:42:03 -04003434 // Bazel module must be initialized _before_ Defaults to be included in cc_defaults module.
3435 android.InitBazelModule(module)
Jooyung Hancc372c52019-09-25 15:18:44 +09003436 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003437
3438 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003439}
3440
Jiyong Park2286afd2020-06-16 21:58:53 +09003441func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003442 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003443}
3444
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003445func kytheExtractAllFactory() android.Singleton {
3446 return &kytheExtractAllSingleton{}
3447}
3448
3449type kytheExtractAllSingleton struct {
3450}
3451
3452func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3453 var xrefTargets android.Paths
3454 ctx.VisitAllModules(func(module android.Module) {
3455 if ccModule, ok := module.(xref); ok {
3456 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3457 }
3458 })
3459 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3460 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003461 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003462 }
3463}
3464
Colin Cross06a931b2015-10-28 17:23:31 -07003465var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003466var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003467var BoolPtr = proptools.BoolPtr
3468var String = proptools.String
3469var StringPtr = proptools.StringPtr