blob: ca889137eeb789119dc58ee210a0a4c41f1b0dbc [file] [log] [blame]
Colin Cross5049f022015-03-18 13:28:46 -07001// Copyright 2015 Google Inc. All rights reserved.
Colin Cross3f40fa42015-01-30 17:27:36 -08002//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17// This file contains the module types for compiling C/C++ for Android, and converts the properties
18// into the flags and filenames necessary to pass to the compiler. The final creation of the rules
19// is handled in builder.go
20
21import (
Colin Cross41955e82019-05-29 14:40:35 -070022 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080023 "io"
Dan Albert9e10cd42016-08-03 14:12:14 -070024 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "strings"
26
Colin Cross97ba0732015-03-23 17:50:24 -070027 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070028 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070029
Colin Cross635c3b02016-05-18 15:37:25 -070030 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070031 "android/soong/cc/config"
Colin Cross5049f022015-03-18 13:28:46 -070032 "android/soong/genrule"
Colin Cross3f40fa42015-01-30 17:27:36 -080033)
34
Colin Cross463a90e2015-06-17 14:20:06 -070035func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000036 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070037
Paul Duffin036e7002019-12-19 19:16:28 +000038 pctx.Import("android/soong/cc/config")
39}
40
41func RegisterCCBuildComponents(ctx android.RegistrationContext) {
42 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
43
44 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000045 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090046 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070047 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010048 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070049 ctx.BottomUp("version_selector", versionSelectorMutator).Parallel()
50 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070051 ctx.BottomUp("begin", BeginMutator).Parallel()
Inseob Kimac1e9862019-12-09 18:15:47 +090052 ctx.BottomUp("sysprop_cc", SyspropMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070053 })
Colin Cross16b23492016-01-06 14:41:07 -080054
Paul Duffin036e7002019-12-19 19:16:28 +000055 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Ivan Lozano3968d8f2020-12-14 11:27:52 -050056 ctx.TopDown("asan_deps", sanitizerDepsMutator(Asan))
57 ctx.BottomUp("asan", sanitizerMutator(Asan)).Parallel()
Colin Cross16b23492016-01-06 14:41:07 -080058
Tri Vo6eafc362021-04-01 11:29:09 -070059 ctx.TopDown("hwasan_deps", sanitizerDepsMutator(Hwasan))
60 ctx.BottomUp("hwasan", sanitizerMutator(Hwasan)).Parallel()
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070061
Ivan Lozano3968d8f2020-12-14 11:27:52 -050062 ctx.TopDown("fuzzer_deps", sanitizerDepsMutator(Fuzzer))
63 ctx.BottomUp("fuzzer", sanitizerMutator(Fuzzer)).Parallel()
Mitch Phillipsbfeade62019-05-01 14:42:05 -070064
Jiyong Park1d1119f2019-07-29 21:27:18 +090065 // cfi mutator shouldn't run before sanitizers that return true for
66 // incompatibleWithCfi()
Vishwath Mohanb743e9c2017-11-01 09:20:21 +000067 ctx.TopDown("cfi_deps", sanitizerDepsMutator(cfi))
68 ctx.BottomUp("cfi", sanitizerMutator(cfi)).Parallel()
69
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -080070 ctx.TopDown("scs_deps", sanitizerDepsMutator(scs))
71 ctx.BottomUp("scs", sanitizerMutator(scs)).Parallel()
72
Colin Cross1e676be2016-10-12 14:38:15 -070073 ctx.TopDown("tsan_deps", sanitizerDepsMutator(tsan))
74 ctx.BottomUp("tsan", sanitizerMutator(tsan)).Parallel()
Dan Willemsen581341d2017-02-09 16:16:31 -080075
Colin Cross0b908332019-06-19 23:00:20 -070076 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090077 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080078
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080079 ctx.BottomUp("coverage", coverageMutator).Parallel()
Stephen Craneba090d12017-05-09 15:44:35 -070080
81 ctx.TopDown("lto_deps", ltoDepsMutator)
82 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090083
Jooyung Han479ca172020-10-19 18:51:07 +090084 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090085 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070086 })
Colin Crossb98c8b02016-07-29 13:44:28 -070087
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080088 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
89 // sabi mutator needs to be run after apex mutator finishes.
90 ctx.TopDown("sabi_deps", sabiDepsMutator)
91 })
92
Colin Cross57898582020-10-29 18:25:19 -070093 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070094}
95
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050096// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
97// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
98// edges to these modules.
99// This object is constructed in DepsMutator, by calling to various module delegates to set
100// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
101// dependencies.
102// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
103// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800104type Deps struct {
105 SharedLibs, LateSharedLibs []string
106 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800107 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800108 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700109
Chris Parsons79d66a52020-06-05 17:26:16 -0400110 // Used for data dependencies adjacent to tests
111 DataLibs []string
112
Yo Chiang219968c2020-09-22 18:45:04 +0800113 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
114 SystemSharedLibs []string
115
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500116 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800117 StaticUnwinderIfLegacy bool
118
Colin Cross5950f382016-12-13 12:50:57 -0800119 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700120
Colin Cross81413472016-04-11 14:37:39 -0700121 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700122
Dan Willemsenb40aab62016-04-20 14:21:14 -0700123 GeneratedSources []string
124 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900125 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700126
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700127 ReexportGeneratedHeaders []string
128
Colin Crossc465efd2021-06-11 18:00:04 -0700129 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700130
131 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700132 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900133
134 // List of libs that need to be excluded for APEX variant
135 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700136}
137
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500138// PathDeps is a struct containing file paths to dependencies of a module.
139// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
140// It's used to construct flags for various build statements (such as for compiling and linking).
141// It is then passed to module decorator functions responsible for registering build statements
142// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800143type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700144 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900145 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700146 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900147 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700148 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700149 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700150
Colin Cross0de8a1e2020-09-18 14:15:30 -0700151 // Transitive static library dependencies of static libraries for use in ordering.
152 TranstiveStaticLibrariesForOrdering *android.DepSet
153
Colin Cross26c34ed2016-09-30 17:10:16 -0700154 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100155 Objs Objects
156 // Paths to .o files in dependencies that provide them. Note that these lists
157 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800158 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700159 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700160
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100161 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
162 // the libs from all whole_static_lib dependencies.
163 WholeStaticLibsFromPrebuilts android.Paths
164
Colin Cross26c34ed2016-09-30 17:10:16 -0700165 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700166 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900167 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700168
Inseob Kimd110f872019-12-06 13:15:38 +0900169 Flags []string
170 IncludeDirs android.Paths
171 SystemIncludeDirs android.Paths
172 ReexportedDirs android.Paths
173 ReexportedSystemDirs android.Paths
174 ReexportedFlags []string
175 ReexportedGeneratedHeaders android.Paths
176 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700177
Colin Cross26c34ed2016-09-30 17:10:16 -0700178 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700179 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700180
Dan Willemsena0790e32018-10-12 00:24:23 -0700181 // Path to the dynamic linker binary
182 DynamicLinker android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700183}
184
Colin Cross4af21ed2019-11-04 09:37:55 -0800185// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
186// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
187// command line so they can be overridden by the local module flags).
188type LocalOrGlobalFlags struct {
189 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700190 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800191 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700192 CFlags []string // Flags that apply to C and C++ source files
193 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
194 ConlyFlags []string // Flags that apply to C source files
195 CppFlags []string // Flags that apply to C++ source files
196 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700197 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800198}
199
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500200// Flags contains various types of command line flags (and settings) for use in building build
201// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800202type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500203 // Local flags (which individual modules are responsible for). These may override global flags.
204 Local LocalOrGlobalFlags
205 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800206 Global LocalOrGlobalFlags
207
208 aidlFlags []string // Flags that apply to aidl source files
209 rsFlags []string // Flags that apply to renderscript source files
210 libFlags []string // Flags to add libraries early to the link order
211 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
212 TidyFlags []string // Flags that apply to clang-tidy
213 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700214
Colin Crossc3199482017-03-30 15:03:04 -0700215 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800216 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700217 SystemIncludeFlags []string
218
Oliver Nguyen04526782020-04-21 12:40:27 -0700219 Toolchain config.Toolchain
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500220 Tidy bool // True if clang-tidy is enabled.
221 GcovCoverage bool // True if coverage files should be generated.
222 SAbiDump bool // True if header abi dumps should be generated.
Oliver Nguyen04526782020-04-21 12:40:27 -0700223 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800224
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500225 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800226 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500227 // The target-device system path to the dynamic linker.
228 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800229
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700230 CFlagsDeps android.Paths // Files depended on by compiler flags
231 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800232
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500233 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700234 AssemblerWithCpp bool
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500235 // True if static libraries should be grouped (using `-Wl,--start-group` and `-Wl,--end-group`).
236 GroupStaticLibs bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800237
Colin Cross19878da2019-03-28 14:45:07 -0700238 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700239 protoC bool // Whether to use C instead of C++
240 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700241
242 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200243 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700244}
245
Colin Crossca860ac2016-01-04 14:34:37 -0800246// Properties used to compile all C or C++ modules
247type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700248 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800249 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700250
Jiyong Parkb35a8192020-08-10 15:59:36 +0900251 // The API level that this module is built against. The APIs of this API level will be
252 // visible at build time, but use of any APIs newer than min_sdk_version will render the
253 // module unloadable on older devices. In the future it will be possible to weakly-link new
254 // APIs, making the behavior match Java: such modules will load on older devices, but
255 // calling new APIs on devices that do not support them will result in a crash.
256 //
257 // This property has the same behavior as sdk_version does for Java modules. For those
258 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
259 // does for Java code.
260 //
261 // In addition, setting this property causes two variants to be built, one for the platform
262 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800263 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700264
Jiyong Parkb35a8192020-08-10 15:59:36 +0900265 // Minimum OS API level supported by this C or C++ module. This property becomes the value
266 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
267 // this property is also used to ensure that the min_sdk_version of the containing module is
268 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
269 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
270 // min_sdk_version of the containing APEX. When the module
271 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900272 Min_sdk_version *string
273
Colin Crossc511bc52020-04-07 16:50:32 +0000274 // If true, always create an sdk variant and don't create a platform variant.
275 Sdk_variant_only *bool
276
Jiyong Parkde866cb2018-12-07 23:08:36 +0900277 AndroidMkSharedLibs []string `blueprint:"mutated"`
278 AndroidMkStaticLibs []string `blueprint:"mutated"`
279 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
280 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700281 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900282 HideFromMake bool `blueprint:"mutated"`
283 PreventInstall bool `blueprint:"mutated"`
284 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700285
Yo Chiang219968c2020-09-22 18:45:04 +0800286 // Set by DepsMutator.
287 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
288
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200289 // The name of the image this module is built for, suffixed with a '.'
Justin Yun5f7f7e82019-11-18 19:52:14 +0900290 ImageVariationPrefix string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200291
292 // The VNDK version this module is built against. If empty, the module is not
293 // build against the VNDK.
294 VndkVersion string `blueprint:"mutated"`
295
296 // Suffix for the name of Android.mk entries generated by this module
297 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800298
299 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
300 // file
301 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900302
Yifan Hong39143a92020-10-26 12:43:12 -0700303 // Make this module available when building for ramdisk.
304 // On device without a dedicated recovery partition, the module is only
305 // available after switching root into
306 // /first_stage_ramdisk. To expose the module before switching root, install
307 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800308 Ramdisk_available *bool
309
Yifan Hong39143a92020-10-26 12:43:12 -0700310 // Make this module available when building for vendor ramdisk.
311 // On device without a dedicated recovery partition, the module is only
312 // available after switching root into
313 // /first_stage_ramdisk. To expose the module before switching root, install
314 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700315 Vendor_ramdisk_available *bool
316
Jiyong Parkf9332f12018-02-01 00:54:12 +0900317 // Make this module available when building for recovery
318 Recovery_available *bool
319
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200320 // Used by imageMutator, set by ImageMutatorBegin()
321 CoreVariantNeeded bool `blueprint:"mutated"`
322 RamdiskVariantNeeded bool `blueprint:"mutated"`
323 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
324 RecoveryVariantNeeded bool `blueprint:"mutated"`
325
326 // A list of variations for the "image" mutator of the form
327 //<image name> '.' <version char>, for example, 'vendor.S'
328 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900329
330 // Allows this module to use non-APEX version of libraries. Useful
331 // for building binaries that are started before APEXes are activated.
332 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900333
334 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
335 // see soong/cc/config/vndk.go
336 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900337
338 // Used by vendor snapshot to record dependencies from snapshot modules.
339 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900340 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900341 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000342
343 Installable *bool
Colin Crossc511bc52020-04-07 16:50:32 +0000344
345 // Set by factories of module types that can only be referenced from variants compiled against
346 // the SDK.
347 AlwaysSdk bool `blueprint:"mutated"`
348
349 // Variant is an SDK variant created by sdkMutator
350 IsSdkVariant bool `blueprint:"mutated"`
351 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
352 // variant to have a ".sdk" suffix.
353 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700354
355 // Normally Soong uses the directory structure to decide which modules
356 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800357 // different snapshots (vendor, recovery, etc.), but this property
358 // allows a partner to exclude a module normally thought of as a
359 // framework module from the vendor snapshot.
360 Exclude_from_vendor_snapshot *bool
361
362 // Normally Soong uses the directory structure to decide which modules
363 // should be included (framework) or excluded (non-framework) from the
364 // different snapshots (vendor, recovery, etc.), but this property
365 // allows a partner to exclude a module normally thought of as a
366 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800367 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900368
369 // List of APEXes that this module has private access to for testing purpose. The module
370 // can depend on libraries that are not exported by the APEXes and use private symbols
371 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000372 Test_for []string `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700373}
374
375type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900376 // whether this module should be allowed to be directly depended by other
377 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900378 // If set to true, two variants will be built separately, one like
379 // normal, and the other limited to the set of libraries and headers
380 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700381 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900382 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700383 // so it shouldn't have any unversioned runtime dependencies, or
384 // make assumptions about the system that may not be true in the
385 // future.
386 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900387 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900388 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900389 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900390 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900391 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700392 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
393 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900394
Justin Yunebcf0c52021-01-08 18:00:19 +0900395 // This is the same as the "vendor_available" except that the install path
396 // of the vendor variant is /odm or /vendor/odm.
397 // By replacing "vendor_available: true" with "odm_available: true", the
398 // module will install its vendor variant to the /odm partition or /vendor/odm.
399 // As the modules with "odm_available: true" still create the vendor variants,
400 // they can link to the other vendor modules as the vendor_available modules do.
401 // Also, the vendor modules can link to odm_available modules.
402 //
403 // It may not be used for VNDK modules.
404 Odm_available *bool
405
Justin Yun63e9ec72020-10-29 16:49:43 +0900406 // whether this module should be allowed to be directly depended by other
407 // modules with `product_specific: true` or `product_available: true`.
408 // If set to true, an additional product variant will be built separately
409 // that is limited to the set of libraries and headers that are exposed to
410 // /product modules.
411 //
412 // The product variant may be used with a different (newer) /system,
413 // so it shouldn't have any unversioned runtime dependencies, or
414 // make assumptions about the system that may not be true in the
415 // future.
416 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900417 // If set to false, this module becomes inaccessible from /product modules.
418 //
419 // Different from the 'vendor_available' property, the modules with
420 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
421 // library without 'product_available' may not be depended on by any other
422 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900423 //
424 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
425 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
426 Product_available *bool
427
Jiyong Park5fb8c102018-04-09 12:03:06 +0900428 // whether this module is capable of being loaded with other instance
429 // (possibly an older version) of the same module in the same process.
430 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
431 // can be double loaded in a vendor process if the library is also a
432 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
433 // explicitly marked as `double_loadable: true` by the owner, or the dependency
434 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
435 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800436
437 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
438 IsLLNDK bool `blueprint:"mutated"`
439
Colin Cross78212242021-01-06 14:51:30 -0800440 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
441 // set and the module is not listed in VndkMustUseVendorVariantList.
442 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
443
444 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
445 IsVNDKCore bool `blueprint:"mutated"`
446
447 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
448 IsVNDKSP bool `blueprint:"mutated"`
449
450 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
451 // module sets the llndk.private property.
452 IsVNDKPrivate bool `blueprint:"mutated"`
453
454 // IsVNDKProduct is set if a VNDK module sets the product_available property.
455 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700456
457 // IsVendorPublicLibrary is set for the core and product variants of a library that has
458 // vendor_public_library stubs.
459 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800460}
461
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500462// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
463// to understanding details about the type of the current module.
464// For example, one might call these functions to determine whether the current module is a static
465// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800466type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800467 static() bool
468 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700469 testBinary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900470 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900471 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900472 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700473 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900474 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700475 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800476 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900477 minSdkVersion() string
478 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700479 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700480 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800481 IsLlndk() bool
482 IsLlndkPublic() bool
483 isImplementationForLLNDKPublic() bool
484 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900485 isVndk() bool
486 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500487 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700488 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900489 inProduct() bool
490 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800491 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700492 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900493 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700494 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700495 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800496 getVndkExtendsModuleName() string
Yi Kong7e53c572018-02-14 18:16:12 +0800497 isPgoCompile() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800498 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800499 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800500 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700501 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700502 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900503 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800504 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700505 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700506 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800507 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800508 isCfiAssemblySupportEnabled() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800509}
510
511type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700512 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800513 ModuleContextIntf
514}
515
516type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700517 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800518 ModuleContextIntf
519}
520
Colin Cross37047f12016-12-13 17:06:13 -0800521type DepsContext interface {
522 android.BottomUpMutatorContext
523 ModuleContextIntf
524}
525
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500526// feature represents additional (optional) steps to building cc-related modules, such as invocation
527// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800528type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800529 flags(ctx ModuleContext, flags Flags) Flags
530 props() []interface{}
531}
532
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500533// compiler is the interface for a compiler helper object. Different module decorators may implement
534// this helper differently. For example, compiling a `cc_library` may use a different build
535// statement than building a `toolchain_library`.
Colin Crossca860ac2016-01-04 14:34:37 -0800536type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700537 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800538 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800539 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700540 compilerProps() []interface{}
541
Colin Cross76fada02016-07-27 10:31:13 -0700542 appendCflags([]string)
543 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700544 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800545}
546
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500547// linker is the interface for a linker decorator object. Individual module types can provide
548// their own implementation for this decorator, and thus specify custom logic regarding build
549// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800550type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700551 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800552 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700553 linkerFlags(ctx ModuleContext, flags Flags) Flags
554 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800555 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700556
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700557 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700558 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900559 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700560
561 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900562 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000563
564 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000565 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
566}
567
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500568// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000569type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500570 sharedLibs []string
571 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
572 // libc, libm, etc.)
Colin Cross9ecb42d2021-06-22 13:20:01 -0700573 systemSharedLibs []string
574 defaultSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800575}
576
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500577// installer is the interface for an installer helper object. This helper is responsible for
578// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800579type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700580 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700581 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000582 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800583 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700584 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700585 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900586 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100587 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900588 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800589}
590
Chris Parsons8d6e4332021-02-22 16:13:50 -0500591// bazelHandler is the interface for a helper object related to deferring to Bazel for
592// processing a module (during Bazel mixed builds). Individual module types should define
593// their own bazel handler if they support deferring to Bazel.
594type bazelHandler interface {
595 // Issue query to Bazel to retrieve information about Bazel's view of the current module.
596 // If Bazel returns this information, set module properties on the current module to reflect
597 // the returned information.
598 // Returns true if information was available from Bazel, false if bazel invocation still needs to occur.
599 generateBazelBuildActions(ctx android.ModuleContext, label string) bool
600}
601
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800602type xref interface {
603 XrefCcFiles() android.Paths
604}
605
Colin Cross6e511a92020-07-27 21:26:48 -0700606type libraryDependencyKind int
607
608const (
609 headerLibraryDependency = iota
610 sharedLibraryDependency
611 staticLibraryDependency
612)
613
614func (k libraryDependencyKind) String() string {
615 switch k {
616 case headerLibraryDependency:
617 return "headerLibraryDependency"
618 case sharedLibraryDependency:
619 return "sharedLibraryDependency"
620 case staticLibraryDependency:
621 return "staticLibraryDependency"
622 default:
623 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
624 }
625}
626
627type libraryDependencyOrder int
628
629const (
630 earlyLibraryDependency = -1
631 normalLibraryDependency = 0
632 lateLibraryDependency = 1
633)
634
635func (o libraryDependencyOrder) String() string {
636 switch o {
637 case earlyLibraryDependency:
638 return "earlyLibraryDependency"
639 case normalLibraryDependency:
640 return "normalLibraryDependency"
641 case lateLibraryDependency:
642 return "lateLibraryDependency"
643 default:
644 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
645 }
646}
647
648// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
649// tags that have a set of predefined tag objects that are reused for each dependency, a
650// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
651// That means that comparing a libraryDependencyTag for equality will only be equal if all
652// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
653// then check individual metadata fields instead.
654type libraryDependencyTag struct {
655 blueprint.BaseDependencyTag
656
657 // These are exported so that fmt.Printf("%#v") can call their String methods.
658 Kind libraryDependencyKind
659 Order libraryDependencyOrder
660
661 wholeStatic bool
662
663 reexportFlags bool
664 explicitlyVersioned bool
665 dataLib bool
666 ndk bool
667
668 staticUnwinder bool
669
670 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900671
Cindy Zhou18417cb2020-12-10 07:12:38 -0800672 // Whether or not this dependency should skip the apex dependency check
673 skipApexAllowedDependenciesCheck bool
674
Jiyong Parke3867542020-12-03 17:28:25 +0900675 // Whether or not this dependency has to be followed for the apex variants
676 excludeInApex bool
Colin Cross6e511a92020-07-27 21:26:48 -0700677}
678
679// header returns true if the libraryDependencyTag is tagging a header lib dependency.
680func (d libraryDependencyTag) header() bool {
681 return d.Kind == headerLibraryDependency
682}
683
684// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
685func (d libraryDependencyTag) shared() bool {
686 return d.Kind == sharedLibraryDependency
687}
688
689// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
690func (d libraryDependencyTag) static() bool {
691 return d.Kind == staticLibraryDependency
692}
693
Colin Crosse9fe2942020-11-10 18:12:15 -0800694// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
695// binaries or other shared libraries are installed as dependencies.
696func (d libraryDependencyTag) InstallDepNeeded() bool {
697 return d.shared()
698}
699
700var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
701
702// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700703// libraryDependencyTag. Each tag object is created globally and reused for multiple
704// dependencies (although since the object contains no references, assigning a tag to a
705// variable and modifying it will not modify the original). Users can compare the tag
706// returned by ctx.OtherModuleDependencyTag against the global original
707type dependencyTag struct {
708 blueprint.BaseDependencyTag
709 name string
710}
711
Colin Crosse9fe2942020-11-10 18:12:15 -0800712// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
713// libraryDependencyTag, but where the dependency needs to be installed when the parent is
714// installed.
715type installDependencyTag struct {
716 blueprint.BaseDependencyTag
717 android.InstallAlwaysNeededDependencyTag
718 name string
719}
720
Colin Crossc99deeb2016-04-11 15:06:20 -0700721var (
Colin Cross6e511a92020-07-27 21:26:48 -0700722 genSourceDepTag = dependencyTag{name: "gen source"}
723 genHeaderDepTag = dependencyTag{name: "gen header"}
724 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
725 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900726 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700727 reuseObjTag = dependencyTag{name: "reuse objects"}
728 staticVariantTag = dependencyTag{name: "static variant"}
729 vndkExtDepTag = dependencyTag{name: "vndk extends"}
730 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800731 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700732 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700733 stubImplDepTag = dependencyTag{name: "stub_impl"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700734)
735
Roland Levillainf89cd092019-07-29 16:22:59 +0100736func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700737 ccLibDepTag, ok := depTag.(libraryDependencyTag)
738 return ok && ccLibDepTag.shared()
739}
740
741func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
742 ccLibDepTag, ok := depTag.(libraryDependencyTag)
743 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100744}
745
Zach Johnson3df4e632020-11-06 11:56:27 -0800746func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
747 ccLibDepTag, ok := depTag.(libraryDependencyTag)
748 return ok && ccLibDepTag.header()
749}
750
Roland Levillainf89cd092019-07-29 16:22:59 +0100751func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800752 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100753}
754
755func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700756 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100757 return ok && ccDepTag == testPerSrcDepTag
758}
759
Colin Crossca860ac2016-01-04 14:34:37 -0800760// Module contains the properties and members used by all C/C++ module types, and implements
761// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500762// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
763// interface.
764//
765// To define a C/C++ related module, construct a new Module object and point its delegates to
766// type-specific structs. These delegates will be invoked to register module-specific build
767// statements which may be unique to the module type. For example, module.compiler.compile() should
768// be defined so as to register build statements which are responsible for compiling the module.
769//
770// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
771// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
772// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
773// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800774type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700775 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -0700776 android.DefaultableModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +0900777 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900778 android.SdkBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500779 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700780
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700781 Properties BaseProperties
782 VendorProperties VendorProperties
Colin Crossfa138792015-04-24 17:31:52 -0700783
Colin Crossca860ac2016-01-04 14:34:37 -0800784 // initialize before calling Init
Colin Cross635c3b02016-05-18 15:37:25 -0700785 hod android.HostOrDeviceSupported
786 multilib android.Multilib
Colin Crossc472d572015-03-17 15:06:21 -0700787
Paul Duffina0843f62019-12-13 19:50:38 +0000788 // Allowable SdkMemberTypes of this module type.
789 sdkMemberTypes []android.SdkMemberType
790
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500791 // decorator delegates, initialize before calling Init
792 // these may contain module-specific implementations, and effectively allow for custom
793 // type-specific logic. These members may reference different objects or the same object.
794 // Functions of these decorators will be invoked to initialize and register type-specific
795 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500796 compiler compiler
797 linker linker
798 installer installer
799 bazelHandler bazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500800
801 features []feature
802 stl *stl
803 sanitize *sanitize
804 coverage *coverage
805 sabi *sabi
806 vndkdep *vndkdep
807 lto *lto
808 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800809
Colin Cross31076b32020-10-23 17:22:06 -0700810 library libraryInterface
811
Colin Cross635c3b02016-05-18 15:37:25 -0700812 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800813
Colin Crossb98c8b02016-07-29 13:44:28 -0700814 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700815
816 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800817
818 // Flags used to compile this module
819 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700820
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800821 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700822 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900823
824 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800825 // Kythe (source file indexer) paths for this compilation module
826 kytheFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900827
828 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700829 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700830
831 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700832}
833
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200834func (c *Module) AddJSONData(d *map[string]interface{}) {
835 c.AndroidModuleBase().AddJSONData(d)
836 (*d)["Cc"] = map[string]interface{}{
837 "SdkVersion": c.SdkVersion(),
838 "MinSdkVersion": c.MinSdkVersion(),
839 "VndkVersion": c.VndkVersion(),
840 "ProductSpecific": c.ProductSpecific(),
841 "SocSpecific": c.SocSpecific(),
842 "DeviceSpecific": c.DeviceSpecific(),
843 "InProduct": c.InProduct(),
844 "InVendor": c.InVendor(),
845 "InRamdisk": c.InRamdisk(),
846 "InVendorRamdisk": c.InVendorRamdisk(),
847 "InRecovery": c.InRecovery(),
848 "VendorAvailable": c.VendorAvailable(),
849 "ProductAvailable": c.ProductAvailable(),
850 "RamdiskAvailable": c.RamdiskAvailable(),
851 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
852 "RecoveryAvailable": c.RecoveryAvailable(),
853 "OdmAvailable": c.OdmAvailable(),
854 "InstallInData": c.InstallInData(),
855 "InstallInRamdisk": c.InstallInRamdisk(),
856 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
857 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
858 "InstallInRecovery": c.InstallInRecovery(),
859 "InstallInRoot": c.InstallInRoot(),
860 "IsVndk": c.IsVndk(),
861 "IsVndkExt": c.IsVndkExt(),
862 "IsVndkPrivate": c.IsVndkPrivate(),
863 "IsVndkSp": c.IsVndkSp(),
864 "IsLlndk": c.IsLlndk(),
865 "IsLlndkPublic": c.IsLlndkPublic(),
866 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
867 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
868 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
869 "ApexSdkVersion": c.apexSdkVersion,
870 "TestFor": c.TestFor(),
871 }
872}
873
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500874func (c *Module) SetPreventInstall() {
875 c.Properties.PreventInstall = true
876}
877
878func (c *Module) SetHideFromMake() {
879 c.Properties.HideFromMake = true
880}
881
Ivan Lozanod7586b62021-04-01 09:49:36 -0400882func (c *Module) HiddenFromMake() bool {
883 return c.Properties.HideFromMake
884}
885
Ivan Lozano52767be2019-10-18 14:49:46 -0700886func (c *Module) Toc() android.OptionalPath {
887 if c.linker != nil {
888 if library, ok := c.linker.(libraryInterface); ok {
889 return library.toc()
890 }
891 }
892 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
893}
894
895func (c *Module) ApiLevel() string {
896 if c.linker != nil {
897 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700898 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700899 }
900 }
901 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
902}
903
904func (c *Module) Static() bool {
905 if c.linker != nil {
906 if library, ok := c.linker.(libraryInterface); ok {
907 return library.static()
908 }
909 }
910 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
911}
912
913func (c *Module) Shared() bool {
914 if c.linker != nil {
915 if library, ok := c.linker.(libraryInterface); ok {
916 return library.shared()
917 }
918 }
919 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
920}
921
922func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +0000923 if c.stl != nil {
924 return c.stl.Properties.SelectedStl
925 }
926 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700927}
928
929func (c *Module) ToolchainLibrary() bool {
930 if _, ok := c.linker.(*toolchainLibraryDecorator); ok {
931 return true
932 }
933 return false
934}
935
936func (c *Module) NdkPrebuiltStl() bool {
937 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
938 return true
939 }
940 return false
941}
942
943func (c *Module) StubDecorator() bool {
944 if _, ok := c.linker.(*stubDecorator); ok {
945 return true
946 }
947 return false
948}
949
950func (c *Module) SdkVersion() string {
951 return String(c.Properties.Sdk_version)
952}
953
Artur Satayev480e25b2020-04-27 18:53:18 +0100954func (c *Module) MinSdkVersion() string {
955 return String(c.Properties.Min_sdk_version)
956}
957
Dan Albert92fe7402020-07-15 13:33:30 -0700958func (c *Module) SplitPerApiLevel() bool {
Colin Cross1348ce32020-10-01 13:37:16 -0700959 if !c.canUseSdk() {
960 return false
961 }
Dan Albert92fe7402020-07-15 13:33:30 -0700962 if linker, ok := c.linker.(*objectLinker); ok {
963 return linker.isCrt()
964 }
965 return false
966}
967
Colin Crossc511bc52020-04-07 16:50:32 +0000968func (c *Module) AlwaysSdk() bool {
969 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
970}
971
Ivan Lozano183a3212019-10-18 14:18:45 -0700972func (c *Module) CcLibrary() bool {
973 if c.linker != nil {
974 if _, ok := c.linker.(*libraryDecorator); ok {
975 return true
976 }
Colin Crossd48fe732020-09-23 20:37:24 -0700977 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
978 return true
979 }
Ivan Lozano183a3212019-10-18 14:18:45 -0700980 }
981 return false
982}
983
984func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -0700985 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700986 return true
987 }
988 return false
989}
990
Ivan Lozano2b262972019-11-21 12:30:50 -0800991func (c *Module) NonCcVariants() bool {
992 return false
993}
994
Ivan Lozano183a3212019-10-18 14:18:45 -0700995func (c *Module) SetStatic() {
996 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700997 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700998 library.setStatic()
999 return
1000 }
1001 }
1002 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1003}
1004
1005func (c *Module) SetShared() {
1006 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001007 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001008 library.setShared()
1009 return
1010 }
1011 }
1012 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1013}
1014
1015func (c *Module) BuildStaticVariant() bool {
1016 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001017 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001018 return library.buildStatic()
1019 }
1020 }
1021 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1022}
1023
1024func (c *Module) BuildSharedVariant() bool {
1025 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001026 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001027 return library.buildShared()
1028 }
1029 }
1030 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1031}
1032
1033func (c *Module) Module() android.Module {
1034 return c
1035}
1036
Jiyong Parkc20eee32018-09-05 22:36:17 +09001037func (c *Module) OutputFile() android.OptionalPath {
1038 return c.outputFile
1039}
1040
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001041func (c *Module) CoverageFiles() android.Paths {
1042 if c.linker != nil {
1043 if library, ok := c.linker.(libraryInterface); ok {
1044 return library.objs().coverageFiles
1045 }
1046 }
1047 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1048}
1049
Ivan Lozano183a3212019-10-18 14:18:45 -07001050var _ LinkableInterface = (*Module)(nil)
1051
Jiyong Park719b4462019-01-13 00:39:51 +09001052func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001053 if c.linker != nil {
1054 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001055 }
1056 return nil
1057}
1058
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001059func (c *Module) CoverageOutputFile() android.OptionalPath {
1060 if c.linker != nil {
1061 return c.linker.coverageOutputFilePath()
1062 }
1063 return android.OptionalPath{}
1064}
1065
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001066func (c *Module) RelativeInstallPath() string {
1067 if c.installer != nil {
1068 return c.installer.relativeInstallPath()
1069 }
1070 return ""
1071}
1072
Jooyung Han344d5432019-08-23 11:17:39 +09001073func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001074 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001075}
1076
Colin Cross36242852017-06-23 15:06:31 -07001077func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001078 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001079 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001080 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001081 }
1082 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001083 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001084 }
1085 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001086 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001087 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001088 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001089 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001090 }
Colin Cross16b23492016-01-06 14:41:07 -08001091 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001092 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001093 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001094 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001095 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001096 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001097 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001098 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001099 }
Justin Yun8effde42017-06-23 19:24:43 +09001100 if c.vndkdep != nil {
1101 c.AddProperties(c.vndkdep.props()...)
1102 }
Stephen Craneba090d12017-05-09 15:44:35 -07001103 if c.lto != nil {
1104 c.AddProperties(c.lto.props()...)
1105 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001106 if c.pgo != nil {
1107 c.AddProperties(c.pgo.props()...)
1108 }
Colin Crossca860ac2016-01-04 14:34:37 -08001109 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001110 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001111 }
Colin Crossc472d572015-03-17 15:06:21 -07001112
Colin Cross36242852017-06-23 15:06:31 -07001113 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerea6666f2021-02-17 10:17:28 -05001114 android.InitBazelModule(c)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001115 android.InitApexModule(c)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001116 android.InitSdkAwareModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001117 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001118
Colin Cross36242852017-06-23 15:06:31 -07001119 return c
Colin Crossc472d572015-03-17 15:06:21 -07001120}
1121
Ivan Lozano52767be2019-10-18 14:49:46 -07001122func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001123 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001124}
1125
Colin Crossc511bc52020-04-07 16:50:32 +00001126func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001127 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1128 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001129}
1130
1131func (c *Module) UseSdk() bool {
1132 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001133 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001134 }
1135 return false
1136}
1137
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001138func (c *Module) isCoverageVariant() bool {
1139 return c.coverage.Properties.IsCoverageVariant
1140}
1141
Colin Cross95f1ca02020-10-29 20:47:22 -07001142func (c *Module) IsNdk(config android.Config) bool {
1143 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001144}
1145
Colin Cross127bb8b2020-12-16 16:46:01 -08001146func (c *Module) IsLlndk() bool {
1147 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001148}
1149
Colin Cross127bb8b2020-12-16 16:46:01 -08001150func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001151 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001152}
1153
Colin Cross1f3f1302021-04-26 18:37:44 -07001154func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001155 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001156 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001157}
1158
Colin Cross5271fea2021-04-27 13:06:04 -07001159func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1160 lib := moduleLibraryInterface(m)
1161 return lib != nil && (lib.hasVendorPublicLibrary())
1162}
1163
1164// IsVendorPublicLibrary returns true for vendor public libraries.
1165func (c *Module) IsVendorPublicLibrary() bool {
1166 return c.VendorProperties.IsVendorPublicLibrary
1167}
1168
Ivan Lozanod7586b62021-04-01 09:49:36 -04001169func (c *Module) HasLlndkStubs() bool {
1170 lib := moduleLibraryInterface(c)
1171 return lib != nil && lib.hasLLNDKStubs()
1172}
1173
1174func (c *Module) StubsVersion() string {
1175 if lib, ok := c.linker.(versionedInterface); ok {
1176 return lib.stubsVersion()
1177 }
1178 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1179}
1180
Colin Cross127bb8b2020-12-16 16:46:01 -08001181// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1182// and does not set llndk.vendor_available: false.
1183func (c *Module) isImplementationForLLNDKPublic() bool {
1184 library, _ := c.library.(*libraryDecorator)
1185 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001186 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001187}
1188
Justin Yunfd9e8042020-12-23 18:23:14 +09001189// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001190func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001191 // Check if VNDK-core-private or VNDK-SP-private
1192 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001193 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001194 }
1195
1196 // Check if LLNDK-private
1197 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001198 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001199 }
1200
1201 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001202}
1203
Ivan Lozano52767be2019-10-18 14:49:46 -07001204func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001205 if vndkdep := c.vndkdep; vndkdep != nil {
1206 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001207 }
1208 return false
1209}
1210
Yi Kong7e53c572018-02-14 18:16:12 +08001211func (c *Module) isPgoCompile() bool {
1212 if pgo := c.pgo; pgo != nil {
1213 return pgo.Properties.PgoCompile
1214 }
1215 return false
1216}
1217
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001218func (c *Module) isNDKStubLibrary() bool {
1219 if _, ok := c.compiler.(*stubDecorator); ok {
1220 return true
1221 }
1222 return false
1223}
1224
Ivan Lozanod7586b62021-04-01 09:49:36 -04001225func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001226 if vndkdep := c.vndkdep; vndkdep != nil {
1227 return vndkdep.isVndkSp()
1228 }
1229 return false
1230}
1231
Ivan Lozanof9e21722020-12-02 09:00:51 -05001232func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001233 if vndkdep := c.vndkdep; vndkdep != nil {
1234 return vndkdep.isVndkExt()
1235 }
1236 return false
1237}
1238
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001239func (c *Module) SubName() string {
1240 return c.Properties.SubName
1241}
1242
Ivan Lozano52767be2019-10-18 14:49:46 -07001243func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001244 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001245}
1246
Logan Chienf3511742017-10-31 18:04:35 +08001247func (c *Module) getVndkExtendsModuleName() string {
1248 if vndkdep := c.vndkdep; vndkdep != nil {
1249 return vndkdep.getVndkExtendsModuleName()
1250 }
1251 return ""
1252}
1253
Jiyong Park25fc6a92018-11-18 18:02:45 +09001254func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001255 if lib := c.library; lib != nil {
1256 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001257 }
1258 return false
1259}
1260
1261func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001262 if lib := c.library; lib != nil {
1263 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001264 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001265 return false
1266}
1267
Colin Cross0477b422020-10-13 18:43:54 -07001268// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1269// the implementation. If it is an implementation library it returns its own name.
1270func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1271 name := ctx.OtherModuleName(c)
1272 if versioned, ok := c.linker.(versionedInterface); ok {
1273 name = versioned.implementationModuleName(name)
1274 }
1275 return name
1276}
1277
Martin Stjernholm2856c662020-12-02 15:03:42 +00001278// Similar to ImplementationModuleName, but uses the Make variant of the module
1279// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1280// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1281// under the premise that the prebuilt module overrides its source counterpart
1282// if it is exposed to Make).
1283func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1284 name := c.BaseModuleName()
1285 if versioned, ok := c.linker.(versionedInterface); ok {
1286 name = versioned.implementationModuleName(name)
1287 }
1288 return name
1289}
1290
Jiyong Park7d55b612021-06-11 17:22:09 +09001291func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001292 return Bool(c.Properties.Bootstrap)
1293}
1294
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001295func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001296 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1297 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1298 return false
1299 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001300 return c.linker != nil && c.linker.nativeCoverage()
1301}
1302
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001303func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001304 if p, ok := c.linker.(SnapshotInterface); ok {
1305 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001306 }
1307 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001308}
1309
Bill Peckham945441c2020-08-31 16:07:58 -07001310func (c *Module) ExcludeFromVendorSnapshot() bool {
1311 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1312}
1313
Jose Galmesf7294582020-11-13 12:07:36 -08001314func (c *Module) ExcludeFromRecoverySnapshot() bool {
1315 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1316}
1317
Jiyong Parkf1194352019-02-25 11:05:47 +09001318func isBionic(name string) bool {
1319 switch name {
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09001320 case "libc", "libm", "libdl", "libdl_android", "linker", "linkerconfig":
Jiyong Parkf1194352019-02-25 11:05:47 +09001321 return true
1322 }
1323 return false
1324}
1325
Martin Stjernholm279de572019-09-10 23:18:20 +01001326func InstallToBootstrap(name string, config android.Config) bool {
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001327 if name == "libclang_rt.hwasan-aarch64-android" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001328 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001329 }
1330 return isBionic(name)
1331}
1332
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001333func (c *Module) XrefCcFiles() android.Paths {
1334 return c.kytheFiles
1335}
1336
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001337func (c *Module) isCfiAssemblySupportEnabled() bool {
1338 return c.sanitize != nil &&
1339 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1340}
1341
Inseob Kim800d1142021-06-14 12:03:51 +09001342func (c *Module) InstallInRoot() bool {
1343 return c.installer != nil && c.installer.installInRoot()
1344}
1345
Colin Crossca860ac2016-01-04 14:34:37 -08001346type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001347 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001348 moduleContextImpl
1349}
1350
Colin Cross37047f12016-12-13 17:06:13 -08001351type depsContext struct {
1352 android.BottomUpMutatorContext
1353 moduleContextImpl
1354}
1355
Colin Crossca860ac2016-01-04 14:34:37 -08001356type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001357 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001358 moduleContextImpl
1359}
1360
1361type moduleContextImpl struct {
1362 mod *Module
1363 ctx BaseModuleContext
1364}
1365
Colin Crossb98c8b02016-07-29 13:44:28 -07001366func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001367 return ctx.mod.toolchain(ctx.ctx)
1368}
1369
1370func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001371 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001372}
1373
1374func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001375 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001376}
1377
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001378func (ctx *moduleContextImpl) testBinary() bool {
1379 return ctx.mod.testBinary()
1380}
1381
Jiyong Park1d1119f2019-07-29 21:27:18 +09001382func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001383 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001384}
1385
Inseob Kim7f283f42020-06-01 21:53:49 +09001386func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001387 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001388}
1389
Inseob Kim1042d292020-06-01 23:23:05 +09001390func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001391 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001392}
1393
Jooyung Hanccce2f22020-03-07 03:45:53 +09001394func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001395 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001396}
1397
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001398func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001399 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001400}
1401
1402func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001403 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001404 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001405 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001406 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001407 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001408 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001409 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001410 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001411 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001412 }
1413 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001414}
1415
Jiyong Parkb35a8192020-08-10 15:59:36 +09001416func (ctx *moduleContextImpl) minSdkVersion() string {
1417 ver := ctx.mod.MinSdkVersion()
1418 if ver == "apex_inherit" && !ctx.isForPlatform() {
1419 ver = ctx.apexSdkVersion().String()
1420 }
1421 if ver == "apex_inherit" || ver == "" {
1422 ver = ctx.sdkVersion()
1423 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001424 // For crt objects, the meaning of min_sdk_version is very different from other types of
1425 // module. For them, min_sdk_version defines the oldest version that the build system will
1426 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1427 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1428 // and min_sdk_version properties of the variants are set to the corresponding version
1429 // numbers. However, the platform (non-sdk) variant of the crt object is left untouched.
1430 // min_sdk_version: 16 doesn't actually mean that the platform variant has to support such
1431 // an old version. Since the variant is for the platform, it's preferred to target the
1432 // latest version.
1433 if ctx.mod.SplitPerApiLevel() && !ctx.isSdkVariant() {
1434 ver = strconv.Itoa(android.FutureApiLevelInt)
1435 }
1436
Jiyong Parkb35a8192020-08-10 15:59:36 +09001437 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1438 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1439 minSdkVersionInt, err2 := strconv.Atoi(ver)
1440 if err == nil && err2 == nil {
1441 if sdkVersionInt < minSdkVersionInt {
1442 return strconv.Itoa(sdkVersionInt)
1443 }
1444 }
1445 return ver
1446}
1447
1448func (ctx *moduleContextImpl) isSdkVariant() bool {
1449 return ctx.mod.IsSdkVariant()
1450}
1451
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001452func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001453 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001454}
Justin Yun8effde42017-06-23 19:24:43 +09001455
Colin Cross95f1ca02020-10-29 20:47:22 -07001456func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1457 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001458}
1459
Colin Cross127bb8b2020-12-16 16:46:01 -08001460func (ctx *moduleContextImpl) IsLlndk() bool {
1461 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001462}
1463
Colin Cross127bb8b2020-12-16 16:46:01 -08001464func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1465 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001466}
1467
Colin Cross127bb8b2020-12-16 16:46:01 -08001468func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1469 return ctx.mod.isImplementationForLLNDKPublic()
1470}
1471
1472func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1473 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001474}
1475
Logan Chienf3511742017-10-31 18:04:35 +08001476func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001477 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001478}
1479
Yi Kong7e53c572018-02-14 18:16:12 +08001480func (ctx *moduleContextImpl) isPgoCompile() bool {
1481 return ctx.mod.isPgoCompile()
1482}
1483
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001484func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1485 return ctx.mod.isNDKStubLibrary()
1486}
1487
Justin Yun8effde42017-06-23 19:24:43 +09001488func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001489 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001490}
1491
Ivan Lozanof9e21722020-12-02 09:00:51 -05001492func (ctx *moduleContextImpl) IsVndkExt() bool {
1493 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001494}
1495
Colin Cross5271fea2021-04-27 13:06:04 -07001496func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1497 return ctx.mod.IsVendorPublicLibrary()
1498}
1499
Vic Yangefd249e2018-11-12 20:19:56 -08001500func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001501 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001502}
1503
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001504func (ctx *moduleContextImpl) selectedStl() string {
1505 if stl := ctx.mod.stl; stl != nil {
1506 return stl.Properties.SelectedStl
1507 }
1508 return ""
1509}
1510
Ivan Lozanobd721262018-11-27 14:33:03 -08001511func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1512 return ctx.mod.linker.useClangLld(actx)
1513}
1514
Colin Crossce75d2c2016-10-06 16:12:58 -07001515func (ctx *moduleContextImpl) baseModuleName() string {
1516 return ctx.mod.ModuleBase.BaseModuleName()
1517}
1518
Logan Chienf3511742017-10-31 18:04:35 +08001519func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1520 return ctx.mod.getVndkExtendsModuleName()
1521}
1522
Logan Chiene274fc92019-12-03 11:18:32 -08001523func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001524 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001525}
1526
Colin Crosse07f2312020-08-13 11:24:56 -07001527func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001528 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001529}
1530
Dan Albertc8060532020-07-22 22:32:17 -07001531func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001532 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001533}
1534
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001535func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001536 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001537}
1538
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001539func (ctx *moduleContextImpl) nativeCoverage() bool {
1540 return ctx.mod.nativeCoverage()
1541}
1542
Colin Cross56a83212020-09-15 18:30:11 -07001543func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1544 return ctx.mod.DirectlyInAnyApex()
1545}
1546
Colin Cross95b07f22020-12-16 11:06:50 -08001547func (ctx *moduleContextImpl) isPreventInstall() bool {
1548 return ctx.mod.Properties.PreventInstall
1549}
1550
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001551func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1552 return ctx.mod.isCfiAssemblySupportEnabled()
1553}
1554
Colin Cross635c3b02016-05-18 15:37:25 -07001555func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001556 return &Module{
1557 hod: hod,
1558 multilib: multilib,
1559 }
1560}
1561
Colin Cross635c3b02016-05-18 15:37:25 -07001562func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001563 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001564 module.features = []feature{
1565 &tidyFeature{},
1566 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001567 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001568 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001569 module.coverage = &coverage{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001570 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001571 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001572 module.lto = &lto{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001573 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001574 return module
1575}
1576
Colin Crossce75d2c2016-10-06 16:12:58 -07001577func (c *Module) Prebuilt() *android.Prebuilt {
1578 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1579 return p.prebuilt()
1580 }
1581 return nil
1582}
1583
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001584func (c *Module) IsPrebuilt() bool {
1585 return c.Prebuilt() != nil
1586}
1587
Colin Crossce75d2c2016-10-06 16:12:58 -07001588func (c *Module) Name() string {
1589 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001590 if p, ok := c.linker.(interface {
1591 Name(string) string
1592 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001593 name = p.Name(name)
1594 }
1595 return name
1596}
1597
Alex Light3d673592019-01-18 14:37:31 -08001598func (c *Module) Symlinks() []string {
1599 if p, ok := c.installer.(interface {
1600 symlinkList() []string
1601 }); ok {
1602 return p.symlinkList()
1603 }
1604 return nil
1605}
1606
Roland Levillainf89cd092019-07-29 16:22:59 +01001607func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1608 test, ok := c.linker.(testPerSrc)
1609 return ok && test.isAllTestsVariation()
1610}
1611
Chris Parsons216e10a2020-07-09 17:12:52 -04001612func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001613 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001614 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001615 }); ok {
1616 return p.dataPaths()
1617 }
1618 return nil
1619}
1620
Justin Yun5f7f7e82019-11-18 19:52:14 +09001621func (c *Module) getNameSuffixWithVndkVersion(ctx android.ModuleContext) string {
1622 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1623 // "current", it will append the VNDK version to the name suffix.
1624 var vndkVersion string
1625 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001626 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001627 if c.ProductSpecific() {
1628 // If the module is product specific with 'product_specific: true',
1629 // do not add a name suffix because it is a base module.
1630 return ""
1631 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001632 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
1633 nameSuffix = productSuffix
1634 } else {
1635 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001636 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001637 }
1638 if vndkVersion == "current" {
1639 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1640 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001641 if c.Properties.VndkVersion != vndkVersion && c.Properties.VndkVersion != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001642 // add version suffix only if the module is using different vndk version than the
1643 // version in product or vendor partition.
1644 nameSuffix += "." + c.Properties.VndkVersion
1645 }
1646 return nameSuffix
1647}
1648
Chris Parsons8d6e4332021-02-22 16:13:50 -05001649func (c *Module) setSubnameProperty(actx android.ModuleContext) {
Inseob Kim64c43952019-08-26 16:52:35 +09001650 c.Properties.SubName = ""
1651
1652 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1653 c.Properties.SubName += nativeBridgeSuffix
1654 }
1655
Colin Cross127bb8b2020-12-16 16:46:01 -08001656 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001657 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001658 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1659 // added for product variant only when we have vendor and product variants with core
1660 // variant. The suffix is not added for vendor-only or product-only module.
1661 c.Properties.SubName += c.getNameSuffixWithVndkVersion(actx)
Colin Cross5271fea2021-04-27 13:06:04 -07001662 } else if c.IsVendorPublicLibrary() {
1663 c.Properties.SubName += vendorPublicLibrarySuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001664 } else if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
Inseob Kim64c43952019-08-26 16:52:35 +09001665 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1666 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001667 c.Properties.SubName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001668 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
1669 c.Properties.SubName += ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001670 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001671 c.Properties.SubName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001672 } else if c.InRecovery() && !c.OnlyInRecovery() {
Inseob Kim64c43952019-08-26 16:52:35 +09001673 c.Properties.SubName += recoverySuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001674 } else if c.IsSdkVariant() && (c.Properties.SdkAndPlatformVariantVisibleToMake || c.SplitPerApiLevel()) {
Colin Crossc511bc52020-04-07 16:50:32 +00001675 c.Properties.SubName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001676 if c.SplitPerApiLevel() {
1677 c.Properties.SubName += "." + c.SdkVersion()
1678 }
Inseob Kim64c43952019-08-26 16:52:35 +09001679 }
Chris Parsons8d6e4332021-02-22 16:13:50 -05001680}
1681
1682// Returns true if Bazel was successfully used for the analysis of this module.
1683func (c *Module) maybeGenerateBazelActions(actx android.ModuleContext) bool {
Liz Kammerbdc60992021-02-24 16:55:11 -05001684 bazelModuleLabel := c.GetBazelLabel(actx, c)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001685 bazelActionsUsed := false
Chris Parsonsbab4d7e2021-04-15 17:27:08 -04001686 if c.MixedBuildsEnabled(actx) && c.bazelHandler != nil {
Chris Parsons8d6e4332021-02-22 16:13:50 -05001687 bazelActionsUsed = c.bazelHandler.generateBazelBuildActions(actx, bazelModuleLabel)
1688 }
1689 return bazelActionsUsed
1690}
1691
1692func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1693 // TODO(cparsons): Any logic in this method occurring prior to querying Bazel should be
1694 // requested from Bazel instead.
1695
1696 // Handle the case of a test module split by `test_per_src` mutator.
1697 //
1698 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1699 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1700 // module and return early, as this module does not produce an output file per se.
1701 if c.IsTestPerSrcAllTestsVariation() {
1702 c.outputFile = android.OptionalPath{}
1703 return
1704 }
1705
1706 c.setSubnameProperty(actx)
1707 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1708 if !apexInfo.IsForPlatform() {
1709 c.hideApexVariantFromMake = true
1710 }
1711
Chris Parsonseefc9e62021-04-02 17:36:47 -04001712 c.makeLinkType = GetMakeLinkType(actx, c)
1713
Colin Crossca860ac2016-01-04 14:34:37 -08001714 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001715 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001716 moduleContextImpl: moduleContextImpl{
1717 mod: c,
1718 },
1719 }
1720 ctx.ctx = ctx
1721
Chris Parsons94a0bba2021-06-04 15:03:47 -04001722 if c.maybeGenerateBazelActions(actx) {
1723 c.maybeInstall(ctx, apexInfo)
1724 return
1725 }
1726
Colin Crossf18e1102017-11-16 14:33:08 -08001727 deps := c.depsToPaths(ctx)
1728 if ctx.Failed() {
1729 return
1730 }
1731
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001732 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1733 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
1734 }
1735
Colin Crossca860ac2016-01-04 14:34:37 -08001736 flags := Flags{
1737 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001738 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001739 }
Colin Crossca860ac2016-01-04 14:34:37 -08001740 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001741 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001742 }
1743 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001744 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001745 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001746 if c.stl != nil {
1747 flags = c.stl.flags(ctx, flags)
1748 }
Colin Cross16b23492016-01-06 14:41:07 -08001749 if c.sanitize != nil {
1750 flags = c.sanitize.flags(ctx, flags)
1751 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001752 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001753 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001754 }
Stephen Craneba090d12017-05-09 15:44:35 -07001755 if c.lto != nil {
1756 flags = c.lto.flags(ctx, flags)
1757 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001758 if c.pgo != nil {
1759 flags = c.pgo.flags(ctx, flags)
1760 }
Colin Crossca860ac2016-01-04 14:34:37 -08001761 for _, feature := range c.features {
1762 flags = feature.flags(ctx, flags)
1763 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001764 if ctx.Failed() {
1765 return
1766 }
1767
Colin Cross4af21ed2019-11-04 09:37:55 -08001768 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1769 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1770 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001771
Colin Cross4af21ed2019-11-04 09:37:55 -08001772 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001773
1774 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001775 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001776 }
1777 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001778 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09001779 }
1780
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001781 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07001782 // We need access to all the flags seen by a source file.
1783 if c.sabi != nil {
1784 flags = c.sabi.flags(ctx, flags)
1785 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07001786
Colin Cross4af21ed2019-11-04 09:37:55 -08001787 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07001788
Colin Crossca860ac2016-01-04 14:34:37 -08001789 // Optimization to reduce size of build.ninja
1790 // Replace the long list of flags for each file with a module-local variable
Colin Cross4af21ed2019-11-04 09:37:55 -08001791 ctx.Variable(pctx, "cflags", strings.Join(flags.Local.CFlags, " "))
1792 ctx.Variable(pctx, "cppflags", strings.Join(flags.Local.CppFlags, " "))
1793 ctx.Variable(pctx, "asflags", strings.Join(flags.Local.AsFlags, " "))
1794 flags.Local.CFlags = []string{"$cflags"}
1795 flags.Local.CppFlags = []string{"$cppflags"}
1796 flags.Local.AsFlags = []string{"$asflags"}
Colin Crossca860ac2016-01-04 14:34:37 -08001797
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001798 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08001799 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001800 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001801 if ctx.Failed() {
1802 return
1803 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001804 c.kytheFiles = objs.kytheFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08001805 }
1806
Colin Crossca860ac2016-01-04 14:34:37 -08001807 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001808 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08001809 if ctx.Failed() {
1810 return
1811 }
Colin Cross635c3b02016-05-18 15:37:25 -07001812 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09001813
Chris Parsons94a0bba2021-06-04 15:03:47 -04001814 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001815
Jose Galmes6f843bc2020-12-11 13:36:29 -08001816 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
1817 // RECOVERY_SNAPSHOT_VERSION is current.
1818 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001819 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001820 i.collectHeadersForSnapshot(ctx)
1821 }
1822 }
Colin Crossce75d2c2016-10-06 16:12:58 -07001823 }
Colin Cross5049f022015-03-18 13:28:46 -07001824
Chris Parsons94a0bba2021-06-04 15:03:47 -04001825 c.maybeInstall(ctx, apexInfo)
1826}
1827
1828func (c *Module) maybeUnhideFromMake() {
1829 // If a lib is directly included in any of the APEXes or is not available to the
1830 // platform (which is often the case when the stub is provided as a prebuilt),
1831 // unhide the stubs variant having the latest version gets visible to make. In
1832 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
1833 // force anything in the make world to link against the stubs library. (unless it
1834 // is explicitly referenced via .bootstrap suffix or the module is marked with
1835 // 'bootstrap: true').
1836 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
1837 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
1838 c.IsStubs() && !c.InVendorRamdisk() {
1839 c.Properties.HideFromMake = false // unhide
1840 // Note: this is still non-installable
1841 }
1842}
1843
1844func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001845 if !proptools.BoolDefault(c.Properties.Installable, true) {
1846 // If the module has been specifically configure to not be installed then
1847 // hide from make as otherwise it will break when running inside make
1848 // as the output path to install will not be specified. Not all uninstallable
1849 // modules can be hidden from make as some are needed for resolving make side
1850 // dependencies.
1851 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001852 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001853 c.SkipInstall()
1854 }
1855
1856 // Still call c.installer.install though, the installs will be stored as PackageSpecs
1857 // to allow using the outputs in a genrule.
1858 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07001859 c.installer.install(ctx, c.outputFile.Path())
1860 if ctx.Failed() {
1861 return
Colin Crossca860ac2016-01-04 14:34:37 -08001862 }
Dan Albertc403f7c2015-03-18 14:01:18 -07001863 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001864}
1865
Colin Cross0ea8ba82019-06-06 14:33:29 -07001866func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001867 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05001868 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08001869 }
Colin Crossca860ac2016-01-04 14:34:37 -08001870 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08001871}
1872
Colin Crossca860ac2016-01-04 14:34:37 -08001873func (c *Module) begin(ctx BaseModuleContext) {
1874 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001875 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07001876 }
Colin Crossca860ac2016-01-04 14:34:37 -08001877 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001878 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08001879 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001880 if c.stl != nil {
1881 c.stl.begin(ctx)
1882 }
Colin Cross16b23492016-01-06 14:41:07 -08001883 if c.sanitize != nil {
1884 c.sanitize.begin(ctx)
1885 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001886 if c.coverage != nil {
1887 c.coverage.begin(ctx)
1888 }
Stephen Craneba090d12017-05-09 15:44:35 -07001889 if c.lto != nil {
1890 c.lto.begin(ctx)
1891 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001892 if c.pgo != nil {
1893 c.pgo.begin(ctx)
1894 }
Dan Albert92fe7402020-07-15 13:33:30 -07001895 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07001896 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001897 if err != nil {
1898 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07001899 c.Properties.Sdk_version = nil
1900 } else {
1901 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001902 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07001903 }
Colin Crossca860ac2016-01-04 14:34:37 -08001904}
1905
Colin Cross37047f12016-12-13 17:06:13 -08001906func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07001907 deps := Deps{}
1908
1909 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001910 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001911 }
1912 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001913 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07001914 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001915 if c.stl != nil {
1916 deps = c.stl.deps(ctx, deps)
1917 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00001918 if c.coverage != nil {
1919 deps = c.coverage.deps(ctx, deps)
1920 }
Colin Crossc99deeb2016-04-11 15:06:20 -07001921
Colin Crossb6715442017-10-24 11:13:31 -07001922 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
1923 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
1924 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
1925 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1926 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
1927 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08001928 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07001929
Liz Kammer356f7d42021-01-26 09:18:53 -05001930 // In Bazel conversion mode, we dependency and build validations will occur in Bazel, so there is
1931 // no need to do so in Soong.
1932 if ctx.BazelConversionMode() {
1933 return deps
1934 }
1935
Dan Willemsen490a8dc2016-06-06 18:22:19 -07001936 for _, lib := range deps.ReexportSharedLibHeaders {
1937 if !inList(lib, deps.SharedLibs) {
1938 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
1939 }
1940 }
1941
1942 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00001943 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
1944 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 -07001945 }
1946 }
1947
Colin Cross5950f382016-12-13 12:50:57 -08001948 for _, lib := range deps.ReexportHeaderLibHeaders {
1949 if !inList(lib, deps.HeaderLibs) {
1950 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
1951 }
1952 }
1953
Dan Willemsenb3454ab2016-09-28 17:34:58 -07001954 for _, gen := range deps.ReexportGeneratedHeaders {
1955 if !inList(gen, deps.GeneratedHeaders) {
1956 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
1957 }
1958 }
1959
Colin Crossc99deeb2016-04-11 15:06:20 -07001960 return deps
1961}
1962
Dan Albert7e9d2952016-08-04 13:02:36 -07001963func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08001964 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07001965 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001966 moduleContextImpl: moduleContextImpl{
1967 mod: c,
1968 },
1969 }
1970 ctx.ctx = ctx
1971
Colin Crossca860ac2016-01-04 14:34:37 -08001972 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07001973}
1974
Jiyong Park7ed9de32018-10-15 22:25:07 +09001975// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09001976func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09001977 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
1978 version := name[sharp+1:]
1979 libname := name[:sharp]
1980 return libname, version
1981 }
1982 return name, ""
1983}
1984
Dan Albert92fe7402020-07-15 13:33:30 -07001985func GetCrtVariations(ctx android.BottomUpMutatorContext,
1986 m LinkableInterface) []blueprint.Variation {
1987 if ctx.Os() != android.Android {
1988 return nil
1989 }
1990 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001991 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
1992 minSdkVersion := m.MinSdkVersion()
1993 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
1994 minSdkVersion = m.SdkVersion()
1995 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09001996 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
1997 if err != nil {
1998 ctx.PropertyErrorf("min_sdk_version", err.Error())
1999 }
Dan Albert92fe7402020-07-15 13:33:30 -07002000 return []blueprint.Variation{
2001 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002002 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002003 }
2004 }
2005 return []blueprint.Variation{
2006 {Mutator: "sdk", Variation: ""},
2007 }
2008}
2009
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002010func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2011 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002012
2013 variations = append([]blueprint.Variation(nil), variations...)
2014
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002015 if version != "" && CanBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002016 // Version is explicitly specified. i.e. libFoo#30
2017 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002018 if tag, ok := depTag.(libraryDependencyTag); ok {
2019 tag.explicitlyVersioned = true
2020 } else {
2021 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2022 }
Colin Crosse7257d22020-09-24 09:56:18 -07002023 }
Colin Crosse7257d22020-09-24 09:56:18 -07002024
Colin Cross0de8a1e2020-09-18 14:15:30 -07002025 if far {
2026 ctx.AddFarVariationDependencies(variations, depTag, name)
2027 } else {
2028 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002029 }
2030}
2031
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002032func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
2033 // Only modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
2034 // SnapshotInfo, which provides no mappings.
2035 if *snapshotInfo == nil {
2036 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2037 // between the modules in the snapshot and the snapshot itself.
2038 var snapshotModule []blueprint.Module
2039 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2040 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2041 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2042 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2043 }
2044 if len(snapshotModule) > 0 {
2045 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2046 *snapshotInfo = &snapshot
2047 // republish the snapshot for use in later mutators on this module
2048 actx.SetProvider(SnapshotInfoProvider, snapshot)
2049 } else {
2050 *snapshotInfo = &SnapshotInfo{}
2051 }
2052 }
2053
2054 return **snapshotInfo
2055}
2056
2057func RewriteSnapshotLib(lib string, snapshotMap map[string]string) string {
2058 if snapshot, ok := snapshotMap[lib]; ok {
2059 return snapshot
2060 }
2061
2062 return lib
2063}
2064
2065// RewriteLibs takes a list of names of shared libraries and scans it for three types
2066// of names:
2067//
2068// 1. Name of an NDK library that refers to a prebuilt module.
2069// For each of these, it adds the name of the prebuilt module (which will be in
2070// prebuilts/ndk) to the list of nonvariant libs.
2071// 2. Name of an NDK library that refers to an ndk_library module.
2072// For each of these, it adds the name of the ndk_library module to the list of
2073// variant libs.
2074// 3. Anything else (so anything that isn't an NDK library).
2075// It adds these to the nonvariantLibs list.
2076//
2077// The caller can then know to add the variantLibs dependencies differently from the
2078// nonvariantLibs
2079func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2080 variantLibs = []string{}
2081
2082 nonvariantLibs = []string{}
2083 for _, entry := range list {
2084 // strip #version suffix out
2085 name, _ := StubsLibNameAndVersion(entry)
2086 if c.InRecovery() {
2087 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2088 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2089 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2090 } else if c.UseVndk() {
2091 nonvariantLibs = append(nonvariantLibs, RewriteSnapshotLib(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
2092 } else {
2093 // put name#version back
2094 nonvariantLibs = append(nonvariantLibs, entry)
2095 }
2096 }
2097 return nonvariantLibs, variantLibs
2098}
2099
Colin Cross1e676be2016-10-12 14:38:15 -07002100func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002101 if !c.Enabled() {
2102 return
2103 }
2104
Colin Cross37047f12016-12-13 17:06:13 -08002105 ctx := &depsContext{
2106 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002107 moduleContextImpl: moduleContextImpl{
2108 mod: c,
2109 },
2110 }
2111 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002112
Colin Crossc99deeb2016-04-11 15:06:20 -07002113 deps := c.deps(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002114
Yo Chiang219968c2020-09-22 18:45:04 +08002115 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2116
Colin Crosse0edaf92021-01-11 17:31:17 -08002117 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002118
Dan Albert914449f2016-06-17 16:45:24 -07002119 variantNdkLibs := []string{}
2120 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002121 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002122 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2123 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2124 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002125
2126 for idx, lib := range deps.RuntimeLibs {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002127 deps.RuntimeLibs[idx] = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002128 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002129 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002130
Colin Cross32ec36c2016-12-15 07:39:51 -08002131 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002132 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002133 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002134 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002135 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002136
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002137 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002138
Jiyong Park1ad8e162020-12-01 23:40:09 +09002139 if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002140 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002141 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002142 } else {
2143 actx.AddVariationDependencies(nil, depTag, lib)
2144 }
2145 }
2146
Dan Albertf1d14c72020-07-30 14:32:55 -07002147 if c.isNDKStubLibrary() {
2148 // NDK stubs depend on their implementation because the ABI dumps are
2149 // generated from the implementation library.
2150 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2151 c.ImageVariation(),
2152 blueprint.Variation{Mutator: "link", Variation: "shared"},
2153 ), stubImplementation, c.BaseModuleName())
2154 }
2155
Inseob Kim07def122020-11-23 14:43:02 +09002156 // sysprop_library has to support both C++ and Java. So sysprop_library internally creates one
2157 // C++ implementation library and one Java implementation library. When a module links against
2158 // sysprop_library, the C++ implementation library has to be linked. syspropImplLibraries is a
2159 // map from sysprop_library to implementation library; it will be used in whole_static_libs,
2160 // static_libs, and shared_libs.
Inseob Kimc0907f12019-02-08 21:00:45 +09002161 syspropImplLibraries := syspropImplLibraries(actx.Config())
2162
Jiyong Park5d1598f2019-02-25 22:14:17 +09002163 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002164 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Jiyong Park5d1598f2019-02-25 22:14:17 +09002165 if impl, ok := syspropImplLibraries[lib]; ok {
2166 lib = impl
2167 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002168
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002169 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002170
Jiyong Park5d1598f2019-02-25 22:14:17 +09002171 actx.AddVariationDependencies([]blueprint.Variation{
2172 {Mutator: "link", Variation: "static"},
2173 }, depTag, lib)
2174 }
2175
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002176 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002177 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002178 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002179 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002180 }
Jiyong Parke3867542020-12-03 17:28:25 +09002181 if inList(lib, deps.ExcludeLibsForApex) {
2182 depTag.excludeInApex = true
2183 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002184
2185 if impl, ok := syspropImplLibraries[lib]; ok {
2186 lib = impl
2187 }
2188
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002189 lib = RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002190
Dan Willemsen59339a22018-07-22 21:18:45 -07002191 actx.AddVariationDependencies([]blueprint.Variation{
2192 {Mutator: "link", Variation: "static"},
2193 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002194 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002195
Jooyung Han75568392020-03-20 04:29:24 +09002196 // staticUnwinderDep is treated as staticDep for Q apexes
2197 // so that native libraries/binaries are linked with static unwinder
2198 // because Q libc doesn't have unwinder APIs
2199 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002200 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002201 actx.AddVariationDependencies([]blueprint.Variation{
2202 {Mutator: "link", Variation: "static"},
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002203 }, depTag, RewriteSnapshotLib(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002204 }
2205
Jiyong Park7ed9de32018-10-15 22:25:07 +09002206 // shared lib names without the #version suffix
2207 var sharedLibNames []string
2208
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002209 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002210 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002211 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002212 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002213 }
Jiyong Parke3867542020-12-03 17:28:25 +09002214 if inList(lib, deps.ExcludeLibsForApex) {
2215 depTag.excludeInApex = true
2216 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002217
2218 if impl, ok := syspropImplLibraries[lib]; ok {
2219 lib = impl
2220 }
2221
Jiyong Park73c54ee2019-10-22 20:31:18 +09002222 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002223 sharedLibNames = append(sharedLibNames, name)
2224
Colin Crosse7257d22020-09-24 09:56:18 -07002225 variations := []blueprint.Variation{
2226 {Mutator: "link", Variation: "shared"},
2227 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002228 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002229 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002230
Colin Crossfe9acfe2021-06-14 16:13:03 -07002231 for _, lib := range deps.LateStaticLibs {
2232 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2233 actx.AddVariationDependencies([]blueprint.Variation{
2234 {Mutator: "link", Variation: "static"},
2235 }, depTag, RewriteSnapshotLib(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
2236 }
2237
Jiyong Park7ed9de32018-10-15 22:25:07 +09002238 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002239 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002240 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2241 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2242 // linking against both the stubs lib and the non-stubs lib at the same time.
2243 continue
2244 }
Colin Cross6e511a92020-07-27 21:26:48 -07002245 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002246 variations := []blueprint.Variation{
2247 {Mutator: "link", Variation: "shared"},
2248 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002249 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002250 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002251
Dan Willemsen59339a22018-07-22 21:18:45 -07002252 actx.AddVariationDependencies([]blueprint.Variation{
2253 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002254 }, dataLibDepTag, deps.DataLibs...)
2255
2256 actx.AddVariationDependencies([]blueprint.Variation{
2257 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002258 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002259
Colin Cross68861832016-07-08 10:41:41 -07002260 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002261
2262 for _, gen := range deps.GeneratedHeaders {
2263 depTag := genHeaderDepTag
2264 if inList(gen, deps.ReexportGeneratedHeaders) {
2265 depTag = genHeaderExportDepTag
2266 }
2267 actx.AddDependency(c, depTag, gen)
2268 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002269
Dan Albert92fe7402020-07-15 13:33:30 -07002270 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002271 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002272 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002273 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002274 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002275 }
Colin Crossc465efd2021-06-11 18:00:04 -07002276 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002277 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Colin Crossc465efd2021-06-11 18:00:04 -07002278 RewriteSnapshotLib(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002279 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002280 if deps.DynamicLinker != "" {
2281 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002282 }
Dan Albert914449f2016-06-17 16:45:24 -07002283
2284 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002285
2286 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002287 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002288 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002289 {Mutator: "link", Variation: "shared"},
2290 }, ndkStubDepTag, variantNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002291
2292 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002293 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002294 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002295 {Mutator: "link", Variation: "shared"},
2296 }, ndkLateStubDepTag, variantLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002297
2298 if vndkdep := c.vndkdep; vndkdep != nil {
2299 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002300 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002301 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002302 {Mutator: "link", Variation: "shared"},
2303 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002304 }
2305 }
Colin Cross6362e272015-10-29 15:25:03 -07002306}
Colin Cross21b9a242015-03-24 14:15:58 -07002307
Colin Crosse40b4ea2018-10-02 22:25:58 -07002308func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002309 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2310 c.beginMutator(ctx)
2311 }
2312}
2313
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002314// Whether a module can link to another module, taking into
2315// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002316func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002317 tag blueprint.DependencyTag) {
2318
2319 switch t := tag.(type) {
2320 case dependencyTag:
2321 if t != vndkExtDepTag {
2322 return
2323 }
2324 case libraryDependencyTag:
2325 default:
2326 return
2327 }
2328
Ivan Lozanof9e21722020-12-02 09:00:51 -05002329 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002330 // Host code is not restricted
2331 return
2332 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002333
2334 // VNDK is cc.Module supported only for now.
2335 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002336 // Though allowed dependency is limited by the image mutator,
2337 // each vendor and product module needs to check link-type
2338 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002339 if ccTo, ok := to.(*Module); ok {
2340 if ccFrom.vndkdep != nil {
2341 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2342 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002343 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002344 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002345 }
2346 return
2347 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002348 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002349 // Platform code can link to anything
2350 return
2351 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002352 if from.InRamdisk() {
2353 // Ramdisk code is not NDK
2354 return
2355 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002356 if from.InVendorRamdisk() {
2357 // Vendor ramdisk code is not NDK
2358 return
2359 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002360 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002361 // Recovery code is not NDK
2362 return
2363 }
Colin Cross31076b32020-10-23 17:22:06 -07002364 if c, ok := to.(*Module); ok {
2365 if c.ToolchainLibrary() {
2366 // These are always allowed
2367 return
2368 }
2369 if c.NdkPrebuiltStl() {
2370 // These are allowed, but they don't set sdk_version
2371 return
2372 }
2373 if c.StubDecorator() {
2374 // These aren't real libraries, but are the stub shared libraries that are included in
2375 // the NDK.
2376 return
2377 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002378 }
Logan Chien834b9a62019-01-14 15:39:03 +08002379
Ivan Lozano52767be2019-10-18 14:49:46 -07002380 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002381 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2382 // to link to libc++ (non-NDK and without sdk_version).
2383 return
2384 }
2385
Ivan Lozano52767be2019-10-18 14:49:46 -07002386 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002387 // NDK code linking to platform code is never okay.
2388 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002389 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002390 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002391 }
2392
2393 // At this point we know we have two NDK libraries, but we need to
2394 // check that we're not linking against anything built against a higher
2395 // API level, as it is only valid to link against older or equivalent
2396 // APIs.
2397
Inseob Kim01a28722018-04-11 09:48:45 +09002398 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002399 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002400 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002401 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002402 // Current can't be linked against by anything else.
2403 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002404 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002405 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002406 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002407 if err != nil {
2408 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002409 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002410 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002411 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002412 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002413 if err != nil {
2414 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002415 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002416 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002417 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002418
Inseob Kim01a28722018-04-11 09:48:45 +09002419 if toApi > fromApi {
2420 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002421 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002422 }
2423 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002424 }
Dan Albert202fe492017-12-15 13:56:59 -08002425
2426 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002427 fromStl := from.SelectedStl()
2428 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002429 if fromStl == "" || toStl == "" {
2430 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002431 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002432 // We can be permissive with the system "STL" since it is only the C++
2433 // ABI layer, but in the future we should make sure that everyone is
2434 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002435 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002436 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002437 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2438 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002439 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002440}
2441
Jooyung Han479ca172020-10-19 18:51:07 +09002442func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2443 if c, ok := ctx.Module().(*Module); ok {
2444 ctx.VisitDirectDeps(func(dep android.Module) {
2445 depTag := ctx.OtherModuleDependencyTag(dep)
2446 ccDep, ok := dep.(LinkableInterface)
2447 if ok {
2448 checkLinkType(ctx, c, ccDep, depTag)
2449 }
2450 })
2451 }
2452}
2453
Jiyong Park5fb8c102018-04-09 12:03:06 +09002454// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002455// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2456// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002457// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002458func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2459 check := func(child, parent android.Module) bool {
2460 to, ok := child.(*Module)
2461 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002462 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002463 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002464
Jooyung Hana70f0672019-01-18 15:20:43 +09002465 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2466 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002467 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002468
Jiyong Park0474e1f2021-01-14 14:26:06 +09002469 // These dependencies are not excercised at runtime. Tracking these will give us
2470 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002471 depTag := ctx.OtherModuleDependencyTag(child)
2472 if IsHeaderDepTag(depTag) {
2473 return false
2474 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002475 if depTag == staticVariantTag {
2476 return false
2477 }
2478 if depTag == stubImplDepTag {
2479 return false
2480 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002481
Justin Yun63e9ec72020-10-29 16:49:43 +09002482 // Even if target lib has no vendor variant, keep checking dependency
2483 // graph in case it depends on vendor_available or product_available
2484 // but not double_loadable transtively.
2485 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002486 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002487 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002488
Jiyong Park0474e1f2021-01-14 14:26:06 +09002489 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2490 // one.
2491 if Bool(to.VendorProperties.Double_loadable) {
2492 return true
2493 }
2494
Ivan Lozanod7586b62021-04-01 09:49:36 -04002495 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002496 return false
2497 }
2498
Jooyung Hana70f0672019-01-18 15:20:43 +09002499 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2500 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002501 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002502 return false
2503 }
2504 if module, ok := ctx.Module().(*Module); ok {
2505 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002506 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002507 ctx.WalkDeps(check)
2508 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002509 }
2510 }
2511}
2512
Colin Crossc99deeb2016-04-11 15:06:20 -07002513// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002514func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002515 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002516
Colin Cross0de8a1e2020-09-18 14:15:30 -07002517 var directStaticDeps []StaticLibraryInfo
2518 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002519
Colin Cross0de8a1e2020-09-18 14:15:30 -07002520 reexportExporter := func(exporter FlagExporterInfo) {
2521 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2522 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2523 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2524 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2525 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002526 }
2527
Jooyung Hande34d232020-07-23 13:04:15 +09002528 // For the dependency from platform to apex, use the latest stubs
2529 c.apexSdkVersion = android.FutureApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07002530 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2531 if !apexInfo.IsForPlatform() {
Jiyong Park4eab21d2021-04-15 15:17:54 +09002532 c.apexSdkVersion = apexInfo.MinSdkVersion
Jooyung Hande34d232020-07-23 13:04:15 +09002533 }
2534
2535 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2536 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2537 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2538 // (b/144430859)
2539 c.apexSdkVersion = android.FutureApiLevel
2540 }
2541
Colin Crossd11fcda2017-10-23 17:59:01 -07002542 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002543 depName := ctx.OtherModuleName(dep)
2544 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002545
Ivan Lozano52767be2019-10-18 14:49:46 -07002546 ccDep, ok := dep.(LinkableInterface)
2547 if !ok {
2548
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002549 // handling for a few module types that aren't cc Module but that are also supported
2550 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002551 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002552 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002553 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2554 genRule.GeneratedSourceFiles()...)
2555 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002556 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002557 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002558 // Support exported headers from a generated_sources dependency
2559 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002560 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002561 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002562 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002563 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002564 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002565 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002566 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002567 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002568 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2569 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002570 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002571 // 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 +09002572 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002573
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002574 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002575 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002576 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002577 }
Colin Crosscef792e2021-06-11 18:01:26 -07002578 case CrtBeginDepTag:
2579 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2580 case CrtEndDepTag:
2581 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002582 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002583 return
2584 }
2585
Colin Crossfe17f6f2019-03-28 19:30:56 -07002586 if depTag == android.ProtoPluginDepTag {
2587 return
2588 }
2589
Colin Crossd11fcda2017-10-23 17:59:01 -07002590 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002591 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2592 return
2593 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002594 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002595 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2596 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002597 return
2598 }
2599
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002600 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002601 // Skip reused objects for stub libraries, they use their own stub object file instead.
2602 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2603 // version mutator, so the stubs variant is created from the shared variant that
2604 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002605 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002606 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2607 objs := staticAnalogue.ReuseObjects
2608 depPaths.Objs = depPaths.Objs.Append(objs)
2609 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2610 reexportExporter(depExporterInfo)
2611 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002612 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002613 }
2614
Colin Cross6e511a92020-07-27 21:26:48 -07002615 linkFile := ccDep.OutputFile()
2616
2617 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2618 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002619 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002620 return
2621 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002622
Jiyong Parke3867542020-12-03 17:28:25 +09002623 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2624 return
2625 }
2626
Colin Cross0de8a1e2020-09-18 14:15:30 -07002627 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002628
Colin Cross6e511a92020-07-27 21:26:48 -07002629 var ptr *android.Paths
2630 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002631
Colin Cross6e511a92020-07-27 21:26:48 -07002632 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002633
Colin Cross6e511a92020-07-27 21:26:48 -07002634 switch {
2635 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08002636 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
2637 if !ctx.Config().AllowMissingDependencies() {
2638 ctx.ModuleErrorf("module %q is not a header library", depName)
2639 } else {
2640 ctx.AddMissingDependencies([]string{depName})
2641 }
2642 return
2643 }
Colin Cross6e511a92020-07-27 21:26:48 -07002644 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002645 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
2646 if !ctx.Config().AllowMissingDependencies() {
2647 ctx.ModuleErrorf("module %q is not a shared library", depName)
2648 } else {
2649 ctx.AddMissingDependencies([]string{depName})
2650 }
2651 return
2652 }
Jiyong Parke3867542020-12-03 17:28:25 +09002653
Jiyong Park7d55b612021-06-11 17:22:09 +09002654 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
2655 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07002656
Jiyong Park1ad8e162020-12-01 23:40:09 +09002657 // Stubs lib doesn't link to the shared lib dependencies. Don't set
2658 // linkFile, depFile, and ptr.
2659 if c.IsStubs() {
2660 break
2661 }
2662
Colin Cross0de8a1e2020-09-18 14:15:30 -07002663 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
2664 depFile = sharedLibraryInfo.TableOfContents
2665
Colin Cross6e511a92020-07-27 21:26:48 -07002666 ptr = &depPaths.SharedLibs
2667 switch libDepTag.Order {
2668 case earlyLibraryDependency:
2669 ptr = &depPaths.EarlySharedLibs
2670 depPtr = &depPaths.EarlySharedLibsDeps
2671 case normalLibraryDependency:
2672 ptr = &depPaths.SharedLibs
2673 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07002674 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002675 case lateLibraryDependency:
2676 ptr = &depPaths.LateSharedLibs
2677 depPtr = &depPaths.LateSharedLibsDeps
2678 default:
2679 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07002680 }
Colin Cross6e511a92020-07-27 21:26:48 -07002681 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07002682 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
2683 if !ctx.Config().AllowMissingDependencies() {
2684 ctx.ModuleErrorf("module %q is not a static library", depName)
2685 } else {
2686 ctx.AddMissingDependencies([]string{depName})
2687 }
2688 return
2689 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002690
2691 // Stubs lib doesn't link to the static lib dependencies. Don't set
2692 // linkFile, depFile, and ptr.
2693 if c.IsStubs() {
2694 break
2695 }
2696
Colin Cross0de8a1e2020-09-18 14:15:30 -07002697 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2698 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07002699 if libDepTag.wholeStatic {
2700 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07002701 if len(staticLibraryInfo.Objects.objFiles) > 0 {
2702 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09002703 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07002704 // This case normally catches prebuilt static
2705 // libraries, but it can also occur when
2706 // AllowMissingDependencies is on and the
2707 // dependencies has no sources of its own
2708 // but has a whole_static_libs dependency
2709 // on a missing library. We want to depend
2710 // on the .a file so that there is something
2711 // in the dependency tree that contains the
2712 // error rule for the missing transitive
2713 // dependency.
2714 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002715 }
Colin Cross6e511a92020-07-27 21:26:48 -07002716 } else {
2717 switch libDepTag.Order {
2718 case earlyLibraryDependency:
2719 panic(fmt.Errorf("early static libs not suppported"))
2720 case normalLibraryDependency:
2721 // static dependencies will be handled separately so they can be ordered
2722 // using transitive dependencies.
2723 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07002724 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07002725 case lateLibraryDependency:
2726 ptr = &depPaths.LateStaticLibs
2727 default:
2728 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09002729 }
2730 }
2731 }
2732
Colin Cross6e511a92020-07-27 21:26:48 -07002733 if libDepTag.static() && !libDepTag.wholeStatic {
2734 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
2735 ctx.ModuleErrorf("module %q not a static library", depName)
2736 return
2737 }
Logan Chien43d34c32017-12-20 01:17:32 +08002738
Colin Cross6e511a92020-07-27 21:26:48 -07002739 // When combining coverage files for shared libraries and executables, coverage files
2740 // in static libraries act as if they were whole static libraries. The same goes for
2741 // source based Abi dump files.
2742 if c, ok := ccDep.(*Module); ok {
2743 staticLib := c.linker.(libraryInterface)
2744 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
2745 staticLib.objs().coverageFiles...)
2746 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
2747 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002748 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07002749 // Handle non-CC modules here
2750 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07002751 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09002752 }
2753 }
2754
Colin Cross6e511a92020-07-27 21:26:48 -07002755 if ptr != nil {
2756 if !linkFile.Valid() {
2757 if !ctx.Config().AllowMissingDependencies() {
2758 ctx.ModuleErrorf("module %q missing output file", depName)
2759 } else {
2760 ctx.AddMissingDependencies([]string{depName})
2761 }
2762 return
2763 }
2764 *ptr = append(*ptr, linkFile.Path())
2765 }
2766
2767 if depPtr != nil {
2768 dep := depFile
2769 if !dep.Valid() {
2770 dep = linkFile
2771 }
2772 *depPtr = append(*depPtr, dep.Path())
2773 }
2774
Colin Cross0de8a1e2020-09-18 14:15:30 -07002775 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
2776 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
2777 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
2778 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
2779
2780 if libDepTag.reexportFlags {
2781 reexportExporter(depExporterInfo)
2782 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
2783 // Re-exported shared library headers must be included as well since they can help us with type information
2784 // about template instantiations (instantiated from their headers).
2785 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
2786 // scripts.
2787 c.sabi.Properties.ReexportedIncludes = append(
2788 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
2789 }
2790
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002791 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07002792 switch {
2793 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07002794 c.Properties.AndroidMkHeaderLibs = append(
2795 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07002796 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07002797 if lib := moduleLibraryInterface(dep); lib != nil {
2798 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07002799 // Add the dependency to the APEX(es) providing the library so that
2800 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07002801 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09002802 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07002803 c.Properties.ApexesProvidingSharedLibs = append(
2804 c.Properties.ApexesProvidingSharedLibs, an)
2805 }
2806 }
2807 }
2808
2809 // Note: the order of libs in this list is not important because
2810 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07002811 c.Properties.AndroidMkSharedLibs = append(
2812 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002813 // Record BaseLibName for snapshots.
2814 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002815 case libDepTag.static():
2816 if libDepTag.wholeStatic {
2817 c.Properties.AndroidMkWholeStaticLibs = append(
2818 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
2819 } else {
2820 c.Properties.AndroidMkStaticLibs = append(
2821 c.Properties.AndroidMkStaticLibs, makeLibName)
2822 }
Justin Yun5e035862021-06-29 20:50:37 +09002823 // Record BaseLibName for snapshots.
2824 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002825 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002826 } else if !c.IsStubs() {
2827 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
2828
Colin Cross6e511a92020-07-27 21:26:48 -07002829 switch depTag {
2830 case runtimeDepTag:
2831 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002832 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002833 // Record BaseLibName for snapshots.
2834 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07002835 case objDepTag:
2836 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
2837 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002838 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002839 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07002840 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07002841 case dynamicLinkerDepTag:
2842 depPaths.DynamicLinker = linkFile
2843 }
Jiyong Park27b188b2017-07-18 13:23:39 +09002844 }
Colin Crossca860ac2016-01-04 14:34:37 -08002845 })
2846
Jeff Gaston294356f2017-09-27 17:05:30 -07002847 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07002848 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
2849 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
2850 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07002851
Colin Crossdd84e052017-05-17 13:44:16 -07002852 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07002853 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09002854 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
2855 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09002856 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09002857 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
2858 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07002859 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09002860 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09002861 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002862
2863 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09002864 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07002865 }
Colin Crossdd84e052017-05-17 13:44:16 -07002866
Colin Crossca860ac2016-01-04 14:34:37 -08002867 return depPaths
2868}
2869
Jiyong Park7d55b612021-06-11 17:22:09 +09002870// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
2871// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
2872// dependency. The stub variant is selected when the dependency crosses a boundary where each side
2873// has different level of updatability. For example, if a library foo in an APEX depends on a
2874// library bar which provides stable interface and exists in the platform, foo uses the stub variant
2875// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
2876// same APEX as foo, the non-stub variant of bar is used.
2877func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
2878 depName := ctx.OtherModuleName(dep)
2879 depTag := ctx.OtherModuleDependencyTag(dep)
2880 libDepTag, ok := depTag.(libraryDependencyTag)
2881 if !ok || !libDepTag.shared() {
2882 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2883 }
2884
2885 thisModule, ok := ctx.Module().(android.ApexModule)
2886 if !ok {
2887 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
2888 }
2889
2890 useVndk := false
2891 bootstrap := false
2892 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
2893 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
2894 } else {
2895 useVndk = linkable.UseVndk()
2896 bootstrap = linkable.Bootstrap()
2897 }
2898
2899 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
2900 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2901 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
2902 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2903
2904 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
2905 useStubs := false
2906
2907 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
2908 if !apexInfo.IsForPlatform() {
2909 // For platform libraries, use current version of LLNDK
2910 // If this is for use_vendor apex we will apply the same rules
2911 // of apex sdk enforcement below to choose right version.
2912 useStubs = true
2913 }
Jiyong Park9477c262021-06-22 20:23:05 +09002914 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
2915 // If not building for APEX or the containing APEX allows the use of
2916 // platform APIs, use stubs only when it is from an APEX (and not from
2917 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
2918 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09002919 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
2920 if useStubs {
2921 // Another exception: if this module is a test for an APEX, then
2922 // it is linked with the non-stub variant of a module in the APEX
2923 // as if this is part of the APEX.
2924 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
2925 for _, apexContents := range testFor.ApexContents {
2926 if apexContents.DirectlyInApex(depName) {
2927 useStubs = false
2928 break
2929 }
2930 }
2931 }
2932 if useStubs {
2933 // Yet another exception: If this module and the dependency are
2934 // available to the same APEXes then skip stubs between their
2935 // platform variants. This complements the test_for case above,
2936 // which avoids the stubs on a direct APEX library dependency, by
2937 // avoiding stubs for indirect test dependencies as well.
2938 //
2939 // TODO(b/183882457): This doesn't work if the two libraries have
2940 // only partially overlapping apex_available. For that test_for
2941 // modules would need to be split into APEX variants and resolved
2942 // separately for each APEX they have access to.
2943 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
2944 useStubs = false
2945 }
2946 }
2947 } else {
2948 // If building for APEX, use stubs when the parent is in any APEX that
2949 // the child is not in.
2950 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
2951 }
2952
2953 // when to use (unspecified) stubs, use the latest one.
2954 if useStubs {
2955 stubs := sharedLibraryStubsInfo.SharedStubLibraries
2956 toUse := stubs[len(stubs)-1]
2957 sharedLibraryInfo = toUse.SharedLibraryInfo
2958 depExporterInfo = toUse.FlagExporterInfo
2959 }
2960 }
2961 return sharedLibraryInfo, depExporterInfo
2962}
2963
Colin Cross0de8a1e2020-09-18 14:15:30 -07002964// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
2965// to match the topological order of the dependency tree, including any static analogues of
2966// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
2967// of the transitive dependencies.
2968func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
2969 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
2970 var staticPaths android.Paths
2971 for _, staticDep := range staticDeps {
2972 staticPaths = append(staticPaths, staticDep.StaticLibrary)
2973 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
2974 }
2975 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04002976 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
2977 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07002978 }
2979 }
2980 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
2981
2982 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
2983
2984 // reorder the dependencies based on transitive dependencies
2985 staticPaths = android.FirstUniquePaths(staticPaths)
2986 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
2987
2988 if len(orderedStaticPaths) != len(staticPaths) {
2989 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
2990 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
2991 }
2992
2993 return orderedStaticPaths, transitiveStaticLibs
2994}
2995
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002996// BaseLibName trims known prefixes and suffixes
2997func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07002998 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
2999 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003000 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003001 return libName
3002}
3003
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003004func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003005 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003006 ccDepModule, _ := ccDep.(*Module)
3007 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003008 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003009
Justin Yuncbca3732021-02-03 19:24:13 +09003010 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003011 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07003012 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003013 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003014 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003015
Ivan Lozanod1dec542021-05-26 15:33:11 -04003016 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003017 }
3018 }
3019
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003020 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3021 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003022 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3023 // core module instead.
3024 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003025 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003026 // The vendor and product modules in Make will have been renamed to not conflict with the
3027 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003028 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003029 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
3030 return libName + ramdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003031 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003032 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003033 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
3034 return libName + recoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003035 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Colin Cross6e511a92020-07-27 21:26:48 -07003036 return libName + nativeBridgeSuffix
3037 } else {
3038 return libName
3039 }
3040}
3041
Colin Crossca860ac2016-01-04 14:34:37 -08003042func (c *Module) InstallInData() bool {
3043 if c.installer == nil {
3044 return false
3045 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003046 return c.installer.inData()
3047}
3048
3049func (c *Module) InstallInSanitizerDir() bool {
3050 if c.installer == nil {
3051 return false
3052 }
3053 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003054 return true
3055 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003056 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003057}
3058
Yifan Hong1b3348d2020-01-21 15:53:22 -08003059func (c *Module) InstallInRamdisk() bool {
3060 return c.InRamdisk()
3061}
3062
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003063func (c *Module) InstallInVendorRamdisk() bool {
3064 return c.InVendorRamdisk()
3065}
3066
Jiyong Parkf9332f12018-02-01 00:54:12 +09003067func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003068 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003069}
3070
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003071func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003072 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003073 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003074 return
3075 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003076 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003077}
3078
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003079func (c *Module) HostToolPath() android.OptionalPath {
3080 if c.installer == nil {
3081 return android.OptionalPath{}
3082 }
3083 return c.installer.hostToolPath()
3084}
3085
Nan Zhangd4e641b2017-07-12 12:55:28 -07003086func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3087 return c.outputFile
3088}
3089
Colin Cross41955e82019-05-29 14:40:35 -07003090func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3091 switch tag {
3092 case "":
3093 if c.outputFile.Valid() {
3094 return android.Paths{c.outputFile.Path()}, nil
3095 }
3096 return android.Paths{}, nil
3097 default:
3098 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003099 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003100}
3101
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003102func (c *Module) static() bool {
3103 if static, ok := c.linker.(interface {
3104 static() bool
3105 }); ok {
3106 return static.static()
3107 }
3108 return false
3109}
3110
Jiyong Park379de2f2018-12-19 02:47:14 +09003111func (c *Module) staticBinary() bool {
3112 if static, ok := c.linker.(interface {
3113 staticBinary() bool
3114 }); ok {
3115 return static.staticBinary()
3116 }
3117 return false
3118}
3119
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003120func (c *Module) testBinary() bool {
3121 if test, ok := c.linker.(interface {
3122 testBinary() bool
3123 }); ok {
3124 return test.testBinary()
3125 }
3126 return false
3127}
3128
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003129// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3130func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003131 if h, ok := c.linker.(interface {
3132 header() bool
3133 }); ok {
3134 return h.header()
3135 }
3136 return false
3137}
3138
Ivan Lozanod7586b62021-04-01 09:49:36 -04003139func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003140 if b, ok := c.linker.(interface {
3141 binary() bool
3142 }); ok {
3143 return b.binary()
3144 }
3145 return false
3146}
3147
Justin Yun5e035862021-06-29 20:50:37 +09003148func (c *Module) StaticExecutable() bool {
3149 if b, ok := c.linker.(*binaryDecorator); ok {
3150 return b.static()
3151 }
3152 return false
3153}
3154
Ivan Lozanod7586b62021-04-01 09:49:36 -04003155func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003156 if o, ok := c.linker.(interface {
3157 object() bool
3158 }); ok {
3159 return o.object()
3160 }
3161 return false
3162}
3163
Ivan Lozanof9e21722020-12-02 09:00:51 -05003164func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003165 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003166 if c.IsLlndk() {
3167 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003168 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003169 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003170 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003171 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003172 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003173 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003174 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003175 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003176 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003177 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003178 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003179 return "native:product"
3180 }
Jooyung Han38002912019-05-16 04:01:54 +09003181 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003182 } else if c.InRamdisk() {
3183 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003184 } else if c.InVendorRamdisk() {
3185 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003186 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003187 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003188 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003189 return "native:ndk:none:none"
3190 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3191 //family, link := getNdkStlFamilyAndLinkType(c)
3192 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003193 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003194 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003195 } else {
3196 return "native:platform"
3197 }
3198}
3199
Jiyong Park9d452992018-10-03 00:38:19 +09003200// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003201// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003202func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003203 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003204 // Stub libs and prebuilt libs in a versioned SDK are not
3205 // installable to APEX even though they are shared libs.
Colin Cross31076b32020-10-23 17:22:06 -07003206 return lib.shared() && !lib.buildStubs() && c.ContainingSdk().Unversioned()
Roland Levillainf89cd092019-07-29 16:22:59 +01003207 } else if _, ok := c.linker.(testPerSrc); ok {
3208 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003209 }
3210 return false
3211}
3212
Jiyong Parka90ca002019-10-07 15:47:24 +09003213func (c *Module) AvailableFor(what string) bool {
3214 if linker, ok := c.linker.(interface {
3215 availableFor(string) bool
3216 }); ok {
3217 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3218 } else {
3219 return c.ApexModuleBase.AvailableFor(what)
3220 }
3221}
3222
Jiyong Park62304bb2020-04-13 16:19:48 +09003223func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003224 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003225}
3226
Colin Crossaede88c2020-08-11 12:17:01 -07003227func (c *Module) UniqueApexVariations() bool {
3228 if u, ok := c.compiler.(interface {
3229 uniqueApexVariations() bool
3230 }); ok {
3231 return u.uniqueApexVariations()
3232 } else {
3233 return false
3234 }
3235}
3236
Paul Duffin0cb37b92020-03-04 14:52:46 +00003237func (c *Module) EverInstallable() bool {
3238 return c.installer != nil &&
3239 // Check to see whether the module is actually ever installable.
3240 c.installer.everInstallable()
3241}
3242
Ivan Lozanod7586b62021-04-01 09:49:36 -04003243func (c *Module) PreventInstall() bool {
3244 return c.Properties.PreventInstall
3245}
3246
3247func (c *Module) Installable() *bool {
3248 return c.Properties.Installable
3249}
3250
3251func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003252 ret := c.EverInstallable() &&
3253 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003254 proptools.BoolDefault(c.Installable(), true) &&
3255 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003256
3257 // The platform variant doesn't need further condition. Apex variants however might not
3258 // be installable because it will likely to be included in the APEX and won't appear
3259 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003260 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003261 return ret
3262 }
3263
3264 // Special case for modules that are configured to be installed to /data, which includes
3265 // test modules. For these modules, both APEX and non-APEX variants are considered as
3266 // installable. This is because even the APEX variants won't be included in the APEX, but
3267 // will anyway be installed to /data/*.
3268 // See b/146995717
3269 if c.InstallInData() {
3270 return ret
3271 }
3272
3273 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003274}
3275
Logan Chien41eabe62019-04-10 13:33:58 +08003276func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3277 if c.linker != nil {
3278 if library, ok := c.linker.(*libraryDecorator); ok {
3279 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3280 }
3281 }
3282}
3283
Jiyong Park45bf82e2020-12-15 22:29:02 +09003284var _ android.ApexModule = (*Module)(nil)
3285
3286// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003287func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003288 depTag := ctx.OtherModuleDependencyTag(dep)
3289 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3290
3291 if cc, ok := dep.(*Module); ok {
3292 if cc.HasStubsVariants() {
3293 if isLibDepTag && libDepTag.shared() {
3294 // dynamic dep to a stubs lib crosses APEX boundary
3295 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003296 }
Colin Cross6e511a92020-07-27 21:26:48 -07003297 if IsRuntimeDepTag(depTag) {
3298 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003299 return false
3300 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003301 }
Zhijun Heec285872021-04-24 10:47:08 -07003302 if cc.IsLlndk() {
3303 return false
3304 }
Colin Crossaac32222020-07-29 12:51:56 -07003305 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003306 // shared_lib dependency from a static lib is considered as crossing
3307 // the APEX boundary because the dependency doesn't actually is
3308 // linked; the dependency is used only during the compilation phase.
3309 return false
3310 }
Jiyong Parke3867542020-12-03 17:28:25 +09003311
3312 if isLibDepTag && libDepTag.excludeInApex {
3313 return false
3314 }
Colin Cross6e511a92020-07-27 21:26:48 -07003315 }
Colin Crossc1b36442021-05-06 13:42:48 -07003316 if depTag == stubImplDepTag {
3317 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003318 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003319 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003320 if depTag == staticVariantTag {
3321 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3322 // actually mean that the static lib (and its dependencies) are copied into the
3323 // APEX.
3324 return false
3325 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003326 return true
3327}
3328
Jiyong Park45bf82e2020-12-15 22:29:02 +09003329// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003330func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3331 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003332 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3333 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3334 return nil
3335 }
3336 // b/154569636: set min_sdk_version correctly for toolchain_libraries
3337 if c.ToolchainLibrary() {
3338 return nil
3339 }
3340 // We don't check for prebuilt modules
3341 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3342 return nil
3343 }
3344 minSdkVersion := c.MinSdkVersion()
3345 if minSdkVersion == "apex_inherit" {
3346 return nil
3347 }
3348 if minSdkVersion == "" {
3349 // JNI libs within APK-in-APEX fall into here
3350 // Those are okay to set sdk_version instead
3351 // We don't have to check if this is a SDK variant because
3352 // non-SDK variant resets sdk_version, which works too.
3353 minSdkVersion = c.SdkVersion()
3354 }
Dan Albertc8060532020-07-22 22:32:17 -07003355 if minSdkVersion == "" {
3356 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3357 }
3358 // Not using nativeApiLevelFromUser because the context here is not
3359 // necessarily a native context.
3360 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003361 if err != nil {
3362 return err
3363 }
Dan Albertc8060532020-07-22 22:32:17 -07003364
3365 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003366 return fmt.Errorf("newer SDK(%v)", ver)
3367 }
3368 return nil
3369}
3370
Paul Duffinb5769c12021-05-12 16:16:51 +01003371// Implements android.ApexModule
3372func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3373 // stub libraries and native bridge libraries are always available to platform
3374 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3375}
3376
Colin Cross2ba19d92015-05-07 15:44:20 -07003377//
Colin Crosscfad1192015-11-02 16:43:11 -08003378// Defaults
3379//
Colin Crossca860ac2016-01-04 14:34:37 -08003380type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003381 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003382 android.DefaultsModuleBase
Liz Kammer3cf52112021-03-31 15:42:03 -04003383 // Included to support setting bazel_module.label for multiple Soong modules to the same Bazel
3384 // target. This is primarily useful for modules that were architecture specific and instead are
3385 // handled in Bazel as a select().
3386 android.BazelModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003387 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003388}
3389
Patrice Arrudac249c712019-03-19 17:00:29 -07003390// cc_defaults provides a set of properties that can be inherited by other cc
3391// modules. A module can use the properties from a cc_defaults using
3392// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3393// merged (when possible) by prepending the default module's values to the
3394// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003395func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003396 return DefaultsFactory()
3397}
3398
Colin Cross36242852017-06-23 15:06:31 -07003399func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003400 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003401
Colin Cross36242852017-06-23 15:06:31 -07003402 module.AddProperties(props...)
3403 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003404 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003405 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003406 &BaseCompilerProperties{},
3407 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003408 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003409 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003410 &StaticProperties{},
3411 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003412 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003413 &BinaryLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003414 &TestProperties{},
3415 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003416 &BenchmarkProperties{},
Mitch Phillips4e4ab8a2019-09-13 17:32:50 -07003417 &FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003418 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003419 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003420 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003421 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003422 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003423 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003424 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003425 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003426 &LTOProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003427 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003428 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003429 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3430 &RustBindgenClangProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003431 )
Colin Crosscfad1192015-11-02 16:43:11 -08003432
Liz Kammer3cf52112021-03-31 15:42:03 -04003433 // Bazel module must be initialized _before_ Defaults to be included in cc_defaults module.
3434 android.InitBazelModule(module)
Jooyung Hancc372c52019-09-25 15:18:44 +09003435 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003436
3437 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003438}
3439
Jiyong Park2286afd2020-06-16 21:58:53 +09003440func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003441 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003442}
3443
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003444func kytheExtractAllFactory() android.Singleton {
3445 return &kytheExtractAllSingleton{}
3446}
3447
3448type kytheExtractAllSingleton struct {
3449}
3450
3451func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3452 var xrefTargets android.Paths
3453 ctx.VisitAllModules(func(module android.Module) {
3454 if ccModule, ok := module.(xref); ok {
3455 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3456 }
3457 })
3458 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3459 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003460 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003461 }
3462}
3463
Colin Cross06a931b2015-10-28 17:23:31 -07003464var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003465var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003466var BoolPtr = proptools.BoolPtr
3467var String = proptools.String
3468var StringPtr = proptools.StringPtr