blob: c07d836a681f5e2803ff5e384ffd591c3384b504 [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"
Sam Delmerico5fb794a2023-01-27 16:01:37 -050031 "android/soong/bazel/cquery"
Colin Crossb98c8b02016-07-29 13:44:28 -070032 "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070033 "android/soong/fuzz"
Colin Cross5049f022015-03-18 13:28:46 -070034 "android/soong/genrule"
Kiyoung Kim487689e2022-07-26 09:48:22 +090035 "android/soong/multitree"
Rob Seymour925aa092021-08-10 20:42:03 +000036 "android/soong/snapshot"
Colin Cross3f40fa42015-01-30 17:27:36 -080037)
38
Colin Cross463a90e2015-06-17 14:20:06 -070039func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000040 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070041
Paul Duffin036e7002019-12-19 19:16:28 +000042 pctx.Import("android/soong/cc/config")
43}
44
45func RegisterCCBuildComponents(ctx android.RegistrationContext) {
46 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
47
48 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000049 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090050 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070051 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010052 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070053 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070054 ctx.BottomUp("begin", BeginMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070055 })
Colin Cross16b23492016-01-06 14:41:07 -080056
Paul Duffin036e7002019-12-19 19:16:28 +000057 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040058 for _, san := range Sanitizers {
59 san.registerMutators(ctx)
60 }
Dan Willemsen581341d2017-02-09 16:16:31 -080061
Colin Cross0b908332019-06-19 23:00:20 -070062 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090063 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080064
Cory Barkera1da26f2022-06-07 20:12:06 +000065 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000066
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080067 ctx.BottomUp("coverage", coverageMutator).Parallel()
Stephen Craneba090d12017-05-09 15:44:35 -070068
Yi Kongeb8efc92021-12-09 18:06:29 +080069 ctx.TopDown("afdo_deps", afdoDepsMutator)
70 ctx.BottomUp("afdo", afdoMutator).Parallel()
71
Stephen Craneba090d12017-05-09 15:44:35 -070072 ctx.TopDown("lto_deps", ltoDepsMutator)
73 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090074
Jooyung Han479ca172020-10-19 18:51:07 +090075 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090076 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070077 })
Colin Crossb98c8b02016-07-29 13:44:28 -070078
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080079 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
80 // sabi mutator needs to be run after apex mutator finishes.
81 ctx.TopDown("sabi_deps", sabiDepsMutator)
82 })
83
Colin Cross57898582020-10-29 18:25:19 -070084 ctx.RegisterSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070085}
86
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050087// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
88// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
89// edges to these modules.
90// This object is constructed in DepsMutator, by calling to various module delegates to set
91// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
92// dependencies.
93// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
94// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080095type Deps struct {
96 SharedLibs, LateSharedLibs []string
97 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080098 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +080099 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700100
Colin Cross3e5e7782022-06-17 22:17:05 +0000101 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
102 // prevent automatically exporting symbols.
103 UnexportedStaticLibs []string
104
Chris Parsons79d66a52020-06-05 17:26:16 -0400105 // Used for data dependencies adjacent to tests
106 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700107 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400108
Yo Chiang219968c2020-09-22 18:45:04 +0800109 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
110 SystemSharedLibs []string
111
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500112 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800113 StaticUnwinderIfLegacy bool
114
Colin Cross5950f382016-12-13 12:50:57 -0800115 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700116
Colin Cross81413472016-04-11 14:37:39 -0700117 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700118
Dan Willemsenb40aab62016-04-20 14:21:14 -0700119 GeneratedSources []string
120 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900121 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700122
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700123 ReexportGeneratedHeaders []string
124
Colin Crossc465efd2021-06-11 18:00:04 -0700125 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700126
127 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700128 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900129
130 // List of libs that need to be excluded for APEX variant
131 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700132}
133
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500134// PathDeps is a struct containing file paths to dependencies of a module.
135// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
136// It's used to construct flags for various build statements (such as for compiling and linking).
137// It is then passed to module decorator functions responsible for registering build statements
138// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800139type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700140 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900141 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700142 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900143 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700144 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700145 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700146
Colin Cross0de8a1e2020-09-18 14:15:30 -0700147 // Transitive static library dependencies of static libraries for use in ordering.
148 TranstiveStaticLibrariesForOrdering *android.DepSet
149
Colin Cross26c34ed2016-09-30 17:10:16 -0700150 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100151 Objs Objects
152 // Paths to .o files in dependencies that provide them. Note that these lists
153 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800154 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700155 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700156
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100157 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
158 // the libs from all whole_static_lib dependencies.
159 WholeStaticLibsFromPrebuilts android.Paths
160
Colin Cross26c34ed2016-09-30 17:10:16 -0700161 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700162 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900163 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700164
Inseob Kimd110f872019-12-06 13:15:38 +0900165 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000166 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900167 IncludeDirs android.Paths
168 SystemIncludeDirs android.Paths
169 ReexportedDirs android.Paths
170 ReexportedSystemDirs android.Paths
171 ReexportedFlags []string
172 ReexportedGeneratedHeaders android.Paths
173 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700174
Colin Cross26c34ed2016-09-30 17:10:16 -0700175 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700176 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700177
Dan Willemsena0790e32018-10-12 00:24:23 -0700178 // Path to the dynamic linker binary
179 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700180
181 // For Darwin builds, the path to the second architecture's output that should
182 // be combined with this architectures's output into a FAT MachO file.
183 DarwinSecondArchOutput android.OptionalPath
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700184}
185
Colin Cross4af21ed2019-11-04 09:37:55 -0800186// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
187// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
188// command line so they can be overridden by the local module flags).
189type LocalOrGlobalFlags struct {
190 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700191 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800192 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700193 CFlags []string // Flags that apply to C and C++ source files
194 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
195 ConlyFlags []string // Flags that apply to C source files
196 CppFlags []string // Flags that apply to C++ source files
197 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700198 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800199}
200
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500201// Flags contains various types of command line flags (and settings) for use in building build
202// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800203type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500204 // Local flags (which individual modules are responsible for). These may override global flags.
205 Local LocalOrGlobalFlags
206 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800207 Global LocalOrGlobalFlags
208
209 aidlFlags []string // Flags that apply to aidl source files
210 rsFlags []string // Flags that apply to renderscript source files
211 libFlags []string // Flags to add libraries early to the link order
212 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
213 TidyFlags []string // Flags that apply to clang-tidy
214 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700215
Colin Crossc3199482017-03-30 15:03:04 -0700216 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800217 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700218 SystemIncludeFlags []string
219
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800220 Toolchain config.Toolchain
221 Tidy bool // True if ninja .tidy rules should be generated.
222 NeedTidyFiles bool // True if module link should depend on .tidy files
223 GcovCoverage bool // True if coverage files should be generated.
224 SAbiDump bool // True if header abi dumps should be generated.
225 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800226
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500227 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800228 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500229 // The target-device system path to the dynamic linker.
230 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800231
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700232 CFlagsDeps android.Paths // Files depended on by compiler flags
233 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800234
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500235 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700236 AssemblerWithCpp 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
Colin Cross1bc94122021-10-28 13:25:54 -0700343 Installable *bool `android:"arch_variant"`
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"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800373
374 Target struct {
375 Platform struct {
376 // List of modules required by the core variant.
377 Required []string `android:"arch_variant"`
378
379 // List of modules not required by the core variant.
380 Exclude_required []string `android:"arch_variant"`
381 } `android:"arch_variant"`
382
383 Recovery struct {
384 // List of modules required by the recovery variant.
385 Required []string `android:"arch_variant"`
386
387 // List of modules not required by the recovery variant.
388 Exclude_required []string `android:"arch_variant"`
389 } `android:"arch_variant"`
390 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700391}
392
393type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900394 // whether this module should be allowed to be directly depended by other
395 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900396 // If set to true, two variants will be built separately, one like
397 // normal, and the other limited to the set of libraries and headers
398 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700399 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900400 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700401 // so it shouldn't have any unversioned runtime dependencies, or
402 // make assumptions about the system that may not be true in the
403 // future.
404 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900405 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900406 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900407 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900408 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900409 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700410 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
411 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900412
Justin Yunebcf0c52021-01-08 18:00:19 +0900413 // This is the same as the "vendor_available" except that the install path
414 // of the vendor variant is /odm or /vendor/odm.
415 // By replacing "vendor_available: true" with "odm_available: true", the
416 // module will install its vendor variant to the /odm partition or /vendor/odm.
417 // As the modules with "odm_available: true" still create the vendor variants,
418 // they can link to the other vendor modules as the vendor_available modules do.
419 // Also, the vendor modules can link to odm_available modules.
420 //
421 // It may not be used for VNDK modules.
422 Odm_available *bool
423
Justin Yun63e9ec72020-10-29 16:49:43 +0900424 // whether this module should be allowed to be directly depended by other
425 // modules with `product_specific: true` or `product_available: true`.
426 // If set to true, an additional product variant will be built separately
427 // that is limited to the set of libraries and headers that are exposed to
428 // /product modules.
429 //
430 // The product variant may be used with a different (newer) /system,
431 // so it shouldn't have any unversioned runtime dependencies, or
432 // make assumptions about the system that may not be true in the
433 // future.
434 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900435 // If set to false, this module becomes inaccessible from /product modules.
436 //
437 // Different from the 'vendor_available' property, the modules with
438 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
439 // library without 'product_available' may not be depended on by any other
440 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900441 //
442 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
443 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
444 Product_available *bool
445
Jiyong Park5fb8c102018-04-09 12:03:06 +0900446 // whether this module is capable of being loaded with other instance
447 // (possibly an older version) of the same module in the same process.
448 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
449 // can be double loaded in a vendor process if the library is also a
450 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
451 // explicitly marked as `double_loadable: true` by the owner, or the dependency
452 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
453 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800454
455 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
456 IsLLNDK bool `blueprint:"mutated"`
457
Colin Cross78212242021-01-06 14:51:30 -0800458 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
459 // set and the module is not listed in VndkMustUseVendorVariantList.
460 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
461
462 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
463 IsVNDKCore bool `blueprint:"mutated"`
464
465 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
466 IsVNDKSP bool `blueprint:"mutated"`
467
468 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
469 // module sets the llndk.private property.
470 IsVNDKPrivate bool `blueprint:"mutated"`
471
472 // IsVNDKProduct is set if a VNDK module sets the product_available property.
473 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700474
475 // IsVendorPublicLibrary is set for the core and product variants of a library that has
476 // vendor_public_library stubs.
477 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800478}
479
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500480// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
481// to understanding details about the type of the current module.
482// For example, one might call these functions to determine whether the current module is a static
483// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800484type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800485 static() bool
486 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700487 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800488 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900489 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900490 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900491 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700492 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900493 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700494 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800495 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900496 minSdkVersion() string
497 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700498 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700499 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800500 IsLlndk() bool
501 IsLlndkPublic() bool
502 isImplementationForLLNDKPublic() bool
503 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900504 isVndk() bool
505 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500506 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700507 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900508 inProduct() bool
509 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800510 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700511 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900512 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700513 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700514 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800515 getVndkExtendsModuleName() string
Yi Kong4ef54592022-02-14 20:00:10 +0800516 isAfdoCompile() bool
Yi Kong7e53c572018-02-14 18:16:12 +0800517 isPgoCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800518 isCfi() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800519 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800520 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800521 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700522 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700523 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900524 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800525 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700526 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700527 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800528 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800529 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800530 getSharedFlags() *SharedFlags
531}
532
533type SharedFlags struct {
534 numSharedFlags int
535 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800536}
537
538type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700539 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800540 ModuleContextIntf
541}
542
543type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700544 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800545 ModuleContextIntf
546}
547
Colin Cross37047f12016-12-13 17:06:13 -0800548type DepsContext interface {
549 android.BottomUpMutatorContext
550 ModuleContextIntf
551}
552
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500553// feature represents additional (optional) steps to building cc-related modules, such as invocation
554// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800555type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800556 flags(ctx ModuleContext, flags Flags) Flags
557 props() []interface{}
558}
559
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500560// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500561// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800562type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700563 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800564 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800565 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700566 compilerProps() []interface{}
567
Colin Cross76fada02016-07-27 10:31:13 -0700568 appendCflags([]string)
569 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700570 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800571}
572
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500573// linker is the interface for a linker decorator object. Individual module types can provide
574// their own implementation for this decorator, and thus specify custom logic regarding build
575// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800576type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700577 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800578 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700579 linkerFlags(ctx ModuleContext, flags Flags) Flags
580 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800581 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700582
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700583 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700584 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900585 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700586
587 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900588 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000589
590 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000591 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
592}
593
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500594// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000595type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500596 sharedLibs []string
597 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
598 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700599 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800600}
601
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500602// installer is the interface for an installer helper object. This helper is responsible for
603// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800604type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700605 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700606 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000607 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800608 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700609 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700610 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900611 relativeInstallPath() string
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +0100612 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900613 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800614}
615
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800616type xref interface {
617 XrefCcFiles() android.Paths
618}
619
Inseob Kima1888ce2022-10-04 14:42:02 +0900620type overridable interface {
621 overriddenModules() []string
622}
623
Colin Cross6e511a92020-07-27 21:26:48 -0700624type libraryDependencyKind int
625
626const (
627 headerLibraryDependency = iota
628 sharedLibraryDependency
629 staticLibraryDependency
630)
631
632func (k libraryDependencyKind) String() string {
633 switch k {
634 case headerLibraryDependency:
635 return "headerLibraryDependency"
636 case sharedLibraryDependency:
637 return "sharedLibraryDependency"
638 case staticLibraryDependency:
639 return "staticLibraryDependency"
640 default:
641 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
642 }
643}
644
645type libraryDependencyOrder int
646
647const (
648 earlyLibraryDependency = -1
649 normalLibraryDependency = 0
650 lateLibraryDependency = 1
651)
652
653func (o libraryDependencyOrder) String() string {
654 switch o {
655 case earlyLibraryDependency:
656 return "earlyLibraryDependency"
657 case normalLibraryDependency:
658 return "normalLibraryDependency"
659 case lateLibraryDependency:
660 return "lateLibraryDependency"
661 default:
662 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
663 }
664}
665
666// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
667// tags that have a set of predefined tag objects that are reused for each dependency, a
668// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
669// That means that comparing a libraryDependencyTag for equality will only be equal if all
670// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
671// then check individual metadata fields instead.
672type libraryDependencyTag struct {
673 blueprint.BaseDependencyTag
674
675 // These are exported so that fmt.Printf("%#v") can call their String methods.
676 Kind libraryDependencyKind
677 Order libraryDependencyOrder
678
679 wholeStatic bool
680
681 reexportFlags bool
682 explicitlyVersioned bool
683 dataLib bool
684 ndk bool
685
686 staticUnwinder bool
687
688 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900689
Cindy Zhou18417cb2020-12-10 07:12:38 -0800690 // Whether or not this dependency should skip the apex dependency check
691 skipApexAllowedDependenciesCheck bool
692
Jiyong Parke3867542020-12-03 17:28:25 +0900693 // Whether or not this dependency has to be followed for the apex variants
694 excludeInApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000695
696 // If true, don't automatically export symbols from the static library into a shared library.
697 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700698}
699
700// header returns true if the libraryDependencyTag is tagging a header lib dependency.
701func (d libraryDependencyTag) header() bool {
702 return d.Kind == headerLibraryDependency
703}
704
705// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
706func (d libraryDependencyTag) shared() bool {
707 return d.Kind == sharedLibraryDependency
708}
709
710// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
711func (d libraryDependencyTag) static() bool {
712 return d.Kind == staticLibraryDependency
713}
714
Colin Cross65cb3142021-12-10 23:05:02 +0000715func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
716 if d.shared() {
717 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
718 }
719 return nil
720}
721
722var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
723
Colin Crosse9fe2942020-11-10 18:12:15 -0800724// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
725// binaries or other shared libraries are installed as dependencies.
726func (d libraryDependencyTag) InstallDepNeeded() bool {
727 return d.shared()
728}
729
730var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
731
732// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700733// libraryDependencyTag. Each tag object is created globally and reused for multiple
734// dependencies (although since the object contains no references, assigning a tag to a
735// variable and modifying it will not modify the original). Users can compare the tag
736// returned by ctx.OtherModuleDependencyTag against the global original
737type dependencyTag struct {
738 blueprint.BaseDependencyTag
739 name string
740}
741
Colin Crosse9fe2942020-11-10 18:12:15 -0800742// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
743// libraryDependencyTag, but where the dependency needs to be installed when the parent is
744// installed.
745type installDependencyTag struct {
746 blueprint.BaseDependencyTag
747 android.InstallAlwaysNeededDependencyTag
748 name string
749}
750
Colin Crossc99deeb2016-04-11 15:06:20 -0700751var (
Colin Cross6e511a92020-07-27 21:26:48 -0700752 genSourceDepTag = dependencyTag{name: "gen source"}
753 genHeaderDepTag = dependencyTag{name: "gen header"}
754 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
755 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900756 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700757 reuseObjTag = dependencyTag{name: "reuse objects"}
758 staticVariantTag = dependencyTag{name: "static variant"}
759 vndkExtDepTag = dependencyTag{name: "vndk extends"}
760 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700761 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800762 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700763 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700764 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000765 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700766)
767
Roland Levillainf89cd092019-07-29 16:22:59 +0100768func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700769 ccLibDepTag, ok := depTag.(libraryDependencyTag)
770 return ok && ccLibDepTag.shared()
771}
772
773func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
774 ccLibDepTag, ok := depTag.(libraryDependencyTag)
775 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100776}
777
Zach Johnson3df4e632020-11-06 11:56:27 -0800778func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
779 ccLibDepTag, ok := depTag.(libraryDependencyTag)
780 return ok && ccLibDepTag.header()
781}
782
Roland Levillainf89cd092019-07-29 16:22:59 +0100783func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800784 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100785}
786
787func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700788 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100789 return ok && ccDepTag == testPerSrcDepTag
790}
791
Chris Parsonsf874e462022-05-10 13:50:12 -0400792// bazelHandler is the interface for a helper object related to deferring to Bazel for
793// processing a cc module (during Bazel mixed builds). Individual module types should define
794// their own bazel handler if they support being handled by Bazel.
795type BazelHandler interface {
796 // QueueBazelCall invokes request-queueing functions on the BazelContext
797 //so that these requests are handled when Bazel's cquery is invoked.
798 QueueBazelCall(ctx android.BaseModuleContext, label string)
799
800 // ProcessBazelQueryResponse uses information retrieved from Bazel to set properties
801 // on the current module with given label.
802 ProcessBazelQueryResponse(ctx android.ModuleContext, label string)
803}
804
Colin Crossca860ac2016-01-04 14:34:37 -0800805// Module contains the properties and members used by all C/C++ module types, and implements
806// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500807// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
808// interface.
809//
810// To define a C/C++ related module, construct a new Module object and point its delegates to
811// type-specific structs. These delegates will be invoked to register module-specific build
812// statements which may be unique to the module type. For example, module.compiler.compile() should
813// be defined so as to register build statements which are responsible for compiling the module.
814//
815// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
816// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
817// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
818// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800819type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700820 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700821
Liz Kammerea6666f2021-02-17 10:17:28 -0500822 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700823
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700824 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700825 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700826
Colin Crossca860ac2016-01-04 14:34:37 -0800827 // initialize before calling Init
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400828 hod android.HostOrDeviceSupported
829 multilib android.Multilib
830 bazelable bool
Colin Crossc472d572015-03-17 15:06:21 -0700831
Paul Duffina0843f62019-12-13 19:50:38 +0000832 // Allowable SdkMemberTypes of this module type.
833 sdkMemberTypes []android.SdkMemberType
834
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500835 // decorator delegates, initialize before calling Init
836 // these may contain module-specific implementations, and effectively allow for custom
837 // type-specific logic. These members may reference different objects or the same object.
838 // Functions of these decorators will be invoked to initialize and register type-specific
839 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500840 compiler compiler
841 linker linker
842 installer installer
Chris Parsonsf874e462022-05-10 13:50:12 -0400843 bazelHandler BazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500844
845 features []feature
846 stl *stl
847 sanitize *sanitize
848 coverage *coverage
Cory Barkera1da26f2022-06-07 20:12:06 +0000849 fuzzer *fuzzer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500850 sabi *sabi
851 vndkdep *vndkdep
852 lto *lto
Yi Kongeb8efc92021-12-09 18:06:29 +0800853 afdo *afdo
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500854 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800855
Colin Cross31076b32020-10-23 17:22:06 -0700856 library libraryInterface
857
Colin Cross635c3b02016-05-18 15:37:25 -0700858 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800859
Colin Crossb98c8b02016-07-29 13:44:28 -0700860 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700861
862 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800863
864 // Flags used to compile this module
865 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700866
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800867 // Shared flags among build rules of this module
868 sharedFlags SharedFlags
869
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800870 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700871 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900872
873 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800874 // Kythe (source file indexer) paths for this compilation module
875 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700876 // Object .o file output paths for this compilation module
877 objFiles android.Paths
878 // Tidy .tidy file output paths for this compilation module
879 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900880
881 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700882 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700883
884 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700885}
886
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200887func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400888 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
889 if b, ok := c.compiler.(*baseCompiler); ok {
890 hasAidl = b.hasSrcExt(".aidl")
891 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
892 hasProto = b.hasSrcExt(".proto")
893 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
894 hasSysprop = b.hasSrcExt(".sysprop")
895 hasWinMsg = b.hasSrcExt(".mc")
896 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
897 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200898 c.AndroidModuleBase().AddJSONData(d)
899 (*d)["Cc"] = map[string]interface{}{
900 "SdkVersion": c.SdkVersion(),
901 "MinSdkVersion": c.MinSdkVersion(),
902 "VndkVersion": c.VndkVersion(),
903 "ProductSpecific": c.ProductSpecific(),
904 "SocSpecific": c.SocSpecific(),
905 "DeviceSpecific": c.DeviceSpecific(),
906 "InProduct": c.InProduct(),
907 "InVendor": c.InVendor(),
908 "InRamdisk": c.InRamdisk(),
909 "InVendorRamdisk": c.InVendorRamdisk(),
910 "InRecovery": c.InRecovery(),
911 "VendorAvailable": c.VendorAvailable(),
912 "ProductAvailable": c.ProductAvailable(),
913 "RamdiskAvailable": c.RamdiskAvailable(),
914 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
915 "RecoveryAvailable": c.RecoveryAvailable(),
916 "OdmAvailable": c.OdmAvailable(),
917 "InstallInData": c.InstallInData(),
918 "InstallInRamdisk": c.InstallInRamdisk(),
919 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
920 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
921 "InstallInRecovery": c.InstallInRecovery(),
922 "InstallInRoot": c.InstallInRoot(),
923 "IsVndk": c.IsVndk(),
924 "IsVndkExt": c.IsVndkExt(),
925 "IsVndkPrivate": c.IsVndkPrivate(),
926 "IsVndkSp": c.IsVndkSp(),
927 "IsLlndk": c.IsLlndk(),
928 "IsLlndkPublic": c.IsLlndkPublic(),
929 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
930 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
931 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
932 "ApexSdkVersion": c.apexSdkVersion,
933 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400934 "AidlSrcs": hasAidl,
935 "LexSrcs": hasLex,
936 "ProtoSrcs": hasProto,
937 "RenderscriptSrcs": hasRenderscript,
938 "SyspropSrcs": hasSysprop,
939 "WinMsgSrcs": hasWinMsg,
940 "YaccSrsc": hasYacc,
941 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200942 }
943}
944
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500945func (c *Module) SetPreventInstall() {
946 c.Properties.PreventInstall = true
947}
948
949func (c *Module) SetHideFromMake() {
950 c.Properties.HideFromMake = true
951}
952
Ivan Lozanod7586b62021-04-01 09:49:36 -0400953func (c *Module) HiddenFromMake() bool {
954 return c.Properties.HideFromMake
955}
956
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800957func (c *Module) RequiredModuleNames() []string {
958 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
959 if c.ImageVariation().Variation == android.CoreVariation {
960 required = append(required, c.Properties.Target.Platform.Required...)
961 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
962 } else if c.InRecovery() {
963 required = append(required, c.Properties.Target.Recovery.Required...)
964 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
965 }
966 return android.FirstUniqueStrings(required)
967}
968
Ivan Lozano52767be2019-10-18 14:49:46 -0700969func (c *Module) Toc() android.OptionalPath {
970 if c.linker != nil {
971 if library, ok := c.linker.(libraryInterface); ok {
972 return library.toc()
973 }
974 }
975 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
976}
977
978func (c *Module) ApiLevel() string {
979 if c.linker != nil {
980 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700981 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700982 }
983 }
984 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
985}
986
987func (c *Module) Static() bool {
988 if c.linker != nil {
989 if library, ok := c.linker.(libraryInterface); ok {
990 return library.static()
991 }
992 }
993 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
994}
995
996func (c *Module) Shared() bool {
997 if c.linker != nil {
998 if library, ok := c.linker.(libraryInterface); ok {
999 return library.shared()
1000 }
1001 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001002
Ivan Lozano52767be2019-10-18 14:49:46 -07001003 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1004}
1005
1006func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001007 if c.stl != nil {
1008 return c.stl.Properties.SelectedStl
1009 }
1010 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001011}
1012
Ivan Lozano52767be2019-10-18 14:49:46 -07001013func (c *Module) NdkPrebuiltStl() bool {
1014 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1015 return true
1016 }
1017 return false
1018}
1019
1020func (c *Module) StubDecorator() bool {
1021 if _, ok := c.linker.(*stubDecorator); ok {
1022 return true
1023 }
1024 return false
1025}
1026
1027func (c *Module) SdkVersion() string {
1028 return String(c.Properties.Sdk_version)
1029}
1030
Artur Satayev480e25b2020-04-27 18:53:18 +01001031func (c *Module) MinSdkVersion() string {
1032 return String(c.Properties.Min_sdk_version)
1033}
1034
Jiyong Park5df7bd32021-08-25 16:18:46 +09001035func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001036 if linker, ok := c.linker.(*objectLinker); ok {
1037 return linker.isCrt()
1038 }
1039 return false
1040}
1041
Jiyong Park5df7bd32021-08-25 16:18:46 +09001042func (c *Module) SplitPerApiLevel() bool {
1043 return c.canUseSdk() && c.isCrt()
1044}
1045
Colin Crossc511bc52020-04-07 16:50:32 +00001046func (c *Module) AlwaysSdk() bool {
1047 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1048}
1049
Ivan Lozano183a3212019-10-18 14:18:45 -07001050func (c *Module) CcLibrary() bool {
1051 if c.linker != nil {
1052 if _, ok := c.linker.(*libraryDecorator); ok {
1053 return true
1054 }
Colin Crossd48fe732020-09-23 20:37:24 -07001055 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1056 return true
1057 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001058 }
1059 return false
1060}
1061
1062func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001063 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001064 return true
1065 }
1066 return false
1067}
1068
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001069func (c *Module) IsFuzzModule() bool {
1070 if _, ok := c.compiler.(*fuzzBinary); ok {
1071 return true
1072 }
1073 return false
1074}
1075
1076func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1077 return c.FuzzModule
1078}
1079
1080func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1081 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1082 return fuzzer.fuzzPackagedModule
1083 }
1084 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1085}
1086
1087func (c *Module) FuzzSharedLibraries() android.Paths {
1088 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1089 return fuzzer.sharedLibraries
1090 }
1091 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1092}
1093
Ivan Lozano2b262972019-11-21 12:30:50 -08001094func (c *Module) NonCcVariants() bool {
1095 return false
1096}
1097
Ivan Lozano183a3212019-10-18 14:18:45 -07001098func (c *Module) SetStatic() {
1099 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001100 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001101 library.setStatic()
1102 return
1103 }
1104 }
1105 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1106}
1107
1108func (c *Module) SetShared() {
1109 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001110 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001111 library.setShared()
1112 return
1113 }
1114 }
1115 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1116}
1117
1118func (c *Module) BuildStaticVariant() bool {
1119 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001120 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001121 return library.buildStatic()
1122 }
1123 }
1124 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1125}
1126
1127func (c *Module) BuildSharedVariant() bool {
1128 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001129 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001130 return library.buildShared()
1131 }
1132 }
1133 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1134}
1135
1136func (c *Module) Module() android.Module {
1137 return c
1138}
1139
Jiyong Parkc20eee32018-09-05 22:36:17 +09001140func (c *Module) OutputFile() android.OptionalPath {
1141 return c.outputFile
1142}
1143
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001144func (c *Module) CoverageFiles() android.Paths {
1145 if c.linker != nil {
1146 if library, ok := c.linker.(libraryInterface); ok {
1147 return library.objs().coverageFiles
1148 }
1149 }
1150 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1151}
1152
Ivan Lozano183a3212019-10-18 14:18:45 -07001153var _ LinkableInterface = (*Module)(nil)
1154
Jiyong Park719b4462019-01-13 00:39:51 +09001155func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001156 if c.linker != nil {
1157 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001158 }
1159 return nil
1160}
1161
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001162func (c *Module) CoverageOutputFile() android.OptionalPath {
1163 if c.linker != nil {
1164 return c.linker.coverageOutputFilePath()
1165 }
1166 return android.OptionalPath{}
1167}
1168
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001169func (c *Module) RelativeInstallPath() string {
1170 if c.installer != nil {
1171 return c.installer.relativeInstallPath()
1172 }
1173 return ""
1174}
1175
Jooyung Han344d5432019-08-23 11:17:39 +09001176func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001177 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001178}
1179
Colin Cross36242852017-06-23 15:06:31 -07001180func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001181 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001182 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001183 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001184 }
1185 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001186 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001187 }
1188 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001189 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001190 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001191 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001192 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001193 }
Colin Cross16b23492016-01-06 14:41:07 -08001194 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001195 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001196 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001197 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001198 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001199 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001200 if c.fuzzer != nil {
1201 c.AddProperties(c.fuzzer.props()...)
1202 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001203 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001204 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001205 }
Justin Yun8effde42017-06-23 19:24:43 +09001206 if c.vndkdep != nil {
1207 c.AddProperties(c.vndkdep.props()...)
1208 }
Stephen Craneba090d12017-05-09 15:44:35 -07001209 if c.lto != nil {
1210 c.AddProperties(c.lto.props()...)
1211 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001212 if c.afdo != nil {
1213 c.AddProperties(c.afdo.props()...)
1214 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001215 if c.pgo != nil {
1216 c.AddProperties(c.pgo.props()...)
1217 }
Colin Crossca860ac2016-01-04 14:34:37 -08001218 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001219 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001220 }
Colin Crossc472d572015-03-17 15:06:21 -07001221
Colin Cross36242852017-06-23 15:06:31 -07001222 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001223 if c.bazelable {
1224 android.InitBazelModule(c)
1225 }
Jiyong Park7916bfc2019-09-30 19:13:12 +09001226 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001227 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001228
Colin Cross36242852017-06-23 15:06:31 -07001229 return c
Colin Crossc472d572015-03-17 15:06:21 -07001230}
1231
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001232// UseVndk() returns true if this module is built against VNDK.
1233// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001234func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001235 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001236}
1237
Colin Crossc511bc52020-04-07 16:50:32 +00001238func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001239 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1240 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001241}
1242
1243func (c *Module) UseSdk() bool {
1244 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001245 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001246 }
1247 return false
1248}
1249
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001250func (c *Module) isCoverageVariant() bool {
1251 return c.coverage.Properties.IsCoverageVariant
1252}
1253
Colin Cross95f1ca02020-10-29 20:47:22 -07001254func (c *Module) IsNdk(config android.Config) bool {
1255 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001256}
1257
Colin Cross127bb8b2020-12-16 16:46:01 -08001258func (c *Module) IsLlndk() bool {
1259 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001260}
1261
Colin Cross127bb8b2020-12-16 16:46:01 -08001262func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001263 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001264}
1265
Colin Cross1f3f1302021-04-26 18:37:44 -07001266func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001267 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001268 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001269}
1270
Colin Cross5271fea2021-04-27 13:06:04 -07001271func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1272 lib := moduleLibraryInterface(m)
1273 return lib != nil && (lib.hasVendorPublicLibrary())
1274}
1275
1276// IsVendorPublicLibrary returns true for vendor public libraries.
1277func (c *Module) IsVendorPublicLibrary() bool {
1278 return c.VendorProperties.IsVendorPublicLibrary
1279}
1280
Ivan Lozanof1868af2022-04-12 13:08:36 -04001281func (c *Module) IsVndkPrebuiltLibrary() bool {
1282 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1283 return true
1284 }
1285 return false
1286}
1287
1288func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1289 return c.Properties.SdkAndPlatformVariantVisibleToMake
1290}
1291
Ivan Lozanod7586b62021-04-01 09:49:36 -04001292func (c *Module) HasLlndkStubs() bool {
1293 lib := moduleLibraryInterface(c)
1294 return lib != nil && lib.hasLLNDKStubs()
1295}
1296
1297func (c *Module) StubsVersion() string {
1298 if lib, ok := c.linker.(versionedInterface); ok {
1299 return lib.stubsVersion()
1300 }
1301 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1302}
1303
Colin Cross127bb8b2020-12-16 16:46:01 -08001304// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1305// and does not set llndk.vendor_available: false.
1306func (c *Module) isImplementationForLLNDKPublic() bool {
1307 library, _ := c.library.(*libraryDecorator)
1308 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001309 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001310}
1311
Justin Yunfd9e8042020-12-23 18:23:14 +09001312// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001313func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001314 // Check if VNDK-core-private or VNDK-SP-private
1315 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001316 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001317 }
1318
1319 // Check if LLNDK-private
1320 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001321 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001322 }
1323
1324 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001325}
1326
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001327// IsVndk() returns true if this module has a vndk variant.
1328// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1329// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001330func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001331 if vndkdep := c.vndkdep; vndkdep != nil {
1332 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001333 }
1334 return false
1335}
1336
Yi Kong4ef54592022-02-14 20:00:10 +08001337func (c *Module) isAfdoCompile() bool {
1338 if afdo := c.afdo; afdo != nil {
1339 return afdo.Properties.AfdoTarget != nil
1340 }
1341 return false
1342}
1343
Yi Kong7e53c572018-02-14 18:16:12 +08001344func (c *Module) isPgoCompile() bool {
1345 if pgo := c.pgo; pgo != nil {
1346 return pgo.Properties.PgoCompile
1347 }
1348 return false
1349}
1350
Yi Kongc702ebd2022-08-19 16:02:45 +08001351func (c *Module) isCfi() bool {
1352 if sanitize := c.sanitize; sanitize != nil {
1353 return Bool(sanitize.Properties.Sanitize.Cfi)
1354 }
1355 return false
1356}
1357
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001358func (c *Module) isNDKStubLibrary() bool {
1359 if _, ok := c.compiler.(*stubDecorator); ok {
1360 return true
1361 }
1362 return false
1363}
1364
Ivan Lozanod7586b62021-04-01 09:49:36 -04001365func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001366 if vndkdep := c.vndkdep; vndkdep != nil {
1367 return vndkdep.isVndkSp()
1368 }
1369 return false
1370}
1371
Ivan Lozanof9e21722020-12-02 09:00:51 -05001372func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001373 if vndkdep := c.vndkdep; vndkdep != nil {
1374 return vndkdep.isVndkExt()
1375 }
1376 return false
1377}
1378
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001379func (c *Module) SubName() string {
1380 return c.Properties.SubName
1381}
1382
Ivan Lozano52767be2019-10-18 14:49:46 -07001383func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001384 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001385}
1386
Logan Chienf3511742017-10-31 18:04:35 +08001387func (c *Module) getVndkExtendsModuleName() string {
1388 if vndkdep := c.vndkdep; vndkdep != nil {
1389 return vndkdep.getVndkExtendsModuleName()
1390 }
1391 return ""
1392}
1393
Jiyong Park25fc6a92018-11-18 18:02:45 +09001394func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001395 if lib := c.library; lib != nil {
1396 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001397 }
1398 return false
1399}
1400
1401func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001402 if lib := c.library; lib != nil {
1403 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001404 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001405 return false
1406}
1407
Alan Stokes73feba32022-11-14 12:21:24 +00001408func (c *Module) IsStubsImplementationRequired() bool {
1409 if lib := c.library; lib != nil {
1410 return lib.isStubsImplementationRequired()
1411 }
1412 return false
1413}
1414
Colin Cross0477b422020-10-13 18:43:54 -07001415// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1416// the implementation. If it is an implementation library it returns its own name.
1417func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1418 name := ctx.OtherModuleName(c)
1419 if versioned, ok := c.linker.(versionedInterface); ok {
1420 name = versioned.implementationModuleName(name)
1421 }
1422 return name
1423}
1424
Martin Stjernholm2856c662020-12-02 15:03:42 +00001425// Similar to ImplementationModuleName, but uses the Make variant of the module
1426// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1427// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1428// under the premise that the prebuilt module overrides its source counterpart
1429// if it is exposed to Make).
1430func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1431 name := c.BaseModuleName()
1432 if versioned, ok := c.linker.(versionedInterface); ok {
1433 name = versioned.implementationModuleName(name)
1434 }
1435 return name
1436}
1437
Jiyong Park7d55b612021-06-11 17:22:09 +09001438func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001439 return Bool(c.Properties.Bootstrap)
1440}
1441
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001442func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001443 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1444 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1445 return false
1446 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001447 return c.linker != nil && c.linker.nativeCoverage()
1448}
1449
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001450func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001451 if p, ok := c.linker.(SnapshotInterface); ok {
1452 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001453 }
1454 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001455}
1456
Bill Peckham945441c2020-08-31 16:07:58 -07001457func (c *Module) ExcludeFromVendorSnapshot() bool {
1458 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1459}
1460
Jose Galmesf7294582020-11-13 12:07:36 -08001461func (c *Module) ExcludeFromRecoverySnapshot() bool {
1462 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1463}
1464
Jiyong Parkf1194352019-02-25 11:05:47 +09001465func isBionic(name string) bool {
1466 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001467 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001468 return true
1469 }
1470 return false
1471}
1472
Martin Stjernholm279de572019-09-10 23:18:20 +01001473func InstallToBootstrap(name string, config android.Config) bool {
Jingwen Chen29743c82023-01-25 17:49:46 +00001474 // NOTE: also update //build/bazel/rules/apex/cc.bzl#_installed_to_bootstrap
1475 // if this list is updated.
Colin Cross4c4c1be2022-02-10 11:41:18 -08001476 if name == "libclang_rt.hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001477 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001478 }
1479 return isBionic(name)
1480}
1481
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001482func (c *Module) XrefCcFiles() android.Paths {
1483 return c.kytheFiles
1484}
1485
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001486func (c *Module) isCfiAssemblySupportEnabled() bool {
1487 return c.sanitize != nil &&
1488 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1489}
1490
Inseob Kim800d1142021-06-14 12:03:51 +09001491func (c *Module) InstallInRoot() bool {
1492 return c.installer != nil && c.installer.installInRoot()
1493}
1494
Colin Crossca860ac2016-01-04 14:34:37 -08001495type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001496 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001497 moduleContextImpl
1498}
1499
Colin Cross37047f12016-12-13 17:06:13 -08001500type depsContext struct {
1501 android.BottomUpMutatorContext
1502 moduleContextImpl
1503}
1504
Colin Crossca860ac2016-01-04 14:34:37 -08001505type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001506 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001507 moduleContextImpl
1508}
1509
1510type moduleContextImpl struct {
1511 mod *Module
1512 ctx BaseModuleContext
1513}
1514
Colin Crossb98c8b02016-07-29 13:44:28 -07001515func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001516 return ctx.mod.toolchain(ctx.ctx)
1517}
1518
1519func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001520 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001521}
1522
1523func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001524 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001525}
1526
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001527func (ctx *moduleContextImpl) testBinary() bool {
1528 return ctx.mod.testBinary()
1529}
1530
Yi Kong56fc1b62022-09-06 16:24:00 +08001531func (ctx *moduleContextImpl) testLibrary() bool {
1532 return ctx.mod.testLibrary()
1533}
1534
Jiyong Park1d1119f2019-07-29 21:27:18 +09001535func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001536 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001537}
1538
Inseob Kim7f283f42020-06-01 21:53:49 +09001539func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001540 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001541}
1542
Inseob Kim1042d292020-06-01 23:23:05 +09001543func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001544 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001545}
1546
Jooyung Hanccce2f22020-03-07 03:45:53 +09001547func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001548 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001549}
1550
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001551func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001552 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001553}
1554
1555func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001556 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001557 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001558 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001559 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001560 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001561 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001562 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001563 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001564 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001565 }
1566 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001567}
1568
Jiyong Parkb35a8192020-08-10 15:59:36 +09001569func (ctx *moduleContextImpl) minSdkVersion() string {
1570 ver := ctx.mod.MinSdkVersion()
1571 if ver == "apex_inherit" && !ctx.isForPlatform() {
1572 ver = ctx.apexSdkVersion().String()
1573 }
1574 if ver == "apex_inherit" || ver == "" {
1575 ver = ctx.sdkVersion()
1576 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001577 // For crt objects, the meaning of min_sdk_version is very different from other types of
1578 // module. For them, min_sdk_version defines the oldest version that the build system will
1579 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1580 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1581 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001582 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1583 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1584 // support such an old version. The version is set to the later version in case when the
1585 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1586 // it's for an APEX.
1587 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1588 if ctx.isForPlatform() {
1589 ver = strconv.Itoa(android.FutureApiLevelInt)
1590 } else { // for apex
1591 ver = ctx.apexSdkVersion().String()
1592 if ver == "" { // in case when min_sdk_version was not set by the APEX
1593 ver = ctx.sdkVersion()
1594 }
1595 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001596 }
1597
Jiyong Parkb35a8192020-08-10 15:59:36 +09001598 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1599 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1600 minSdkVersionInt, err2 := strconv.Atoi(ver)
1601 if err == nil && err2 == nil {
1602 if sdkVersionInt < minSdkVersionInt {
1603 return strconv.Itoa(sdkVersionInt)
1604 }
1605 }
1606 return ver
1607}
1608
1609func (ctx *moduleContextImpl) isSdkVariant() bool {
1610 return ctx.mod.IsSdkVariant()
1611}
1612
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001613func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001614 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001615}
Justin Yun8effde42017-06-23 19:24:43 +09001616
Colin Cross95f1ca02020-10-29 20:47:22 -07001617func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1618 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001619}
1620
Colin Cross127bb8b2020-12-16 16:46:01 -08001621func (ctx *moduleContextImpl) IsLlndk() bool {
1622 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001623}
1624
Colin Cross127bb8b2020-12-16 16:46:01 -08001625func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1626 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001627}
1628
Colin Cross127bb8b2020-12-16 16:46:01 -08001629func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1630 return ctx.mod.isImplementationForLLNDKPublic()
1631}
1632
1633func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1634 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001635}
1636
Logan Chienf3511742017-10-31 18:04:35 +08001637func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001638 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001639}
1640
Yi Kong4ef54592022-02-14 20:00:10 +08001641func (ctx *moduleContextImpl) isAfdoCompile() bool {
1642 return ctx.mod.isAfdoCompile()
1643}
1644
Yi Kong7e53c572018-02-14 18:16:12 +08001645func (ctx *moduleContextImpl) isPgoCompile() bool {
1646 return ctx.mod.isPgoCompile()
1647}
1648
Yi Kongc702ebd2022-08-19 16:02:45 +08001649func (ctx *moduleContextImpl) isCfi() bool {
1650 return ctx.mod.isCfi()
1651}
1652
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001653func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1654 return ctx.mod.isNDKStubLibrary()
1655}
1656
Justin Yun8effde42017-06-23 19:24:43 +09001657func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001658 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001659}
1660
Ivan Lozanof9e21722020-12-02 09:00:51 -05001661func (ctx *moduleContextImpl) IsVndkExt() bool {
1662 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001663}
1664
Colin Cross5271fea2021-04-27 13:06:04 -07001665func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1666 return ctx.mod.IsVendorPublicLibrary()
1667}
1668
Vic Yangefd249e2018-11-12 20:19:56 -08001669func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001670 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001671}
1672
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001673func (ctx *moduleContextImpl) selectedStl() string {
1674 if stl := ctx.mod.stl; stl != nil {
1675 return stl.Properties.SelectedStl
1676 }
1677 return ""
1678}
1679
Ivan Lozanobd721262018-11-27 14:33:03 -08001680func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1681 return ctx.mod.linker.useClangLld(actx)
1682}
1683
Colin Crossce75d2c2016-10-06 16:12:58 -07001684func (ctx *moduleContextImpl) baseModuleName() string {
1685 return ctx.mod.ModuleBase.BaseModuleName()
1686}
1687
Logan Chienf3511742017-10-31 18:04:35 +08001688func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1689 return ctx.mod.getVndkExtendsModuleName()
1690}
1691
Logan Chiene274fc92019-12-03 11:18:32 -08001692func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001693 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001694}
1695
Colin Crosse07f2312020-08-13 11:24:56 -07001696func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001697 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001698}
1699
Dan Albertc8060532020-07-22 22:32:17 -07001700func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001701 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001702}
1703
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001704func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001705 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001706}
1707
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001708func (ctx *moduleContextImpl) nativeCoverage() bool {
1709 return ctx.mod.nativeCoverage()
1710}
1711
Colin Cross56a83212020-09-15 18:30:11 -07001712func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1713 return ctx.mod.DirectlyInAnyApex()
1714}
1715
Colin Cross95b07f22020-12-16 11:06:50 -08001716func (ctx *moduleContextImpl) isPreventInstall() bool {
1717 return ctx.mod.Properties.PreventInstall
1718}
1719
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001720func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1721 shared := &ctx.mod.sharedFlags
1722 if shared.flagsMap == nil {
1723 shared.numSharedFlags = 0
1724 shared.flagsMap = make(map[string]string)
1725 }
1726 return shared
1727}
1728
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001729func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1730 return ctx.mod.isCfiAssemblySupportEnabled()
1731}
1732
Colin Cross635c3b02016-05-18 15:37:25 -07001733func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001734 return &Module{
1735 hod: hod,
1736 multilib: multilib,
1737 }
1738}
1739
Colin Cross635c3b02016-05-18 15:37:25 -07001740func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001741 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001742 module.features = []feature{
1743 &tidyFeature{},
1744 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001745 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001746 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001747 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001748 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001749 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001750 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001751 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001752 module.afdo = &afdo{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001753 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001754 return module
1755}
1756
Colin Crossce75d2c2016-10-06 16:12:58 -07001757func (c *Module) Prebuilt() *android.Prebuilt {
1758 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1759 return p.prebuilt()
1760 }
1761 return nil
1762}
1763
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001764func (c *Module) IsPrebuilt() bool {
1765 return c.Prebuilt() != nil
1766}
1767
Colin Crossce75d2c2016-10-06 16:12:58 -07001768func (c *Module) Name() string {
1769 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001770 if p, ok := c.linker.(interface {
1771 Name(string) string
1772 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001773 name = p.Name(name)
1774 }
1775 return name
1776}
1777
Alex Light3d673592019-01-18 14:37:31 -08001778func (c *Module) Symlinks() []string {
1779 if p, ok := c.installer.(interface {
1780 symlinkList() []string
1781 }); ok {
1782 return p.symlinkList()
1783 }
1784 return nil
1785}
1786
Roland Levillainf89cd092019-07-29 16:22:59 +01001787func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1788 test, ok := c.linker.(testPerSrc)
1789 return ok && test.isAllTestsVariation()
1790}
1791
Chris Parsons216e10a2020-07-09 17:12:52 -04001792func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001793 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001794 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001795 }); ok {
1796 return p.dataPaths()
1797 }
1798 return nil
1799}
1800
Ivan Lozanof1868af2022-04-12 13:08:36 -04001801func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001802 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1803 // "current", it will append the VNDK version to the name suffix.
1804 var vndkVersion string
1805 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001806 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001807 if c.ProductSpecific() {
1808 // If the module is product specific with 'product_specific: true',
1809 // do not add a name suffix because it is a base module.
1810 return ""
1811 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001812 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
Matthew Maurer52af5b02021-05-27 10:01:36 -07001813 nameSuffix = ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001814 } else {
1815 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001816 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001817 }
1818 if vndkVersion == "current" {
1819 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1820 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001821 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001822 // add version suffix only if the module is using different vndk version than the
1823 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001824 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001825 }
1826 return nameSuffix
1827}
1828
Ivan Lozanof1868af2022-04-12 13:08:36 -04001829func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1830 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001831
1832 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001833 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001834 }
1835
Colin Cross127bb8b2020-12-16 16:46:01 -08001836 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001837 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001838 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1839 // added for product variant only when we have vendor and product variants with core
1840 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001841 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001842 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001843 subName += vendorPublicLibrarySuffix
1844 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001845 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1846 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001847 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001848 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001849 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001850 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001851 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001852 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001853 subName += RecoverySuffix
1854 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1855 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001856 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001857 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001858 }
Inseob Kim64c43952019-08-26 16:52:35 +09001859 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001860
1861 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001862}
1863
Chris Parsonsf874e462022-05-10 13:50:12 -04001864var _ android.MixedBuildBuildable = (*Module)(nil)
1865
1866func (c *Module) getBazelModuleLabel(ctx android.BaseModuleContext) string {
Trevor Radcliffe5d6fa4d2022-05-17 21:59:36 +00001867 var bazelModuleLabel string
Liz Kammer35ca77e2021-12-22 15:31:40 -05001868 if c.typ() == fullLibrary && c.static() {
Chris Parsons77acf2e2021-12-03 17:27:16 -05001869 // cc_library is a special case in bp2build; two targets are generated -- one for each
1870 // of the shared and static variants. The shared variant keeps the module name, but the
1871 // static variant uses a different suffixed name.
Trevor Radcliffe5d6fa4d2022-05-17 21:59:36 +00001872 bazelModuleLabel = bazelLabelForStaticModule(ctx, c)
1873 } else {
1874 bazelModuleLabel = c.GetBazelLabel(ctx, c)
Chris Parsonsf874e462022-05-10 13:50:12 -04001875 }
Trevor Radcliffe5d6fa4d2022-05-17 21:59:36 +00001876 labelNoPrebuilt := bazelModuleLabel
1877 if c.IsPrebuilt() {
1878 labelNoPrebuilt = android.RemoveOptionalPrebuiltPrefixFromBazelLabel(bazelModuleLabel)
1879 }
1880 return labelNoPrebuilt
Chris Parsonsf874e462022-05-10 13:50:12 -04001881}
1882
1883func (c *Module) QueueBazelCall(ctx android.BaseModuleContext) {
1884 c.bazelHandler.QueueBazelCall(ctx, c.getBazelModuleLabel(ctx))
1885}
1886
Jingwen Chen3952a902022-12-12 12:20:58 +00001887var (
1888 mixedBuildSupportedCcTest = []string{
1889 "adbd_test",
Liz Kammer9c667412023-01-24 10:47:18 -05001890 "adb_crypto_test",
1891 "adb_pairing_auth_test",
1892 "adb_pairing_connection_test",
1893 "adb_tls_connection_test",
Jingwen Chen3952a902022-12-12 12:20:58 +00001894 }
1895)
1896
1897// IsMixedBuildSupported returns true if the module should be analyzed by Bazel
1898// in any of the --bazel-mode(s). This filters at the module level and takes
1899// precedence over the allowlists in allowlists/allowlists.go.
Chris Parsonsf874e462022-05-10 13:50:12 -04001900func (c *Module) IsMixedBuildSupported(ctx android.BaseModuleContext) bool {
Sam Delmerico4e115cc2023-01-19 15:36:52 -05001901 _, isForTesting := ctx.Config().BazelContext.(android.MockBazelContext)
1902 if c.testBinary() && !android.InList(c.Name(), mixedBuildSupportedCcTest) && !isForTesting {
Jingwen Chen3952a902022-12-12 12:20:58 +00001903 // Per-module rollout of mixed-builds for cc_test modules.
1904 return false
1905 }
1906
Trevor Radcliffedb7e0262022-10-28 16:48:18 +00001907 // TODO(b/261058727): Remove this (enable mixed builds for modules with UBSan)
Yu Liue4312402023-01-18 09:15:31 -08001908 // Currently we can only support ubsan when minimum runtime is used.
1909 return c.bazelHandler != nil && (!isUbsanEnabled(c) || c.MinimalRuntimeNeeded())
1910}
1911
1912func isUbsanEnabled(c *Module) bool {
1913 if c.sanitize == nil {
1914 return false
1915 }
1916 sanitizeProps := &c.sanitize.Properties.SanitizeMutated
1917 return Bool(sanitizeProps.Integer_overflow) || len(sanitizeProps.Misc_undefined) > 0
1918}
1919
1920func GetApexConfigKey(ctx android.BaseModuleContext) *android.ApexConfigKey {
1921 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1922 if !apexInfo.IsForPlatform() {
Yu Liubfb23622023-02-22 10:42:15 -08001923 if !ctx.Config().BazelContext.IsModuleDclaAllowed(ctx.Module().Name()) {
1924 return nil
1925 }
Yu Liue4312402023-01-18 09:15:31 -08001926 apexKey := android.ApexConfigKey{
1927 WithinApex: true,
1928 ApexSdkVersion: findApexSdkVersion(ctx, apexInfo).String(),
1929 }
1930 return &apexKey
1931 }
1932
1933 return nil
Chris Parsonsf874e462022-05-10 13:50:12 -04001934}
1935
1936func (c *Module) ProcessBazelQueryResponse(ctx android.ModuleContext) {
1937 bazelModuleLabel := c.getBazelModuleLabel(ctx)
Chris Parsonsf874e462022-05-10 13:50:12 -04001938 c.bazelHandler.ProcessBazelQueryResponse(ctx, bazelModuleLabel)
1939
1940 c.Properties.SubName = GetSubnameProperty(ctx, c)
1941 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1942 if !apexInfo.IsForPlatform() {
1943 c.hideApexVariantFromMake = true
Chris Parsons77acf2e2021-12-03 17:27:16 -05001944 }
Liz Kammer35ca77e2021-12-22 15:31:40 -05001945
Chris Parsonsf874e462022-05-10 13:50:12 -04001946 c.makeLinkType = GetMakeLinkType(ctx, c)
1947
1948 mctx := &moduleContext{
1949 ModuleContext: ctx,
1950 moduleContextImpl: moduleContextImpl{
1951 mod: c,
1952 },
Chris Parsons8d6e4332021-02-22 16:13:50 -05001953 }
Chris Parsonsf874e462022-05-10 13:50:12 -04001954 mctx.ctx = mctx
1955
Jingwen Chen3952a902022-12-12 12:20:58 +00001956 // TODO(b/244432500): Get the tradefed config from the bazel target instead
1957 // of generating it with Soong.
Chris Parsonsf874e462022-05-10 13:50:12 -04001958 c.maybeInstall(mctx, apexInfo)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001959}
1960
1961func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05001962 // Handle the case of a test module split by `test_per_src` mutator.
1963 //
1964 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1965 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1966 // module and return early, as this module does not produce an output file per se.
1967 if c.IsTestPerSrcAllTestsVariation() {
1968 c.outputFile = android.OptionalPath{}
1969 return
1970 }
1971
Ivan Lozanof1868af2022-04-12 13:08:36 -04001972 c.Properties.SubName = GetSubnameProperty(actx, c)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001973 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1974 if !apexInfo.IsForPlatform() {
1975 c.hideApexVariantFromMake = true
1976 }
1977
Chris Parsonseefc9e62021-04-02 17:36:47 -04001978 c.makeLinkType = GetMakeLinkType(actx, c)
1979
Colin Crossca860ac2016-01-04 14:34:37 -08001980 ctx := &moduleContext{
Colin Cross635c3b02016-05-18 15:37:25 -07001981 ModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08001982 moduleContextImpl: moduleContextImpl{
1983 mod: c,
1984 },
1985 }
1986 ctx.ctx = ctx
1987
Colin Crossf18e1102017-11-16 14:33:08 -08001988 deps := c.depsToPaths(ctx)
1989 if ctx.Failed() {
1990 return
1991 }
1992
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001993 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1994 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00001995 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
1996 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001997 }
1998
Colin Crossca860ac2016-01-04 14:34:37 -08001999 flags := Flags{
2000 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002001 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002002 }
Colin Crossca860ac2016-01-04 14:34:37 -08002003 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002004 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002005 }
2006 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002007 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002008 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002009 if c.stl != nil {
2010 flags = c.stl.flags(ctx, flags)
2011 }
Colin Cross16b23492016-01-06 14:41:07 -08002012 if c.sanitize != nil {
2013 flags = c.sanitize.flags(ctx, flags)
2014 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002015 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002016 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002017 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002018 if c.fuzzer != nil {
2019 flags = c.fuzzer.flags(ctx, flags)
2020 }
Stephen Craneba090d12017-05-09 15:44:35 -07002021 if c.lto != nil {
2022 flags = c.lto.flags(ctx, flags)
2023 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002024 if c.afdo != nil {
2025 flags = c.afdo.flags(ctx, flags)
2026 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07002027 if c.pgo != nil {
2028 flags = c.pgo.flags(ctx, flags)
2029 }
Colin Crossca860ac2016-01-04 14:34:37 -08002030 for _, feature := range c.features {
2031 flags = feature.flags(ctx, flags)
2032 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002033 if ctx.Failed() {
2034 return
2035 }
2036
Colin Cross4af21ed2019-11-04 09:37:55 -08002037 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2038 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2039 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002040
Colin Cross4af21ed2019-11-04 09:37:55 -08002041 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002042
2043 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002044 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002045 }
2046 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002047 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002048 }
2049
Colin Cross3e5e7782022-06-17 22:17:05 +00002050 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2051
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002052 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002053 // We need access to all the flags seen by a source file.
2054 if c.sabi != nil {
2055 flags = c.sabi.flags(ctx, flags)
2056 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002057
Colin Cross4af21ed2019-11-04 09:37:55 -08002058 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002059
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002060 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002061 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002062 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002063 if ctx.Failed() {
2064 return
2065 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002066 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002067 c.objFiles = objs.objFiles
2068 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002069 }
2070
Colin Crossca860ac2016-01-04 14:34:37 -08002071 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002072 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002073 if ctx.Failed() {
2074 return
2075 }
Colin Cross635c3b02016-05-18 15:37:25 -07002076 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002077
Chris Parsons94a0bba2021-06-04 15:03:47 -04002078 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002079
Jose Galmes6f843bc2020-12-11 13:36:29 -08002080 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2081 // RECOVERY_SNAPSHOT_VERSION is current.
2082 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002083 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002084 i.collectHeadersForSnapshot(ctx)
2085 }
2086 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002087 }
Colin Cross5049f022015-03-18 13:28:46 -07002088
Chris Parsons94a0bba2021-06-04 15:03:47 -04002089 c.maybeInstall(ctx, apexInfo)
2090}
2091
2092func (c *Module) maybeUnhideFromMake() {
2093 // If a lib is directly included in any of the APEXes or is not available to the
2094 // platform (which is often the case when the stub is provided as a prebuilt),
2095 // unhide the stubs variant having the latest version gets visible to make. In
2096 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2097 // force anything in the make world to link against the stubs library. (unless it
2098 // is explicitly referenced via .bootstrap suffix or the module is marked with
2099 // 'bootstrap: true').
2100 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
2101 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
2102 c.IsStubs() && !c.InVendorRamdisk() {
2103 c.Properties.HideFromMake = false // unhide
2104 // Note: this is still non-installable
2105 }
2106}
2107
Jingwen Chen3952a902022-12-12 12:20:58 +00002108// maybeInstall is called at the end of both GenerateAndroidBuildActions and
2109// ProcessBazelQueryResponse to run the install hooks for installable modules,
2110// like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002111func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002112 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002113 // If the module has been specifically configure to not be installed then
2114 // hide from make as otherwise it will break when running inside make
2115 // as the output path to install will not be specified. Not all uninstallable
2116 // modules can be hidden from make as some are needed for resolving make side
2117 // dependencies.
2118 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002119 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002120 c.SkipInstall()
2121 }
2122
2123 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2124 // to allow using the outputs in a genrule.
2125 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002126 c.installer.install(ctx, c.outputFile.Path())
2127 if ctx.Failed() {
2128 return
Colin Crossca860ac2016-01-04 14:34:37 -08002129 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002130 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002131}
2132
Sam Delmerico5fb794a2023-01-27 16:01:37 -05002133func (c *Module) setAndroidMkVariablesFromCquery(info cquery.CcAndroidMkInfo) {
2134 c.Properties.AndroidMkSharedLibs = info.LocalSharedLibs
2135 c.Properties.AndroidMkStaticLibs = info.LocalStaticLibs
2136 c.Properties.AndroidMkWholeStaticLibs = info.LocalWholeStaticLibs
2137}
2138
Colin Cross0ea8ba82019-06-06 14:33:29 -07002139func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002140 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002141 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002142 }
Colin Crossca860ac2016-01-04 14:34:37 -08002143 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002144}
2145
Colin Crossca860ac2016-01-04 14:34:37 -08002146func (c *Module) begin(ctx BaseModuleContext) {
2147 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002148 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002149 }
Colin Crossca860ac2016-01-04 14:34:37 -08002150 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002151 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002152 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002153 if c.stl != nil {
2154 c.stl.begin(ctx)
2155 }
Colin Cross16b23492016-01-06 14:41:07 -08002156 if c.sanitize != nil {
2157 c.sanitize.begin(ctx)
2158 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002159 if c.coverage != nil {
2160 c.coverage.begin(ctx)
2161 }
Stephen Craneba090d12017-05-09 15:44:35 -07002162 if c.lto != nil {
2163 c.lto.begin(ctx)
2164 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002165 if c.afdo != nil {
2166 c.afdo.begin(ctx)
2167 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07002168 if c.pgo != nil {
2169 c.pgo.begin(ctx)
2170 }
Dan Albert92fe7402020-07-15 13:33:30 -07002171 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002172 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002173 if err != nil {
2174 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002175 c.Properties.Sdk_version = nil
2176 } else {
2177 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002178 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002179 }
Colin Crossca860ac2016-01-04 14:34:37 -08002180}
2181
Colin Cross37047f12016-12-13 17:06:13 -08002182func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002183 deps := Deps{}
2184
2185 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002186 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002187 }
2188 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002189 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002190 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002191 if c.stl != nil {
2192 deps = c.stl.deps(ctx, deps)
2193 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002194 if c.coverage != nil {
2195 deps = c.coverage.deps(ctx, deps)
2196 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002197
Colin Crossb6715442017-10-24 11:13:31 -07002198 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2199 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2200 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2201 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2202 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2203 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002204 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002205
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002206 for _, lib := range deps.ReexportSharedLibHeaders {
2207 if !inList(lib, deps.SharedLibs) {
2208 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2209 }
2210 }
2211
2212 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002213 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2214 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 -07002215 }
2216 }
2217
Colin Cross5950f382016-12-13 12:50:57 -08002218 for _, lib := range deps.ReexportHeaderLibHeaders {
2219 if !inList(lib, deps.HeaderLibs) {
2220 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2221 }
2222 }
2223
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002224 for _, gen := range deps.ReexportGeneratedHeaders {
2225 if !inList(gen, deps.GeneratedHeaders) {
2226 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2227 }
2228 }
2229
Colin Crossc99deeb2016-04-11 15:06:20 -07002230 return deps
2231}
2232
Dan Albert7e9d2952016-08-04 13:02:36 -07002233func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002234 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002235 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002236 moduleContextImpl: moduleContextImpl{
2237 mod: c,
2238 },
2239 }
2240 ctx.ctx = ctx
2241
Colin Crossca860ac2016-01-04 14:34:37 -08002242 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002243}
2244
Jiyong Park7ed9de32018-10-15 22:25:07 +09002245// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002246func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002247 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2248 version := name[sharp+1:]
2249 libname := name[:sharp]
2250 return libname, version
2251 }
2252 return name, ""
2253}
2254
Dan Albert92fe7402020-07-15 13:33:30 -07002255func GetCrtVariations(ctx android.BottomUpMutatorContext,
2256 m LinkableInterface) []blueprint.Variation {
2257 if ctx.Os() != android.Android {
2258 return nil
2259 }
2260 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002261 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2262 minSdkVersion := m.MinSdkVersion()
2263 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2264 minSdkVersion = m.SdkVersion()
2265 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002266 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2267 if err != nil {
2268 ctx.PropertyErrorf("min_sdk_version", err.Error())
2269 }
Colin Cross363ec762023-01-13 13:45:14 -08002270
2271 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002272 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002273 if apiLevel.LessThan(minApiForArch) {
2274 apiLevel = minApiForArch
2275 }
2276
Dan Albert92fe7402020-07-15 13:33:30 -07002277 return []blueprint.Variation{
2278 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002279 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002280 }
2281 }
2282 return []blueprint.Variation{
2283 {Mutator: "sdk", Variation: ""},
2284 }
2285}
2286
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002287func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2288 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002289
2290 variations = append([]blueprint.Variation(nil), variations...)
2291
Liz Kammer23942242022-04-08 15:41:00 -04002292 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002293 // Version is explicitly specified. i.e. libFoo#30
2294 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002295 if tag, ok := depTag.(libraryDependencyTag); ok {
2296 tag.explicitlyVersioned = true
2297 } else {
2298 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2299 }
Colin Crosse7257d22020-09-24 09:56:18 -07002300 }
Colin Crosse7257d22020-09-24 09:56:18 -07002301
Colin Cross0de8a1e2020-09-18 14:15:30 -07002302 if far {
2303 ctx.AddFarVariationDependencies(variations, depTag, name)
2304 } else {
2305 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002306 }
2307}
2308
Kiyoung Kim487689e2022-07-26 09:48:22 +09002309func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2310 apiImportInfo := multitree.ApiImportInfo{}
2311
2312 if c.Device() {
2313 var apiImportModule []blueprint.Module
2314 if actx.OtherModuleExists("api_imports") {
2315 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2316 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
2317 apiInfo := actx.OtherModuleProvider(apiImportModule[0], multitree.ApiImportsProvider).(multitree.ApiImportInfo)
2318 apiImportInfo = apiInfo
2319 actx.SetProvider(multitree.ApiImportsProvider, apiInfo)
2320 }
2321 }
2322 }
2323
2324 return apiImportInfo
2325}
2326
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002327func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002328 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002329 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002330 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002331 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2332 // between the modules in the snapshot and the snapshot itself.
2333 var snapshotModule []blueprint.Module
2334 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2335 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2336 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2337 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2338 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002339 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002340 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2341 *snapshotInfo = &snapshot
2342 // republish the snapshot for use in later mutators on this module
2343 actx.SetProvider(SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002344 }
2345 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002346 if *snapshotInfo == nil {
2347 *snapshotInfo = &SnapshotInfo{}
2348 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002349 return **snapshotInfo
2350}
2351
Kiyoung Kim487689e2022-07-26 09:48:22 +09002352func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2353 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002354 return snapshot
2355 }
2356
2357 return lib
2358}
2359
2360// RewriteLibs takes a list of names of shared libraries and scans it for three types
2361// of names:
2362//
2363// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002364//
2365// For each of these, it adds the name of the prebuilt module (which will be in
2366// prebuilts/ndk) to the list of nonvariant libs.
2367//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002368// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002369//
2370// For each of these, it adds the name of the ndk_library module to the list of
2371// variant libs.
2372//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002373// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002374//
2375// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002376//
2377// The caller can then know to add the variantLibs dependencies differently from the
2378// nonvariantLibs
2379func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2380 variantLibs = []string{}
2381
2382 nonvariantLibs = []string{}
2383 for _, entry := range list {
2384 // strip #version suffix out
2385 name, _ := StubsLibNameAndVersion(entry)
2386 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002387 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002388 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2389 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2390 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002391 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002392 } else {
2393 // put name#version back
2394 nonvariantLibs = append(nonvariantLibs, entry)
2395 }
2396 }
2397 return nonvariantLibs, variantLibs
2398}
2399
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002400func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2401 nonVariantLibs := []string{}
2402 variantLibs := []string{}
2403
2404 for _, lib := range libs {
2405 replaceLibName := GetReplaceModuleName(lib, replaceList)
2406 if replaceLibName == lib {
2407 // Do not handle any libs which are not in API imports
2408 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2409 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2410 variantLibs = append(variantLibs, replaceLibName)
2411 } else {
2412 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2413 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002414 }
2415
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002416 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002417}
2418
Colin Cross1e676be2016-10-12 14:38:15 -07002419func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002420 if !c.Enabled() {
2421 return
2422 }
2423
Colin Cross37047f12016-12-13 17:06:13 -08002424 ctx := &depsContext{
2425 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002426 moduleContextImpl: moduleContextImpl{
2427 mod: c,
2428 },
2429 }
2430 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002431
Colin Crossc99deeb2016-04-11 15:06:20 -07002432 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002433 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002434
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002435 apiNdkLibs := []string{}
2436 apiLateNdkLibs := []string{}
2437
Kiyoung Kim11d91082022-10-19 19:20:57 +09002438 if ctx.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002439 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2440 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2441 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2442 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2443 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002444 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002445
Yo Chiang219968c2020-09-22 18:45:04 +08002446 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2447
Colin Crosse0edaf92021-01-11 17:31:17 -08002448 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002449
Dan Albert914449f2016-06-17 16:45:24 -07002450 variantNdkLibs := []string{}
2451 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002452 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002453 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2454 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2455 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002456
2457 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002458 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002459 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002460 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002461
Colin Cross32ec36c2016-12-15 07:39:51 -08002462 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002463 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002464 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002465 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002466 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002467
Kiyoung Kim51279d32022-08-24 14:10:46 +09002468 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim11d91082022-10-19 19:20:57 +09002469 if ctx.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2470 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2471 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002472 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002473
Spandan Das73bcafc2022-08-18 23:26:00 +00002474 if c.isNDKStubLibrary() {
2475 // ndk_headers do not have any variations
2476 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002477 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002478 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002479 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002480 } else {
2481 actx.AddVariationDependencies(nil, depTag, lib)
2482 }
2483 }
2484
Dan Albertf1d14c72020-07-30 14:32:55 -07002485 if c.isNDKStubLibrary() {
2486 // NDK stubs depend on their implementation because the ABI dumps are
2487 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002488 apiImportName := c.BaseModuleName() + multitree.GetApiImportSuffix()
2489
2490 // If original library exists as imported API, set dependency on the imported library
2491 if actx.OtherModuleExists(apiImportName) {
2492 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2493 c.ImageVariation(),
2494 blueprint.Variation{Mutator: "link", Variation: "shared"},
2495 ), stubImplementation, apiImportName)
2496 } else {
2497 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2498 c.ImageVariation(),
2499 blueprint.Variation{Mutator: "link", Variation: "shared"},
2500 ), stubImplementation, c.BaseModuleName())
2501 }
Dan Albertf1d14c72020-07-30 14:32:55 -07002502 }
2503
Jiyong Park5d1598f2019-02-25 22:14:17 +09002504 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002505 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002506
Kiyoung Kim487689e2022-07-26 09:48:22 +09002507 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002508
Jiyong Park5d1598f2019-02-25 22:14:17 +09002509 actx.AddVariationDependencies([]blueprint.Variation{
2510 {Mutator: "link", Variation: "static"},
2511 }, depTag, lib)
2512 }
2513
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002514 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002515 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002516 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002517 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002518 }
Jiyong Parke3867542020-12-03 17:28:25 +09002519 if inList(lib, deps.ExcludeLibsForApex) {
2520 depTag.excludeInApex = true
2521 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002522
Kiyoung Kim487689e2022-07-26 09:48:22 +09002523 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002524
Dan Willemsen59339a22018-07-22 21:18:45 -07002525 actx.AddVariationDependencies([]blueprint.Variation{
2526 {Mutator: "link", Variation: "static"},
2527 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002528 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002529
Jooyung Han75568392020-03-20 04:29:24 +09002530 // staticUnwinderDep is treated as staticDep for Q apexes
2531 // so that native libraries/binaries are linked with static unwinder
2532 // because Q libc doesn't have unwinder APIs
2533 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002534 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002535 actx.AddVariationDependencies([]blueprint.Variation{
2536 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002537 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002538 }
2539
Jiyong Park7ed9de32018-10-15 22:25:07 +09002540 // shared lib names without the #version suffix
2541 var sharedLibNames []string
2542
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002543 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002544 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002545 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002546 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002547 }
Jiyong Parke3867542020-12-03 17:28:25 +09002548 if inList(lib, deps.ExcludeLibsForApex) {
2549 depTag.excludeInApex = true
2550 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002551
Jiyong Park73c54ee2019-10-22 20:31:18 +09002552 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002553 sharedLibNames = append(sharedLibNames, name)
2554
Colin Crosse7257d22020-09-24 09:56:18 -07002555 variations := []blueprint.Variation{
2556 {Mutator: "link", Variation: "shared"},
2557 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002558 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002559 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002560
Colin Crossfe9acfe2021-06-14 16:13:03 -07002561 for _, lib := range deps.LateStaticLibs {
2562 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2563 actx.AddVariationDependencies([]blueprint.Variation{
2564 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002565 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002566 }
2567
Colin Cross3e5e7782022-06-17 22:17:05 +00002568 for _, lib := range deps.UnexportedStaticLibs {
2569 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2570 actx.AddVariationDependencies([]blueprint.Variation{
2571 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002572 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002573 }
2574
Jiyong Park7ed9de32018-10-15 22:25:07 +09002575 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002576 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002577 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2578 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2579 // linking against both the stubs lib and the non-stubs lib at the same time.
2580 continue
2581 }
Colin Cross6e511a92020-07-27 21:26:48 -07002582 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002583 variations := []blueprint.Variation{
2584 {Mutator: "link", Variation: "shared"},
2585 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002586 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002587 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002588
Dan Willemsen59339a22018-07-22 21:18:45 -07002589 actx.AddVariationDependencies([]blueprint.Variation{
2590 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002591 }, dataLibDepTag, deps.DataLibs...)
2592
Colin Crossc8caa062021-09-24 16:50:14 -07002593 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2594
Chris Parsons79d66a52020-06-05 17:26:16 -04002595 actx.AddVariationDependencies([]blueprint.Variation{
2596 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002597 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002598
Colin Cross68861832016-07-08 10:41:41 -07002599 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002600
2601 for _, gen := range deps.GeneratedHeaders {
2602 depTag := genHeaderDepTag
2603 if inList(gen, deps.ReexportGeneratedHeaders) {
2604 depTag = genHeaderExportDepTag
2605 }
2606 actx.AddDependency(c, depTag, gen)
2607 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002608
Dan Albert92fe7402020-07-15 13:33:30 -07002609 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002610 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002611 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002612 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002613 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002614 }
Colin Crossc465efd2021-06-11 18:00:04 -07002615 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002616 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002617 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002618 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002619 if deps.DynamicLinker != "" {
2620 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002621 }
Dan Albert914449f2016-06-17 16:45:24 -07002622
2623 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002624
2625 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002626 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002627 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002628 {Mutator: "link", Variation: "shared"},
2629 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002630 actx.AddVariationDependencies([]blueprint.Variation{
2631 {Mutator: "version", Variation: version},
2632 {Mutator: "link", Variation: "shared"},
2633 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002634
2635 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002636 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002637 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002638 {Mutator: "link", Variation: "shared"},
2639 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002640 actx.AddVariationDependencies([]blueprint.Variation{
2641 {Mutator: "version", Variation: version},
2642 {Mutator: "link", Variation: "shared"},
2643 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002644
2645 if vndkdep := c.vndkdep; vndkdep != nil {
2646 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002647 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002648 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002649 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002650 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002651 }
2652 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002653
2654 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002655}
Colin Cross21b9a242015-03-24 14:15:58 -07002656
Colin Crosse40b4ea2018-10-02 22:25:58 -07002657func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002658 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2659 c.beginMutator(ctx)
2660 }
2661}
2662
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002663// Whether a module can link to another module, taking into
2664// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002665func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002666 tag blueprint.DependencyTag) {
2667
2668 switch t := tag.(type) {
2669 case dependencyTag:
2670 if t != vndkExtDepTag {
2671 return
2672 }
2673 case libraryDependencyTag:
2674 default:
2675 return
2676 }
2677
Ivan Lozanof9e21722020-12-02 09:00:51 -05002678 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002679 // Host code is not restricted
2680 return
2681 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002682
2683 // VNDK is cc.Module supported only for now.
2684 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002685 // Though allowed dependency is limited by the image mutator,
2686 // each vendor and product module needs to check link-type
2687 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002688 if ccTo, ok := to.(*Module); ok {
2689 if ccFrom.vndkdep != nil {
2690 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2691 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002692 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002693 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002694 }
2695 return
2696 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002697 // TODO(b/244244438) : Remove this once all variants are implemented
2698 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2699 return
2700 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002701 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002702 // Platform code can link to anything
2703 return
2704 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002705 if from.InRamdisk() {
2706 // Ramdisk code is not NDK
2707 return
2708 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002709 if from.InVendorRamdisk() {
2710 // Vendor ramdisk code is not NDK
2711 return
2712 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002713 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002714 // Recovery code is not NDK
2715 return
2716 }
Colin Cross31076b32020-10-23 17:22:06 -07002717 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002718 if c.NdkPrebuiltStl() {
2719 // These are allowed, but they don't set sdk_version
2720 return
2721 }
2722 if c.StubDecorator() {
2723 // These aren't real libraries, but are the stub shared libraries that are included in
2724 // the NDK.
2725 return
2726 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002727 if c.isImportedApiLibrary() {
2728 // Imported library from the API surface is a stub library built against interface definition.
2729 return
2730 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002731 }
Logan Chien834b9a62019-01-14 15:39:03 +08002732
Ivan Lozano52767be2019-10-18 14:49:46 -07002733 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002734 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2735 // to link to libc++ (non-NDK and without sdk_version).
2736 return
2737 }
2738
Ivan Lozano52767be2019-10-18 14:49:46 -07002739 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002740 // NDK code linking to platform code is never okay.
2741 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002742 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002743 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002744 }
2745
2746 // At this point we know we have two NDK libraries, but we need to
2747 // check that we're not linking against anything built against a higher
2748 // API level, as it is only valid to link against older or equivalent
2749 // APIs.
2750
Inseob Kim01a28722018-04-11 09:48:45 +09002751 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002752 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002753 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002754 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002755 // Current can't be linked against by anything else.
2756 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002757 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002758 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002759 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002760 if err != nil {
2761 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002762 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002763 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002764 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002765 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002766 if err != nil {
2767 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002768 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002769 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002770 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002771
Inseob Kim01a28722018-04-11 09:48:45 +09002772 if toApi > fromApi {
2773 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002774 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002775 }
2776 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002777 }
Dan Albert202fe492017-12-15 13:56:59 -08002778
2779 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002780 fromStl := from.SelectedStl()
2781 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002782 if fromStl == "" || toStl == "" {
2783 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002784 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002785 // We can be permissive with the system "STL" since it is only the C++
2786 // ABI layer, but in the future we should make sure that everyone is
2787 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002788 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002789 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002790 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2791 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002792 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002793}
2794
Jooyung Han479ca172020-10-19 18:51:07 +09002795func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2796 if c, ok := ctx.Module().(*Module); ok {
2797 ctx.VisitDirectDeps(func(dep android.Module) {
2798 depTag := ctx.OtherModuleDependencyTag(dep)
2799 ccDep, ok := dep.(LinkableInterface)
2800 if ok {
2801 checkLinkType(ctx, c, ccDep, depTag)
2802 }
2803 })
2804 }
2805}
2806
Jiyong Park5fb8c102018-04-09 12:03:06 +09002807// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002808// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2809// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002810// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002811func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2812 check := func(child, parent android.Module) bool {
2813 to, ok := child.(*Module)
2814 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002815 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002816 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002817
Jooyung Hana70f0672019-01-18 15:20:43 +09002818 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2819 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002820 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002821
Jiyong Park0474e1f2021-01-14 14:26:06 +09002822 // These dependencies are not excercised at runtime. Tracking these will give us
2823 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002824 depTag := ctx.OtherModuleDependencyTag(child)
2825 if IsHeaderDepTag(depTag) {
2826 return false
2827 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002828 if depTag == staticVariantTag {
2829 return false
2830 }
2831 if depTag == stubImplDepTag {
2832 return false
2833 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002834
Justin Yun63e9ec72020-10-29 16:49:43 +09002835 // Even if target lib has no vendor variant, keep checking dependency
2836 // graph in case it depends on vendor_available or product_available
2837 // but not double_loadable transtively.
2838 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002839 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002840 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002841
Jiyong Park0474e1f2021-01-14 14:26:06 +09002842 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2843 // one.
2844 if Bool(to.VendorProperties.Double_loadable) {
2845 return true
2846 }
2847
Ivan Lozanod7586b62021-04-01 09:49:36 -04002848 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002849 return false
2850 }
2851
Jooyung Hana70f0672019-01-18 15:20:43 +09002852 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2853 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002854 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002855 return false
2856 }
2857 if module, ok := ctx.Module().(*Module); ok {
2858 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002859 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002860 ctx.WalkDeps(check)
2861 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002862 }
2863 }
2864}
2865
Yu Liue4312402023-01-18 09:15:31 -08002866func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
2867 // For the dependency from platform to apex, use the latest stubs
2868 apexSdkVersion := android.FutureApiLevel
2869 if !apexInfo.IsForPlatform() {
2870 apexSdkVersion = apexInfo.MinSdkVersion
2871 }
2872
2873 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2874 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2875 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2876 // (b/144430859)
2877 apexSdkVersion = android.FutureApiLevel
2878 }
2879
2880 return apexSdkVersion
2881}
2882
Colin Crossc99deeb2016-04-11 15:06:20 -07002883// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002884func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002885 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002886
Colin Cross0de8a1e2020-09-18 14:15:30 -07002887 var directStaticDeps []StaticLibraryInfo
2888 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002889
Colin Cross0de8a1e2020-09-18 14:15:30 -07002890 reexportExporter := func(exporter FlagExporterInfo) {
2891 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2892 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2893 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2894 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2895 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002896 }
2897
Colin Cross56a83212020-09-15 18:30:11 -07002898 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Yu Liue4312402023-01-18 09:15:31 -08002899 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09002900
Colin Crossd11fcda2017-10-23 17:59:01 -07002901 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002902 depName := ctx.OtherModuleName(dep)
2903 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002904
Dan Willemsen47450072021-10-19 20:24:49 -07002905 if depTag == android.DarwinUniversalVariantTag {
2906 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
2907 return
2908 }
2909
Ivan Lozano52767be2019-10-18 14:49:46 -07002910 ccDep, ok := dep.(LinkableInterface)
2911 if !ok {
2912
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002913 // handling for a few module types that aren't cc Module but that are also supported
2914 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002915 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002916 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002917 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2918 genRule.GeneratedSourceFiles()...)
2919 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002920 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002921 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002922 // Support exported headers from a generated_sources dependency
2923 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002924 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002925 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002926 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002927 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002928 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002929 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002930 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002931 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002932 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2933 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002934 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002935 // 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 +09002936 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002937
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002938 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002939 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002940 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002941 }
Colin Crosscef792e2021-06-11 18:01:26 -07002942 case CrtBeginDepTag:
2943 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2944 case CrtEndDepTag:
2945 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002946 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002947 return
2948 }
2949
Colin Crossfe17f6f2019-03-28 19:30:56 -07002950 if depTag == android.ProtoPluginDepTag {
2951 return
2952 }
2953
Colin Crossd11fcda2017-10-23 17:59:01 -07002954 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002955 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
2956 return
2957 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002958 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002959 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2960 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002961 return
2962 }
2963
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002964 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002965 // Skip reused objects for stub libraries, they use their own stub object file instead.
2966 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
2967 // version mutator, so the stubs variant is created from the shared variant that
2968 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07002969 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07002970 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
2971 objs := staticAnalogue.ReuseObjects
2972 depPaths.Objs = depPaths.Objs.Append(objs)
2973 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
2974 reexportExporter(depExporterInfo)
2975 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002976 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09002977 }
2978
Colin Cross6e511a92020-07-27 21:26:48 -07002979 linkFile := ccDep.OutputFile()
2980
2981 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
2982 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07002983 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002984 return
2985 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002986
Jiyong Parke3867542020-12-03 17:28:25 +09002987 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
2988 return
2989 }
2990
Colin Cross0de8a1e2020-09-18 14:15:30 -07002991 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07002992
Colin Cross6e511a92020-07-27 21:26:48 -07002993 var ptr *android.Paths
2994 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07002995
Colin Cross6e511a92020-07-27 21:26:48 -07002996 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07002997
Colin Cross6e511a92020-07-27 21:26:48 -07002998 switch {
2999 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08003000 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
3001 if !ctx.Config().AllowMissingDependencies() {
3002 ctx.ModuleErrorf("module %q is not a header library", depName)
3003 } else {
3004 ctx.AddMissingDependencies([]string{depName})
3005 }
3006 return
3007 }
Colin Cross6e511a92020-07-27 21:26:48 -07003008 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07003009 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
3010 if !ctx.Config().AllowMissingDependencies() {
3011 ctx.ModuleErrorf("module %q is not a shared library", depName)
3012 } else {
3013 ctx.AddMissingDependencies([]string{depName})
3014 }
3015 return
3016 }
Jiyong Parke3867542020-12-03 17:28:25 +09003017
Jiyong Park7d55b612021-06-11 17:22:09 +09003018 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3019 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003020
Jiyong Park1ad8e162020-12-01 23:40:09 +09003021 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3022 // linkFile, depFile, and ptr.
3023 if c.IsStubs() {
3024 break
3025 }
3026
Colin Cross0de8a1e2020-09-18 14:15:30 -07003027 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3028 depFile = sharedLibraryInfo.TableOfContents
3029
Colin Cross6e511a92020-07-27 21:26:48 -07003030 ptr = &depPaths.SharedLibs
3031 switch libDepTag.Order {
3032 case earlyLibraryDependency:
3033 ptr = &depPaths.EarlySharedLibs
3034 depPtr = &depPaths.EarlySharedLibsDeps
3035 case normalLibraryDependency:
3036 ptr = &depPaths.SharedLibs
3037 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003038 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003039 case lateLibraryDependency:
3040 ptr = &depPaths.LateSharedLibs
3041 depPtr = &depPaths.LateSharedLibsDeps
3042 default:
3043 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003044 }
Colin Cross6e511a92020-07-27 21:26:48 -07003045 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07003046 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
3047 if !ctx.Config().AllowMissingDependencies() {
3048 ctx.ModuleErrorf("module %q is not a static library", depName)
3049 } else {
3050 ctx.AddMissingDependencies([]string{depName})
3051 }
3052 return
3053 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003054
3055 // Stubs lib doesn't link to the static lib dependencies. Don't set
3056 // linkFile, depFile, and ptr.
3057 if c.IsStubs() {
3058 break
3059 }
3060
Colin Cross0de8a1e2020-09-18 14:15:30 -07003061 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
3062 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003063 if libDepTag.wholeStatic {
3064 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003065 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3066 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003067 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003068 // This case normally catches prebuilt static
3069 // libraries, but it can also occur when
3070 // AllowMissingDependencies is on and the
3071 // dependencies has no sources of its own
3072 // but has a whole_static_libs dependency
3073 // on a missing library. We want to depend
3074 // on the .a file so that there is something
3075 // in the dependency tree that contains the
3076 // error rule for the missing transitive
3077 // dependency.
3078 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003079 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003080 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3081 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003082 } else {
3083 switch libDepTag.Order {
3084 case earlyLibraryDependency:
3085 panic(fmt.Errorf("early static libs not suppported"))
3086 case normalLibraryDependency:
3087 // static dependencies will be handled separately so they can be ordered
3088 // using transitive dependencies.
3089 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003090 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003091 case lateLibraryDependency:
3092 ptr = &depPaths.LateStaticLibs
3093 default:
3094 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003095 }
3096 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003097 if libDepTag.unexportedSymbols {
3098 depPaths.LdFlags = append(depPaths.LdFlags,
3099 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3100 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003101 }
3102
Colin Cross6e511a92020-07-27 21:26:48 -07003103 if libDepTag.static() && !libDepTag.wholeStatic {
3104 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3105 ctx.ModuleErrorf("module %q not a static library", depName)
3106 return
3107 }
Logan Chien43d34c32017-12-20 01:17:32 +08003108
Colin Cross6e511a92020-07-27 21:26:48 -07003109 // When combining coverage files for shared libraries and executables, coverage files
3110 // in static libraries act as if they were whole static libraries. The same goes for
3111 // source based Abi dump files.
3112 if c, ok := ccDep.(*Module); ok {
3113 staticLib := c.linker.(libraryInterface)
3114 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3115 staticLib.objs().coverageFiles...)
3116 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3117 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003118 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003119 // Handle non-CC modules here
3120 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003121 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003122 }
3123 }
3124
Colin Cross6e511a92020-07-27 21:26:48 -07003125 if ptr != nil {
3126 if !linkFile.Valid() {
3127 if !ctx.Config().AllowMissingDependencies() {
3128 ctx.ModuleErrorf("module %q missing output file", depName)
3129 } else {
3130 ctx.AddMissingDependencies([]string{depName})
3131 }
3132 return
3133 }
3134 *ptr = append(*ptr, linkFile.Path())
3135 }
3136
3137 if depPtr != nil {
3138 dep := depFile
3139 if !dep.Valid() {
3140 dep = linkFile
3141 }
3142 *depPtr = append(*depPtr, dep.Path())
3143 }
3144
Colin Cross0de8a1e2020-09-18 14:15:30 -07003145 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3146 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3147 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3148 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3149
3150 if libDepTag.reexportFlags {
3151 reexportExporter(depExporterInfo)
3152 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3153 // Re-exported shared library headers must be included as well since they can help us with type information
3154 // about template instantiations (instantiated from their headers).
3155 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3156 // scripts.
3157 c.sabi.Properties.ReexportedIncludes = append(
3158 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3159 }
3160
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003161 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003162 switch {
3163 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003164 c.Properties.AndroidMkHeaderLibs = append(
3165 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003166 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003167 if lib := moduleLibraryInterface(dep); lib != nil {
3168 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003169 // Add the dependency to the APEX(es) providing the library so that
3170 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07003171 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09003172 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003173 c.Properties.ApexesProvidingSharedLibs = append(
3174 c.Properties.ApexesProvidingSharedLibs, an)
3175 }
3176 }
3177 }
3178
3179 // Note: the order of libs in this list is not important because
3180 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003181 c.Properties.AndroidMkSharedLibs = append(
3182 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003183 // Record BaseLibName for snapshots.
3184 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003185 case libDepTag.static():
3186 if libDepTag.wholeStatic {
3187 c.Properties.AndroidMkWholeStaticLibs = append(
3188 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3189 } else {
3190 c.Properties.AndroidMkStaticLibs = append(
3191 c.Properties.AndroidMkStaticLibs, makeLibName)
3192 }
Justin Yun5e035862021-06-29 20:50:37 +09003193 // Record BaseLibName for snapshots.
3194 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003195 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003196 } else if !c.IsStubs() {
3197 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3198
Colin Cross6e511a92020-07-27 21:26:48 -07003199 switch depTag {
3200 case runtimeDepTag:
3201 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003202 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003203 // Record BaseLibName for snapshots.
3204 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003205 case objDepTag:
3206 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3207 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003208 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003209 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003210 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003211 case dynamicLinkerDepTag:
3212 depPaths.DynamicLinker = linkFile
3213 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003214 }
Colin Crossca860ac2016-01-04 14:34:37 -08003215 })
3216
Jeff Gaston294356f2017-09-27 17:05:30 -07003217 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003218 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3219 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3220 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003221
Colin Crossdd84e052017-05-17 13:44:16 -07003222 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003223 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003224 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3225 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003226 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003227 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3228 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003229 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003230 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003231 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003232
3233 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003234 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003235 }
Colin Crossdd84e052017-05-17 13:44:16 -07003236
Colin Crossca860ac2016-01-04 14:34:37 -08003237 return depPaths
3238}
3239
Jiyong Park7d55b612021-06-11 17:22:09 +09003240// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3241// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3242// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3243// has different level of updatability. For example, if a library foo in an APEX depends on a
3244// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3245// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3246// same APEX as foo, the non-stub variant of bar is used.
3247func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3248 depName := ctx.OtherModuleName(dep)
3249 depTag := ctx.OtherModuleDependencyTag(dep)
3250 libDepTag, ok := depTag.(libraryDependencyTag)
3251 if !ok || !libDepTag.shared() {
3252 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3253 }
3254
3255 thisModule, ok := ctx.Module().(android.ApexModule)
3256 if !ok {
3257 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3258 }
3259
3260 useVndk := false
3261 bootstrap := false
3262 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3263 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3264 } else {
3265 useVndk = linkable.UseVndk()
3266 bootstrap = linkable.Bootstrap()
3267 }
3268
3269 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
3270 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
3271 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
3272 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
3273
3274 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
3275 useStubs := false
3276
3277 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
3278 if !apexInfo.IsForPlatform() {
3279 // For platform libraries, use current version of LLNDK
3280 // If this is for use_vendor apex we will apply the same rules
3281 // of apex sdk enforcement below to choose right version.
3282 useStubs = true
3283 }
Jiyong Park9477c262021-06-22 20:23:05 +09003284 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3285 // If not building for APEX or the containing APEX allows the use of
3286 // platform APIs, use stubs only when it is from an APEX (and not from
3287 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3288 // bootstrap modules, always link to non-stub variant
Jiyong Park7d55b612021-06-11 17:22:09 +09003289 useStubs = dep.(android.ApexModule).NotInPlatform() && !bootstrap
3290 if useStubs {
3291 // Another exception: if this module is a test for an APEX, then
3292 // it is linked with the non-stub variant of a module in the APEX
3293 // as if this is part of the APEX.
3294 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
3295 for _, apexContents := range testFor.ApexContents {
3296 if apexContents.DirectlyInApex(depName) {
3297 useStubs = false
3298 break
3299 }
3300 }
3301 }
3302 if useStubs {
3303 // Yet another exception: If this module and the dependency are
3304 // available to the same APEXes then skip stubs between their
3305 // platform variants. This complements the test_for case above,
3306 // which avoids the stubs on a direct APEX library dependency, by
3307 // avoiding stubs for indirect test dependencies as well.
3308 //
3309 // TODO(b/183882457): This doesn't work if the two libraries have
3310 // only partially overlapping apex_available. For that test_for
3311 // modules would need to be split into APEX variants and resolved
3312 // separately for each APEX they have access to.
3313 if android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3314 useStubs = false
3315 }
3316 }
3317 } else {
3318 // If building for APEX, use stubs when the parent is in any APEX that
3319 // the child is not in.
3320 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3321 }
3322
3323 // when to use (unspecified) stubs, use the latest one.
3324 if useStubs {
3325 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3326 toUse := stubs[len(stubs)-1]
3327 sharedLibraryInfo = toUse.SharedLibraryInfo
3328 depExporterInfo = toUse.FlagExporterInfo
3329 }
3330 }
3331 return sharedLibraryInfo, depExporterInfo
3332}
3333
Colin Cross0de8a1e2020-09-18 14:15:30 -07003334// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3335// to match the topological order of the dependency tree, including any static analogues of
3336// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3337// of the transitive dependencies.
3338func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
3339 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
3340 var staticPaths android.Paths
3341 for _, staticDep := range staticDeps {
3342 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3343 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3344 }
3345 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003346 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3347 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003348 }
3349 }
3350 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3351
3352 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3353
3354 // reorder the dependencies based on transitive dependencies
3355 staticPaths = android.FirstUniquePaths(staticPaths)
3356 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3357
3358 if len(orderedStaticPaths) != len(staticPaths) {
3359 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3360 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3361 }
3362
3363 return orderedStaticPaths, transitiveStaticLibs
3364}
3365
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003366// BaseLibName trims known prefixes and suffixes
3367func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003368 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3369 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003370 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003371 return libName
3372}
3373
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003374func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003375 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003376 ccDepModule, _ := ccDep.(*Module)
3377 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003378 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003379
Justin Yuncbca3732021-02-03 19:24:13 +09003380 if ccDepModule != nil {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003381 // TODO(ivanlozano) Support snapshots for Rust-produced C library variants.
Colin Cross6e511a92020-07-27 21:26:48 -07003382 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003383 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003384 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003385
Ivan Lozanod1dec542021-05-26 15:33:11 -04003386 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003387 }
3388 }
3389
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003390 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3391 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003392 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3393 // core module instead.
3394 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003395 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003396 // The vendor and product modules in Make will have been renamed to not conflict with the
3397 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003398 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003399 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003400 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003401 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003402 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003403 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003404 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003405 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003406 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003407 } else {
3408 return libName
3409 }
3410}
3411
Colin Crossca860ac2016-01-04 14:34:37 -08003412func (c *Module) InstallInData() bool {
3413 if c.installer == nil {
3414 return false
3415 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003416 return c.installer.inData()
3417}
3418
3419func (c *Module) InstallInSanitizerDir() bool {
3420 if c.installer == nil {
3421 return false
3422 }
3423 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003424 return true
3425 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003426 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003427}
3428
Yifan Hong1b3348d2020-01-21 15:53:22 -08003429func (c *Module) InstallInRamdisk() bool {
3430 return c.InRamdisk()
3431}
3432
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003433func (c *Module) InstallInVendorRamdisk() bool {
3434 return c.InVendorRamdisk()
3435}
3436
Jiyong Parkf9332f12018-02-01 00:54:12 +09003437func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003438 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003439}
3440
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003441func (c *Module) MakeUninstallable() {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003442 if c.installer == nil {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003443 c.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003444 return
3445 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01003446 c.installer.makeUninstallable(c)
Martin Stjernholmbf37d162020-03-31 16:05:34 +01003447}
3448
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003449func (c *Module) HostToolPath() android.OptionalPath {
3450 if c.installer == nil {
3451 return android.OptionalPath{}
3452 }
3453 return c.installer.hostToolPath()
3454}
3455
Nan Zhangd4e641b2017-07-12 12:55:28 -07003456func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3457 return c.outputFile
3458}
3459
Colin Cross41955e82019-05-29 14:40:35 -07003460func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3461 switch tag {
3462 case "":
3463 if c.outputFile.Valid() {
3464 return android.Paths{c.outputFile.Path()}, nil
3465 }
3466 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003467 case "unstripped":
3468 if c.linker != nil {
3469 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3470 }
3471 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003472 default:
3473 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003474 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003475}
3476
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003477func (c *Module) static() bool {
3478 if static, ok := c.linker.(interface {
3479 static() bool
3480 }); ok {
3481 return static.static()
3482 }
3483 return false
3484}
3485
Jiyong Park379de2f2018-12-19 02:47:14 +09003486func (c *Module) staticBinary() bool {
3487 if static, ok := c.linker.(interface {
3488 staticBinary() bool
3489 }); ok {
3490 return static.staticBinary()
3491 }
3492 return false
3493}
3494
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003495func (c *Module) testBinary() bool {
3496 if test, ok := c.linker.(interface {
3497 testBinary() bool
3498 }); ok {
3499 return test.testBinary()
3500 }
3501 return false
3502}
3503
Jingwen Chen537242c2022-08-24 11:53:27 +00003504func (c *Module) testLibrary() bool {
3505 if test, ok := c.linker.(interface {
3506 testLibrary() bool
3507 }); ok {
3508 return test.testLibrary()
3509 }
3510 return false
3511}
3512
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003513func (c *Module) benchmarkBinary() bool {
3514 if b, ok := c.linker.(interface {
3515 benchmarkBinary() bool
3516 }); ok {
3517 return b.benchmarkBinary()
3518 }
3519 return false
3520}
3521
3522func (c *Module) fuzzBinary() bool {
3523 if f, ok := c.linker.(interface {
3524 fuzzBinary() bool
3525 }); ok {
3526 return f.fuzzBinary()
3527 }
3528 return false
3529}
3530
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003531// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3532func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003533 if h, ok := c.linker.(interface {
3534 header() bool
3535 }); ok {
3536 return h.header()
3537 }
3538 return false
3539}
3540
Ivan Lozanod7586b62021-04-01 09:49:36 -04003541func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003542 if b, ok := c.linker.(interface {
3543 binary() bool
3544 }); ok {
3545 return b.binary()
3546 }
3547 return false
3548}
3549
Justin Yun5e035862021-06-29 20:50:37 +09003550func (c *Module) StaticExecutable() bool {
3551 if b, ok := c.linker.(*binaryDecorator); ok {
3552 return b.static()
3553 }
3554 return false
3555}
3556
Ivan Lozanod7586b62021-04-01 09:49:36 -04003557func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003558 if o, ok := c.linker.(interface {
3559 object() bool
3560 }); ok {
3561 return o.object()
3562 }
3563 return false
3564}
3565
Ivan Lozanof9e21722020-12-02 09:00:51 -05003566func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003567 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003568 if c.IsLlndk() {
3569 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003570 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003571 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003572 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003573 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003574 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003575 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003576 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003577 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003578 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003579 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003580 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003581 return "native:product"
3582 }
Jooyung Han38002912019-05-16 04:01:54 +09003583 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003584 } else if c.InRamdisk() {
3585 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003586 } else if c.InVendorRamdisk() {
3587 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003588 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003589 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003590 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003591 return "native:ndk:none:none"
3592 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3593 //family, link := getNdkStlFamilyAndLinkType(c)
3594 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003595 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003596 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003597 } else {
3598 return "native:platform"
3599 }
3600}
3601
Jiyong Park9d452992018-10-03 00:38:19 +09003602// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003603// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003604func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003605 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003606 // Stub libs and prebuilt libs in a versioned SDK are not
3607 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003608 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003609 } else if _, ok := c.linker.(testPerSrc); ok {
3610 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003611 }
3612 return false
3613}
3614
Jiyong Parka90ca002019-10-07 15:47:24 +09003615func (c *Module) AvailableFor(what string) bool {
3616 if linker, ok := c.linker.(interface {
3617 availableFor(string) bool
3618 }); ok {
3619 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3620 } else {
3621 return c.ApexModuleBase.AvailableFor(what)
3622 }
3623}
3624
Jiyong Park62304bb2020-04-13 16:19:48 +09003625func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003626 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003627}
3628
Paul Duffin0cb37b92020-03-04 14:52:46 +00003629func (c *Module) EverInstallable() bool {
3630 return c.installer != nil &&
3631 // Check to see whether the module is actually ever installable.
3632 c.installer.everInstallable()
3633}
3634
Ivan Lozanod7586b62021-04-01 09:49:36 -04003635func (c *Module) PreventInstall() bool {
3636 return c.Properties.PreventInstall
3637}
3638
3639func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003640 if c.library != nil {
3641 if i := c.library.installable(); i != nil {
3642 return i
3643 }
3644 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003645 return c.Properties.Installable
3646}
3647
3648func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003649 ret := c.EverInstallable() &&
3650 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003651 proptools.BoolDefault(c.Installable(), true) &&
3652 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003653
3654 // The platform variant doesn't need further condition. Apex variants however might not
3655 // be installable because it will likely to be included in the APEX and won't appear
3656 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003657 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003658 return ret
3659 }
3660
3661 // Special case for modules that are configured to be installed to /data, which includes
3662 // test modules. For these modules, both APEX and non-APEX variants are considered as
3663 // installable. This is because even the APEX variants won't be included in the APEX, but
3664 // will anyway be installed to /data/*.
3665 // See b/146995717
3666 if c.InstallInData() {
3667 return ret
3668 }
3669
3670 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003671}
3672
Logan Chien41eabe62019-04-10 13:33:58 +08003673func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3674 if c.linker != nil {
3675 if library, ok := c.linker.(*libraryDecorator); ok {
3676 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3677 }
3678 }
3679}
3680
Jiyong Park45bf82e2020-12-15 22:29:02 +09003681var _ android.ApexModule = (*Module)(nil)
3682
3683// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003684func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003685 depTag := ctx.OtherModuleDependencyTag(dep)
3686 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3687
3688 if cc, ok := dep.(*Module); ok {
3689 if cc.HasStubsVariants() {
3690 if isLibDepTag && libDepTag.shared() {
3691 // dynamic dep to a stubs lib crosses APEX boundary
3692 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003693 }
Colin Cross6e511a92020-07-27 21:26:48 -07003694 if IsRuntimeDepTag(depTag) {
3695 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003696 return false
3697 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003698 }
Zhijun Heec285872021-04-24 10:47:08 -07003699 if cc.IsLlndk() {
3700 return false
3701 }
Colin Crossaac32222020-07-29 12:51:56 -07003702 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003703 // shared_lib dependency from a static lib is considered as crossing
3704 // the APEX boundary because the dependency doesn't actually is
3705 // linked; the dependency is used only during the compilation phase.
3706 return false
3707 }
Jiyong Parke3867542020-12-03 17:28:25 +09003708
3709 if isLibDepTag && libDepTag.excludeInApex {
3710 return false
3711 }
Colin Cross6e511a92020-07-27 21:26:48 -07003712 }
Colin Crossc1b36442021-05-06 13:42:48 -07003713 if depTag == stubImplDepTag {
3714 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003715 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003716 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003717 if depTag == staticVariantTag {
3718 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3719 // actually mean that the static lib (and its dependencies) are copied into the
3720 // APEX.
3721 return false
3722 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003723 return true
3724}
3725
Jiyong Park45bf82e2020-12-15 22:29:02 +09003726// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003727func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3728 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003729 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3730 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3731 return nil
3732 }
Jooyung Han749dc692020-04-15 11:03:39 +09003733 // We don't check for prebuilt modules
3734 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3735 return nil
3736 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003737
Jooyung Han749dc692020-04-15 11:03:39 +09003738 minSdkVersion := c.MinSdkVersion()
3739 if minSdkVersion == "apex_inherit" {
3740 return nil
3741 }
3742 if minSdkVersion == "" {
3743 // JNI libs within APK-in-APEX fall into here
3744 // Those are okay to set sdk_version instead
3745 // We don't have to check if this is a SDK variant because
3746 // non-SDK variant resets sdk_version, which works too.
3747 minSdkVersion = c.SdkVersion()
3748 }
Dan Albertc8060532020-07-22 22:32:17 -07003749 if minSdkVersion == "" {
3750 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3751 }
3752 // Not using nativeApiLevelFromUser because the context here is not
3753 // necessarily a native context.
3754 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003755 if err != nil {
3756 return err
3757 }
Dan Albertc8060532020-07-22 22:32:17 -07003758
Colin Cross8ca61c12022-10-06 21:00:14 -07003759 // A dependency only needs to support a min_sdk_version at least
3760 // as high as the api level that the architecture was introduced in.
3761 // This allows introducing new architectures in the platform that
3762 // need to be included in apexes that normally require an older
3763 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003764 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003765 if sdkVersion.LessThan(minApiForArch) {
3766 sdkVersion = minApiForArch
3767 }
3768
Dan Albertc8060532020-07-22 22:32:17 -07003769 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003770 return fmt.Errorf("newer SDK(%v)", ver)
3771 }
3772 return nil
3773}
3774
Paul Duffinb5769c12021-05-12 16:16:51 +01003775// Implements android.ApexModule
3776func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3777 // stub libraries and native bridge libraries are always available to platform
3778 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3779}
3780
Jooyung Han91f92032022-02-04 12:36:33 +09003781// Overrides android.ApexModuleBase.UniqueApexVariations
3782func (c *Module) UniqueApexVariations() bool {
3783 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
3784 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
3785 // variation of the VNDK lib because APEX variations are merged/grouped.
3786 return c.UseVndk() && c.IsVndk()
3787}
3788
Inseob Kima1888ce2022-10-04 14:42:02 +09003789func (c *Module) overriddenModules() []string {
3790 if o, ok := c.linker.(overridable); ok {
3791 return o.overriddenModules()
3792 }
3793 return nil
3794}
3795
Rob Seymour925aa092021-08-10 20:42:03 +00003796var _ snapshot.RelativeInstallPath = (*Module)(nil)
3797
Liz Kammer35ca77e2021-12-22 15:31:40 -05003798type moduleType int
3799
3800const (
3801 unknownType moduleType = iota
3802 binary
3803 object
3804 fullLibrary
3805 staticLibrary
3806 sharedLibrary
3807 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00003808 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00003809 ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05003810)
3811
3812func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00003813 if c.testBinary() {
3814 // testBinary is also a binary, so this comes before the c.Binary()
3815 // conditional. A testBinary has additional implicit dependencies and
3816 // other test-only semantics.
3817 return testBin
3818 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003819 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003820 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003821 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00003822 } else if c.testLibrary() {
3823 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
3824 // will let them add implicit compile deps on gtest, for example.
3825 //
3826 // For now, treat them as regular shared libraries.
3827 return sharedLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003828 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05003829 static := false
3830 shared := false
3831 if library, ok := c.linker.(*libraryDecorator); ok {
3832 static = library.MutatedProperties.BuildStatic
3833 shared = library.MutatedProperties.BuildShared
3834 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
3835 static = library.MutatedProperties.BuildStatic
3836 shared = library.MutatedProperties.BuildShared
3837 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003838 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003839 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003840 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003841 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003842 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003843 return staticLibrary
3844 }
3845 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00003846 } else if c.isNDKStubLibrary() {
3847 return ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05003848 }
3849 return unknownType
3850}
3851
3852// ConvertWithBp2build converts Module to Bazel for bp2build.
3853func (c *Module) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
3854 prebuilt := c.IsPrebuilt()
3855 switch c.typ() {
3856 case binary:
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +00003857 if prebuilt {
3858 prebuiltBinaryBp2Build(ctx, c)
3859 } else {
Jingwen Chen537242c2022-08-24 11:53:27 +00003860 binaryBp2build(ctx, c)
3861 }
3862 case testBin:
3863 if !prebuilt {
3864 testBinaryBp2build(ctx, c)
Liz Kammer35ca77e2021-12-22 15:31:40 -05003865 }
3866 case object:
Colin Crossc5075e92022-12-05 16:46:39 -08003867 if prebuilt {
3868 prebuiltObjectBp2Build(ctx, c)
3869 } else {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003870 objectBp2Build(ctx, c)
3871 }
3872 case fullLibrary:
3873 if !prebuilt {
3874 libraryBp2Build(ctx, c)
Trevor Radcliffe58ea4512022-04-07 20:36:39 +00003875 } else {
3876 prebuiltLibraryBp2Build(ctx, c)
Liz Kammer35ca77e2021-12-22 15:31:40 -05003877 }
3878 case headerLibrary:
3879 libraryHeadersBp2Build(ctx, c)
3880 case staticLibrary:
Liz Kammer35ca77e2021-12-22 15:31:40 -05003881 if prebuilt {
Trevor Radcliffe58ea4512022-04-07 20:36:39 +00003882 prebuiltLibraryStaticBp2Build(ctx, c, false)
Liz Kammer35ca77e2021-12-22 15:31:40 -05003883 } else {
3884 sharedOrStaticLibraryBp2Build(ctx, c, true)
3885 }
3886 case sharedLibrary:
3887 if prebuilt {
3888 prebuiltLibrarySharedBp2Build(ctx, c)
3889 } else {
3890 sharedOrStaticLibraryBp2Build(ctx, c, false)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003891 }
Spandan Das8b4a5f32022-09-29 00:28:24 +00003892 }
3893}
3894
3895var _ android.ApiProvider = (*Module)(nil)
3896
3897func (c *Module) ConvertWithApiBp2build(ctx android.TopDownMutatorContext) {
Spandan Das4238c652022-09-09 01:38:47 +00003898 if c.IsPrebuilt() {
3899 return
3900 }
Spandan Das8b4a5f32022-09-29 00:28:24 +00003901 switch c.typ() {
Spandan Das4238c652022-09-09 01:38:47 +00003902 case fullLibrary:
3903 apiContributionBp2Build(ctx, c)
3904 case sharedLibrary:
3905 apiContributionBp2Build(ctx, c)
3906 case headerLibrary:
3907 // Aggressively generate api targets for all header modules
3908 // This is necessary since the header module does not know if it is a dep of API surface stub library
3909 apiLibraryHeadersBp2Build(ctx, c)
Spandan Das1278c2c2022-08-19 18:17:28 +00003910 case ndkLibrary:
3911 ndkLibraryBp2build(ctx, c)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003912 }
3913}
3914
Colin Crosscfad1192015-11-02 16:43:11 -08003915// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08003916type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003917 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003918 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003919 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003920}
3921
Patrice Arrudac249c712019-03-19 17:00:29 -07003922// cc_defaults provides a set of properties that can be inherited by other cc
3923// modules. A module can use the properties from a cc_defaults using
3924// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3925// merged (when possible) by prepending the default module's values to the
3926// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003927func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003928 return DefaultsFactory()
3929}
3930
Colin Cross36242852017-06-23 15:06:31 -07003931func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003932 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003933
Colin Cross36242852017-06-23 15:06:31 -07003934 module.AddProperties(props...)
3935 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003936 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003937 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003938 &BaseCompilerProperties{},
3939 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003940 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003941 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003942 &StaticProperties{},
3943 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003944 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003945 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00003946 &TestLinkerProperties{},
3947 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003948 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003949 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07003950 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003951 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003952 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003953 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003954 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003955 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003956 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003957 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09003958 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003959 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08003960 &AfdoProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07003961 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003962 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003963 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3964 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07003965 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003966 )
Colin Crosscfad1192015-11-02 16:43:11 -08003967
Jooyung Hancc372c52019-09-25 15:18:44 +09003968 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003969
3970 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003971}
3972
Jiyong Park2286afd2020-06-16 21:58:53 +09003973func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003974 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003975}
3976
Kiyoung Kim51279d32022-08-24 14:10:46 +09003977func (c *Module) isImportedApiLibrary() bool {
3978 _, ok := c.linker.(*apiLibraryDecorator)
3979 return ok
3980}
3981
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003982func kytheExtractAllFactory() android.Singleton {
3983 return &kytheExtractAllSingleton{}
3984}
3985
3986type kytheExtractAllSingleton struct {
3987}
3988
3989func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3990 var xrefTargets android.Paths
3991 ctx.VisitAllModules(func(module android.Module) {
3992 if ccModule, ok := module.(xref); ok {
3993 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3994 }
3995 })
3996 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3997 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003998 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003999 }
4000}
4001
Jihoon Kangf78a8902022-09-01 22:47:07 +00004002func (c *Module) Partition() string {
4003 if p, ok := c.installer.(interface {
4004 getPartition() string
4005 }); ok {
4006 return p.getPartition()
4007 }
4008 return ""
4009}
4010
Colin Cross06a931b2015-10-28 17:23:31 -07004011var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004012var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004013var BoolPtr = proptools.BoolPtr
4014var String = proptools.String
4015var StringPtr = proptools.StringPtr