blob: 3688e9573181bbde412580cb05782ce5ee00aeb4 [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
Aditya Choudhary87b2ab22023-11-17 15:27:06 +000027 "android/soong/testing"
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +090028
Colin Cross97ba0732015-03-23 17:50:24 -070029 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070030 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070031
Vinh Tran367d89d2023-04-28 11:21:25 -040032 "android/soong/aidl_library"
Colin Cross635c3b02016-05-18 15:37:25 -070033 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070034 "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070035 "android/soong/fuzz"
Colin Cross5049f022015-03-18 13:28:46 -070036 "android/soong/genrule"
Kiyoung Kim487689e2022-07-26 09:48:22 +090037 "android/soong/multitree"
Rob Seymour925aa092021-08-10 20:42:03 +000038 "android/soong/snapshot"
Colin Cross3f40fa42015-01-30 17:27:36 -080039)
40
Colin Cross463a90e2015-06-17 14:20:06 -070041func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000042 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070043
Inseob Kim3b244062023-07-11 13:31:36 +090044 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +000045 pctx.Import("android/soong/cc/config")
46}
47
48func RegisterCCBuildComponents(ctx android.RegistrationContext) {
49 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
50
51 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000052 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090053 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070054 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010055 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070056 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070057 ctx.BottomUp("begin", BeginMutator).Parallel()
Colin Crossd38feb02024-01-23 16:38:06 -080058 ctx.BottomUp("fdo_profile", fdoProfileMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070059 })
Colin Cross16b23492016-01-06 14:41:07 -080060
Paul Duffin036e7002019-12-19 19:16:28 +000061 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040062 for _, san := range Sanitizers {
63 san.registerMutators(ctx)
64 }
Dan Willemsen581341d2017-02-09 16:16:31 -080065
Colin Cross0b908332019-06-19 23:00:20 -070066 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090067 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080068
Cory Barkera1da26f2022-06-07 20:12:06 +000069 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000070
Colin Crossf5f4ad32024-01-19 15:41:48 -080071 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -070072
Colin Crossd38feb02024-01-23 16:38:06 -080073 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +080074
Colin Cross33e0c812024-01-23 16:36:07 -080075 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000076
Colin Cross6ac83a82024-01-23 11:23:10 -080077 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +090078
Jooyung Han479ca172020-10-19 18:51:07 +090079 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090080 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070081 })
Colin Crossb98c8b02016-07-29 13:44:28 -070082
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080083 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
84 // sabi mutator needs to be run after apex mutator finishes.
85 ctx.TopDown("sabi_deps", sabiDepsMutator)
86 })
87
LaMont Jones0c10e4d2023-05-16 00:58:37 +000088 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070089}
90
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050091// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
92// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
93// edges to these modules.
94// This object is constructed in DepsMutator, by calling to various module delegates to set
95// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
96// dependencies.
97// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
98// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080099type Deps struct {
100 SharedLibs, LateSharedLibs []string
101 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800102 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800103 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700104
Colin Cross3e5e7782022-06-17 22:17:05 +0000105 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
106 // prevent automatically exporting symbols.
107 UnexportedStaticLibs []string
108
Chris Parsons79d66a52020-06-05 17:26:16 -0400109 // Used for data dependencies adjacent to tests
110 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700111 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400112
Yo Chiang219968c2020-09-22 18:45:04 +0800113 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
114 SystemSharedLibs []string
115
Vinh Tran367d89d2023-04-28 11:21:25 -0400116 // Used by DepMutator to pass aidl_library modules to aidl compiler
117 AidlLibs []string
118
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500119 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800120 StaticUnwinderIfLegacy bool
121
Colin Cross5950f382016-12-13 12:50:57 -0800122 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700123
Colin Cross81413472016-04-11 14:37:39 -0700124 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700125
Dan Willemsenb40aab62016-04-20 14:21:14 -0700126 GeneratedSources []string
127 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900128 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700129
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700130 ReexportGeneratedHeaders []string
131
Colin Crossc465efd2021-06-11 18:00:04 -0700132 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700133
134 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700135 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900136
137 // List of libs that need to be excluded for APEX variant
138 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900139 // List of libs that need to be excluded for non-APEX variant
140 ExcludeLibsForNonApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700141}
142
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500143// PathDeps is a struct containing file paths to dependencies of a module.
144// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
145// It's used to construct flags for various build statements (such as for compiling and linking).
146// It is then passed to module decorator functions responsible for registering build statements
147// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800148type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700149 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900150 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700151 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900152 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700153 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700154 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700155
Colin Cross0de8a1e2020-09-18 14:15:30 -0700156 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700157 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700158
Colin Cross26c34ed2016-09-30 17:10:16 -0700159 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100160 Objs Objects
161 // Paths to .o files in dependencies that provide them. Note that these lists
162 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800163 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700164 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700165
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100166 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
167 // the libs from all whole_static_lib dependencies.
168 WholeStaticLibsFromPrebuilts android.Paths
169
Colin Cross26c34ed2016-09-30 17:10:16 -0700170 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700171 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900172 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700173
Inseob Kimd110f872019-12-06 13:15:38 +0900174 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000175 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900176 IncludeDirs android.Paths
177 SystemIncludeDirs android.Paths
178 ReexportedDirs android.Paths
179 ReexportedSystemDirs android.Paths
180 ReexportedFlags []string
181 ReexportedGeneratedHeaders android.Paths
182 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700183
Colin Cross26c34ed2016-09-30 17:10:16 -0700184 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700185 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700186
Dan Willemsena0790e32018-10-12 00:24:23 -0700187 // Path to the dynamic linker binary
188 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700189
190 // For Darwin builds, the path to the second architecture's output that should
191 // be combined with this architectures's output into a FAT MachO file.
192 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400193
194 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
195 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700196}
197
Colin Cross4af21ed2019-11-04 09:37:55 -0800198// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
199// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
200// command line so they can be overridden by the local module flags).
201type LocalOrGlobalFlags struct {
202 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700203 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800204 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700205 CFlags []string // Flags that apply to C and C++ source files
206 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
207 ConlyFlags []string // Flags that apply to C source files
208 CppFlags []string // Flags that apply to C++ source files
209 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700210 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800211}
212
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500213// Flags contains various types of command line flags (and settings) for use in building build
214// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800215type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500216 // Local flags (which individual modules are responsible for). These may override global flags.
217 Local LocalOrGlobalFlags
218 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800219 Global LocalOrGlobalFlags
220
221 aidlFlags []string // Flags that apply to aidl source files
222 rsFlags []string // Flags that apply to renderscript source files
223 libFlags []string // Flags to add libraries early to the link order
224 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
225 TidyFlags []string // Flags that apply to clang-tidy
226 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700227
Colin Crossc3199482017-03-30 15:03:04 -0700228 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800229 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700230 SystemIncludeFlags []string
231
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800232 Toolchain config.Toolchain
233 Tidy bool // True if ninja .tidy rules should be generated.
234 NeedTidyFiles bool // True if module link should depend on .tidy files
235 GcovCoverage bool // True if coverage files should be generated.
236 SAbiDump bool // True if header abi dumps should be generated.
237 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800238
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500239 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800240 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500241 // The target-device system path to the dynamic linker.
242 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800243
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700244 CFlagsDeps android.Paths // Files depended on by compiler flags
245 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800246
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500247 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700248 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800249
Colin Cross19878da2019-03-28 14:45:07 -0700250 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700251 protoC bool // Whether to use C instead of C++
252 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700253
254 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200255 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700256}
257
Colin Crossca860ac2016-01-04 14:34:37 -0800258// Properties used to compile all C or C++ modules
259type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700260 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800261 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700262
Jiyong Parkb35a8192020-08-10 15:59:36 +0900263 // The API level that this module is built against. The APIs of this API level will be
264 // visible at build time, but use of any APIs newer than min_sdk_version will render the
265 // module unloadable on older devices. In the future it will be possible to weakly-link new
266 // APIs, making the behavior match Java: such modules will load on older devices, but
267 // calling new APIs on devices that do not support them will result in a crash.
268 //
269 // This property has the same behavior as sdk_version does for Java modules. For those
270 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
271 // does for Java code.
272 //
273 // In addition, setting this property causes two variants to be built, one for the platform
274 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800275 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700276
Jiyong Parkb35a8192020-08-10 15:59:36 +0900277 // Minimum OS API level supported by this C or C++ module. This property becomes the value
278 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
279 // this property is also used to ensure that the min_sdk_version of the containing module is
280 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
281 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
282 // min_sdk_version of the containing APEX. When the module
283 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900284 Min_sdk_version *string
285
Colin Crossc511bc52020-04-07 16:50:32 +0000286 // If true, always create an sdk variant and don't create a platform variant.
287 Sdk_variant_only *bool
288
Jiyong Parkde866cb2018-12-07 23:08:36 +0900289 AndroidMkSharedLibs []string `blueprint:"mutated"`
290 AndroidMkStaticLibs []string `blueprint:"mutated"`
291 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
292 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700293 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900294 HideFromMake bool `blueprint:"mutated"`
295 PreventInstall bool `blueprint:"mutated"`
296 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700297
Yo Chiang219968c2020-09-22 18:45:04 +0800298 // Set by DepsMutator.
299 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
300
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900301 // The name of the image this module is built for
302 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200303
304 // The VNDK version this module is built against. If empty, the module is not
305 // build against the VNDK.
306 VndkVersion string `blueprint:"mutated"`
307
308 // Suffix for the name of Android.mk entries generated by this module
309 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800310
311 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
312 // file
313 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900314
Yifan Hong39143a92020-10-26 12:43:12 -0700315 // Make this module available when building for ramdisk.
316 // On device without a dedicated recovery partition, the module is only
317 // available after switching root into
318 // /first_stage_ramdisk. To expose the module before switching root, install
319 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800320 Ramdisk_available *bool
321
Yifan Hong39143a92020-10-26 12:43:12 -0700322 // Make this module available when building for vendor ramdisk.
323 // On device without a dedicated recovery partition, the module is only
324 // available after switching root into
325 // /first_stage_ramdisk. To expose the module before switching root, install
326 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700327 Vendor_ramdisk_available *bool
328
Jiyong Parkf9332f12018-02-01 00:54:12 +0900329 // Make this module available when building for recovery
330 Recovery_available *bool
331
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200332 // Used by imageMutator, set by ImageMutatorBegin()
333 CoreVariantNeeded bool `blueprint:"mutated"`
334 RamdiskVariantNeeded bool `blueprint:"mutated"`
335 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
336 RecoveryVariantNeeded bool `blueprint:"mutated"`
337
338 // A list of variations for the "image" mutator of the form
339 //<image name> '.' <version char>, for example, 'vendor.S'
340 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900341
342 // Allows this module to use non-APEX version of libraries. Useful
343 // for building binaries that are started before APEXes are activated.
344 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900345
346 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
347 // see soong/cc/config/vndk.go
348 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900349
350 // Used by vendor snapshot to record dependencies from snapshot modules.
351 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900352 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900353 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000354
Colin Cross1bc94122021-10-28 13:25:54 -0700355 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000356
357 // Set by factories of module types that can only be referenced from variants compiled against
358 // the SDK.
359 AlwaysSdk bool `blueprint:"mutated"`
360
361 // Variant is an SDK variant created by sdkMutator
362 IsSdkVariant bool `blueprint:"mutated"`
363 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
364 // variant to have a ".sdk" suffix.
365 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700366
367 // Normally Soong uses the directory structure to decide which modules
368 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800369 // different snapshots (vendor, recovery, etc.), but this property
370 // allows a partner to exclude a module normally thought of as a
371 // framework module from the vendor snapshot.
372 Exclude_from_vendor_snapshot *bool
373
374 // Normally Soong uses the directory structure to decide which modules
375 // should be included (framework) or excluded (non-framework) from the
376 // different snapshots (vendor, recovery, etc.), but this property
377 // allows a partner to exclude a module normally thought of as a
378 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800379 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900380
381 // List of APEXes that this module has private access to for testing purpose. The module
382 // can depend on libraries that are not exported by the APEXes and use private symbols
383 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000384 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800385
386 Target struct {
387 Platform struct {
388 // List of modules required by the core variant.
389 Required []string `android:"arch_variant"`
390
391 // List of modules not required by the core variant.
392 Exclude_required []string `android:"arch_variant"`
393 } `android:"arch_variant"`
394
395 Recovery struct {
396 // List of modules required by the recovery variant.
397 Required []string `android:"arch_variant"`
398
399 // List of modules not required by the recovery variant.
400 Exclude_required []string `android:"arch_variant"`
401 } `android:"arch_variant"`
402 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700403}
404
405type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900406 // whether this module should be allowed to be directly depended by other
407 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900408 // If set to true, two variants will be built separately, one like
409 // normal, and the other limited to the set of libraries and headers
410 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700411 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900412 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700413 // so it shouldn't have any unversioned runtime dependencies, or
414 // make assumptions about the system that may not be true in the
415 // future.
416 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900417 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900418 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900419 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900420 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900421 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700422 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
423 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900424
Justin Yunebcf0c52021-01-08 18:00:19 +0900425 // This is the same as the "vendor_available" except that the install path
426 // of the vendor variant is /odm or /vendor/odm.
427 // By replacing "vendor_available: true" with "odm_available: true", the
428 // module will install its vendor variant to the /odm partition or /vendor/odm.
429 // As the modules with "odm_available: true" still create the vendor variants,
430 // they can link to the other vendor modules as the vendor_available modules do.
431 // Also, the vendor modules can link to odm_available modules.
432 //
433 // It may not be used for VNDK modules.
434 Odm_available *bool
435
Justin Yun63e9ec72020-10-29 16:49:43 +0900436 // whether this module should be allowed to be directly depended by other
437 // modules with `product_specific: true` or `product_available: true`.
438 // If set to true, an additional product variant will be built separately
439 // that is limited to the set of libraries and headers that are exposed to
440 // /product modules.
441 //
442 // The product variant may be used with a different (newer) /system,
443 // so it shouldn't have any unversioned runtime dependencies, or
444 // make assumptions about the system that may not be true in the
445 // future.
446 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900447 // If set to false, this module becomes inaccessible from /product modules.
448 //
449 // Different from the 'vendor_available' property, the modules with
450 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
451 // library without 'product_available' may not be depended on by any other
452 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900453 //
454 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
455 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
456 Product_available *bool
457
Jiyong Park5fb8c102018-04-09 12:03:06 +0900458 // whether this module is capable of being loaded with other instance
459 // (possibly an older version) of the same module in the same process.
460 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
461 // can be double loaded in a vendor process if the library is also a
462 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
463 // explicitly marked as `double_loadable: true` by the owner, or the dependency
464 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
465 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800466
467 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
468 IsLLNDK bool `blueprint:"mutated"`
469
Colin Cross78212242021-01-06 14:51:30 -0800470 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
471 // set and the module is not listed in VndkMustUseVendorVariantList.
472 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
473
474 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
475 IsVNDKCore bool `blueprint:"mutated"`
476
477 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
478 IsVNDKSP bool `blueprint:"mutated"`
479
480 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
481 // module sets the llndk.private property.
482 IsVNDKPrivate bool `blueprint:"mutated"`
483
484 // IsVNDKProduct is set if a VNDK module sets the product_available property.
485 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700486
487 // IsVendorPublicLibrary is set for the core and product variants of a library that has
488 // vendor_public_library stubs.
489 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800490}
491
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500492// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
493// to understanding details about the type of the current module.
494// For example, one might call these functions to determine whether the current module is a static
495// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800496type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800497 static() bool
498 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700499 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800500 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900501 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900502 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900503 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700504 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900505 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700506 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800507 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900508 minSdkVersion() string
509 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700510 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700511 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800512 IsLlndk() bool
513 IsLlndkPublic() bool
514 isImplementationForLLNDKPublic() bool
515 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900516 isVndk() bool
517 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500518 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700519 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900520 inProduct() bool
521 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800522 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700523 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900524 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900525 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700526 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700527 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800528 getVndkExtendsModuleName() string
Yi Kong4ef54592022-02-14 20:00:10 +0800529 isAfdoCompile() bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000530 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800531 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900532 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800533 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800534 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800535 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700536 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700537 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900538 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800539 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700540 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700541 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800542 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800543 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800544 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800545 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800546}
547
548type SharedFlags struct {
549 numSharedFlags int
550 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800551}
552
553type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700554 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800555 ModuleContextIntf
556}
557
558type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700559 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800560 ModuleContextIntf
561}
562
Colin Cross37047f12016-12-13 17:06:13 -0800563type DepsContext interface {
564 android.BottomUpMutatorContext
565 ModuleContextIntf
566}
567
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500568// feature represents additional (optional) steps to building cc-related modules, such as invocation
569// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800570type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800571 flags(ctx ModuleContext, flags Flags) Flags
572 props() []interface{}
573}
574
Joe Onorato37f900c2023-07-18 16:58:16 -0700575// Information returned from Generator about the source code it's generating
576type GeneratedSource struct {
577 IncludeDirs android.Paths
578 Sources android.Paths
579 Headers android.Paths
580 ReexportedDirs android.Paths
581}
582
583// generator allows injection of generated code
584type Generator interface {
585 GeneratorProps() []interface{}
586 GeneratorInit(ctx BaseModuleContext)
587 GeneratorDeps(ctx DepsContext, deps Deps) Deps
588 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
589 GeneratorSources(ctx ModuleContext) GeneratedSource
590 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
591}
592
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500593// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500594// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800595type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700596 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800597 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800598 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700599 compilerProps() []interface{}
600
Colin Cross76fada02016-07-27 10:31:13 -0700601 appendCflags([]string)
602 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700603 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800604}
605
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500606// linker is the interface for a linker decorator object. Individual module types can provide
607// their own implementation for this decorator, and thus specify custom logic regarding build
608// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800609type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700610 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800611 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700612 linkerFlags(ctx ModuleContext, flags Flags) Flags
613 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800614 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700615
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700616 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700617 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900618 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800619 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700620
621 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900622 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000623
624 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000625 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800626
627 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000628}
629
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500630// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000631type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500632 sharedLibs []string
633 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
634 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700635 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800636}
637
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500638// installer is the interface for an installer helper object. This helper is responsible for
639// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800640type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700641 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700642 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000643 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800644 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700645 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700646 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900647 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000648 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900649 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800650}
651
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800652type xref interface {
653 XrefCcFiles() android.Paths
654}
655
Inseob Kima1888ce2022-10-04 14:42:02 +0900656type overridable interface {
657 overriddenModules() []string
658}
659
Colin Cross6e511a92020-07-27 21:26:48 -0700660type libraryDependencyKind int
661
662const (
663 headerLibraryDependency = iota
664 sharedLibraryDependency
665 staticLibraryDependency
666)
667
668func (k libraryDependencyKind) String() string {
669 switch k {
670 case headerLibraryDependency:
671 return "headerLibraryDependency"
672 case sharedLibraryDependency:
673 return "sharedLibraryDependency"
674 case staticLibraryDependency:
675 return "staticLibraryDependency"
676 default:
677 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
678 }
679}
680
681type libraryDependencyOrder int
682
683const (
684 earlyLibraryDependency = -1
685 normalLibraryDependency = 0
686 lateLibraryDependency = 1
687)
688
689func (o libraryDependencyOrder) String() string {
690 switch o {
691 case earlyLibraryDependency:
692 return "earlyLibraryDependency"
693 case normalLibraryDependency:
694 return "normalLibraryDependency"
695 case lateLibraryDependency:
696 return "lateLibraryDependency"
697 default:
698 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
699 }
700}
701
702// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
703// tags that have a set of predefined tag objects that are reused for each dependency, a
704// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
705// That means that comparing a libraryDependencyTag for equality will only be equal if all
706// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
707// then check individual metadata fields instead.
708type libraryDependencyTag struct {
709 blueprint.BaseDependencyTag
710
711 // These are exported so that fmt.Printf("%#v") can call their String methods.
712 Kind libraryDependencyKind
713 Order libraryDependencyOrder
714
715 wholeStatic bool
716
717 reexportFlags bool
718 explicitlyVersioned bool
719 dataLib bool
720 ndk bool
721
722 staticUnwinder bool
723
724 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900725
Cindy Zhou18417cb2020-12-10 07:12:38 -0800726 // Whether or not this dependency should skip the apex dependency check
727 skipApexAllowedDependenciesCheck bool
728
Jiyong Parke3867542020-12-03 17:28:25 +0900729 // Whether or not this dependency has to be followed for the apex variants
730 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900731 // Whether or not this dependency has to be followed for the non-apex variants
732 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000733
734 // If true, don't automatically export symbols from the static library into a shared library.
735 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700736}
737
738// header returns true if the libraryDependencyTag is tagging a header lib dependency.
739func (d libraryDependencyTag) header() bool {
740 return d.Kind == headerLibraryDependency
741}
742
743// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
744func (d libraryDependencyTag) shared() bool {
745 return d.Kind == sharedLibraryDependency
746}
747
748// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
749func (d libraryDependencyTag) static() bool {
750 return d.Kind == staticLibraryDependency
751}
752
Colin Cross65cb3142021-12-10 23:05:02 +0000753func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
754 if d.shared() {
755 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
756 }
757 return nil
758}
759
760var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
761
Colin Crosse9fe2942020-11-10 18:12:15 -0800762// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
763// binaries or other shared libraries are installed as dependencies.
764func (d libraryDependencyTag) InstallDepNeeded() bool {
765 return d.shared()
766}
767
768var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
769
770// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700771// libraryDependencyTag. Each tag object is created globally and reused for multiple
772// dependencies (although since the object contains no references, assigning a tag to a
773// variable and modifying it will not modify the original). Users can compare the tag
774// returned by ctx.OtherModuleDependencyTag against the global original
775type dependencyTag struct {
776 blueprint.BaseDependencyTag
777 name string
778}
779
Colin Crosse9fe2942020-11-10 18:12:15 -0800780// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
781// libraryDependencyTag, but where the dependency needs to be installed when the parent is
782// installed.
783type installDependencyTag struct {
784 blueprint.BaseDependencyTag
785 android.InstallAlwaysNeededDependencyTag
786 name string
787}
788
Colin Crossc99deeb2016-04-11 15:06:20 -0700789var (
Colin Cross6e511a92020-07-27 21:26:48 -0700790 genSourceDepTag = dependencyTag{name: "gen source"}
791 genHeaderDepTag = dependencyTag{name: "gen header"}
792 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
793 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900794 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700795 reuseObjTag = dependencyTag{name: "reuse objects"}
796 staticVariantTag = dependencyTag{name: "static variant"}
797 vndkExtDepTag = dependencyTag{name: "vndk extends"}
798 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700799 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800800 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700801 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700802 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000803 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500804 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400805 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700806)
807
Roland Levillainf89cd092019-07-29 16:22:59 +0100808func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700809 ccLibDepTag, ok := depTag.(libraryDependencyTag)
810 return ok && ccLibDepTag.shared()
811}
812
813func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
814 ccLibDepTag, ok := depTag.(libraryDependencyTag)
815 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100816}
817
Zach Johnson3df4e632020-11-06 11:56:27 -0800818func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
819 ccLibDepTag, ok := depTag.(libraryDependencyTag)
820 return ok && ccLibDepTag.header()
821}
822
Roland Levillainf89cd092019-07-29 16:22:59 +0100823func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800824 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100825}
826
827func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700828 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100829 return ok && ccDepTag == testPerSrcDepTag
830}
831
Colin Crossca860ac2016-01-04 14:34:37 -0800832// Module contains the properties and members used by all C/C++ module types, and implements
833// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500834// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
835// interface.
836//
837// To define a C/C++ related module, construct a new Module object and point its delegates to
838// type-specific structs. These delegates will be invoked to register module-specific build
839// statements which may be unique to the module type. For example, module.compiler.compile() should
840// be defined so as to register build statements which are responsible for compiling the module.
841//
842// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
843// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
844// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
845// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800846type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700847 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700848
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700849 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700850 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700851
Colin Crossca860ac2016-01-04 14:34:37 -0800852 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000853 hod android.HostOrDeviceSupported
854 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000855 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700856
Paul Duffina0843f62019-12-13 19:50:38 +0000857 // Allowable SdkMemberTypes of this module type.
858 sdkMemberTypes []android.SdkMemberType
859
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500860 // decorator delegates, initialize before calling Init
861 // these may contain module-specific implementations, and effectively allow for custom
862 // type-specific logic. These members may reference different objects or the same object.
863 // Functions of these decorators will be invoked to initialize and register type-specific
864 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800865 generators []Generator
866 compiler compiler
867 linker linker
868 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500869
Spandan Dase12d2522023-09-12 21:42:31 +0000870 features []feature
871 stl *stl
872 sanitize *sanitize
873 coverage *coverage
874 fuzzer *fuzzer
875 sabi *sabi
876 vndkdep *vndkdep
877 lto *lto
878 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000879 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800880
Colin Cross31076b32020-10-23 17:22:06 -0700881 library libraryInterface
882
Colin Cross635c3b02016-05-18 15:37:25 -0700883 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800884
Colin Crossb98c8b02016-07-29 13:44:28 -0700885 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700886
887 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800888
889 // Flags used to compile this module
890 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700891
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800892 // Shared flags among build rules of this module
893 sharedFlags SharedFlags
894
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800895 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700896 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900897
898 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800899 // Kythe (source file indexer) paths for this compilation module
900 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700901 // Object .o file output paths for this compilation module
902 objFiles android.Paths
903 // Tidy .tidy file output paths for this compilation module
904 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900905
906 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700907 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700908
909 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800910
911 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800912 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700913}
914
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200915func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400916 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
917 if b, ok := c.compiler.(*baseCompiler); ok {
918 hasAidl = b.hasSrcExt(".aidl")
919 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
920 hasProto = b.hasSrcExt(".proto")
921 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
922 hasSysprop = b.hasSrcExt(".sysprop")
923 hasWinMsg = b.hasSrcExt(".mc")
924 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
925 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200926 c.AndroidModuleBase().AddJSONData(d)
927 (*d)["Cc"] = map[string]interface{}{
928 "SdkVersion": c.SdkVersion(),
929 "MinSdkVersion": c.MinSdkVersion(),
930 "VndkVersion": c.VndkVersion(),
931 "ProductSpecific": c.ProductSpecific(),
932 "SocSpecific": c.SocSpecific(),
933 "DeviceSpecific": c.DeviceSpecific(),
934 "InProduct": c.InProduct(),
935 "InVendor": c.InVendor(),
936 "InRamdisk": c.InRamdisk(),
937 "InVendorRamdisk": c.InVendorRamdisk(),
938 "InRecovery": c.InRecovery(),
939 "VendorAvailable": c.VendorAvailable(),
940 "ProductAvailable": c.ProductAvailable(),
941 "RamdiskAvailable": c.RamdiskAvailable(),
942 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
943 "RecoveryAvailable": c.RecoveryAvailable(),
944 "OdmAvailable": c.OdmAvailable(),
945 "InstallInData": c.InstallInData(),
946 "InstallInRamdisk": c.InstallInRamdisk(),
947 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
948 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
949 "InstallInRecovery": c.InstallInRecovery(),
950 "InstallInRoot": c.InstallInRoot(),
951 "IsVndk": c.IsVndk(),
952 "IsVndkExt": c.IsVndkExt(),
953 "IsVndkPrivate": c.IsVndkPrivate(),
954 "IsVndkSp": c.IsVndkSp(),
955 "IsLlndk": c.IsLlndk(),
956 "IsLlndkPublic": c.IsLlndkPublic(),
957 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
958 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
959 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
960 "ApexSdkVersion": c.apexSdkVersion,
961 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400962 "AidlSrcs": hasAidl,
963 "LexSrcs": hasLex,
964 "ProtoSrcs": hasProto,
965 "RenderscriptSrcs": hasRenderscript,
966 "SyspropSrcs": hasSysprop,
967 "WinMsgSrcs": hasWinMsg,
968 "YaccSrsc": hasYacc,
969 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200970 }
971}
972
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500973func (c *Module) SetPreventInstall() {
974 c.Properties.PreventInstall = true
975}
976
977func (c *Module) SetHideFromMake() {
978 c.Properties.HideFromMake = true
979}
980
Ivan Lozanod7586b62021-04-01 09:49:36 -0400981func (c *Module) HiddenFromMake() bool {
982 return c.Properties.HideFromMake
983}
984
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800985func (c *Module) RequiredModuleNames() []string {
986 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
987 if c.ImageVariation().Variation == android.CoreVariation {
988 required = append(required, c.Properties.Target.Platform.Required...)
989 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
990 } else if c.InRecovery() {
991 required = append(required, c.Properties.Target.Recovery.Required...)
992 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
993 }
994 return android.FirstUniqueStrings(required)
995}
996
Ivan Lozano52767be2019-10-18 14:49:46 -0700997func (c *Module) Toc() android.OptionalPath {
998 if c.linker != nil {
999 if library, ok := c.linker.(libraryInterface); ok {
1000 return library.toc()
1001 }
1002 }
1003 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1004}
1005
1006func (c *Module) ApiLevel() string {
1007 if c.linker != nil {
1008 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001009 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001010 }
1011 }
1012 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1013}
1014
1015func (c *Module) Static() bool {
1016 if c.linker != nil {
1017 if library, ok := c.linker.(libraryInterface); ok {
1018 return library.static()
1019 }
1020 }
1021 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1022}
1023
1024func (c *Module) Shared() bool {
1025 if c.linker != nil {
1026 if library, ok := c.linker.(libraryInterface); ok {
1027 return library.shared()
1028 }
1029 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001030
Ivan Lozano52767be2019-10-18 14:49:46 -07001031 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1032}
1033
1034func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001035 if c.stl != nil {
1036 return c.stl.Properties.SelectedStl
1037 }
1038 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001039}
1040
Ivan Lozano52767be2019-10-18 14:49:46 -07001041func (c *Module) NdkPrebuiltStl() bool {
1042 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1043 return true
1044 }
1045 return false
1046}
1047
1048func (c *Module) StubDecorator() bool {
1049 if _, ok := c.linker.(*stubDecorator); ok {
1050 return true
1051 }
1052 return false
1053}
1054
1055func (c *Module) SdkVersion() string {
1056 return String(c.Properties.Sdk_version)
1057}
1058
Artur Satayev480e25b2020-04-27 18:53:18 +01001059func (c *Module) MinSdkVersion() string {
1060 return String(c.Properties.Min_sdk_version)
1061}
1062
Jiyong Park5df7bd32021-08-25 16:18:46 +09001063func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001064 if linker, ok := c.linker.(*objectLinker); ok {
1065 return linker.isCrt()
1066 }
1067 return false
1068}
1069
Jiyong Park5df7bd32021-08-25 16:18:46 +09001070func (c *Module) SplitPerApiLevel() bool {
1071 return c.canUseSdk() && c.isCrt()
1072}
1073
Colin Crossc511bc52020-04-07 16:50:32 +00001074func (c *Module) AlwaysSdk() bool {
1075 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1076}
1077
Ivan Lozano183a3212019-10-18 14:18:45 -07001078func (c *Module) CcLibrary() bool {
1079 if c.linker != nil {
1080 if _, ok := c.linker.(*libraryDecorator); ok {
1081 return true
1082 }
Colin Crossd48fe732020-09-23 20:37:24 -07001083 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1084 return true
1085 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001086 }
1087 return false
1088}
1089
1090func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001091 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001092 return true
1093 }
1094 return false
1095}
1096
Spandan Dase12d2522023-09-12 21:42:31 +00001097func (c *Module) IsNdkPrebuiltStl() bool {
1098 if c.linker == nil {
1099 return false
1100 }
1101 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1102 return true
1103 }
1104 return false
1105}
1106
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001107func (c *Module) RlibStd() bool {
1108 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1109}
1110
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001111func (c *Module) RustLibraryInterface() bool {
1112 return false
1113}
1114
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001115func (c *Module) IsFuzzModule() bool {
1116 if _, ok := c.compiler.(*fuzzBinary); ok {
1117 return true
1118 }
1119 return false
1120}
1121
1122func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1123 return c.FuzzModule
1124}
1125
1126func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1127 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1128 return fuzzer.fuzzPackagedModule
1129 }
1130 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1131}
1132
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001133func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001134 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1135 return fuzzer.sharedLibraries
1136 }
1137 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1138}
1139
Ivan Lozano2b262972019-11-21 12:30:50 -08001140func (c *Module) NonCcVariants() bool {
1141 return false
1142}
1143
Ivan Lozano183a3212019-10-18 14:18:45 -07001144func (c *Module) SetStatic() {
1145 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001146 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001147 library.setStatic()
1148 return
1149 }
1150 }
1151 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1152}
1153
1154func (c *Module) SetShared() {
1155 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001156 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001157 library.setShared()
1158 return
1159 }
1160 }
1161 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1162}
1163
1164func (c *Module) BuildStaticVariant() bool {
1165 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001166 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001167 return library.buildStatic()
1168 }
1169 }
1170 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1171}
1172
1173func (c *Module) BuildSharedVariant() bool {
1174 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001175 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001176 return library.buildShared()
1177 }
1178 }
1179 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1180}
1181
1182func (c *Module) Module() android.Module {
1183 return c
1184}
1185
Jiyong Parkc20eee32018-09-05 22:36:17 +09001186func (c *Module) OutputFile() android.OptionalPath {
1187 return c.outputFile
1188}
1189
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001190func (c *Module) CoverageFiles() android.Paths {
1191 if c.linker != nil {
1192 if library, ok := c.linker.(libraryInterface); ok {
1193 return library.objs().coverageFiles
1194 }
1195 }
1196 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1197}
1198
Ivan Lozano183a3212019-10-18 14:18:45 -07001199var _ LinkableInterface = (*Module)(nil)
1200
Jiyong Park719b4462019-01-13 00:39:51 +09001201func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001202 if c.linker != nil {
1203 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001204 }
1205 return nil
1206}
1207
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001208func (c *Module) CoverageOutputFile() android.OptionalPath {
1209 if c.linker != nil {
1210 return c.linker.coverageOutputFilePath()
1211 }
1212 return android.OptionalPath{}
1213}
1214
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001215func (c *Module) RelativeInstallPath() string {
1216 if c.installer != nil {
1217 return c.installer.relativeInstallPath()
1218 }
1219 return ""
1220}
1221
Jooyung Han344d5432019-08-23 11:17:39 +09001222func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001223 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001224}
1225
Colin Cross36242852017-06-23 15:06:31 -07001226func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001227 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001228 for _, generator := range c.generators {
1229 c.AddProperties(generator.GeneratorProps()...)
1230 }
Colin Crossca860ac2016-01-04 14:34:37 -08001231 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001232 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001233 }
1234 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001235 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001236 }
1237 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001238 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001239 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001240 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001241 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001242 }
Colin Cross16b23492016-01-06 14:41:07 -08001243 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001244 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001245 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001246 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001247 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001248 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001249 if c.fuzzer != nil {
1250 c.AddProperties(c.fuzzer.props()...)
1251 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001252 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001253 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001254 }
Justin Yun8effde42017-06-23 19:24:43 +09001255 if c.vndkdep != nil {
1256 c.AddProperties(c.vndkdep.props()...)
1257 }
Stephen Craneba090d12017-05-09 15:44:35 -07001258 if c.lto != nil {
1259 c.AddProperties(c.lto.props()...)
1260 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001261 if c.afdo != nil {
1262 c.AddProperties(c.afdo.props()...)
1263 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001264 if c.orderfile != nil {
1265 c.AddProperties(c.orderfile.props()...)
1266 }
Colin Crossca860ac2016-01-04 14:34:37 -08001267 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001268 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001269 }
Colin Crossc472d572015-03-17 15:06:21 -07001270
Colin Cross36242852017-06-23 15:06:31 -07001271 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001272 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001273 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001274
Colin Cross36242852017-06-23 15:06:31 -07001275 return c
Colin Crossc472d572015-03-17 15:06:21 -07001276}
1277
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001278// UseVndk() returns true if this module is built against VNDK.
1279// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001280func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001281 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001282}
1283
Colin Crossc511bc52020-04-07 16:50:32 +00001284func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001285 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001286 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001287}
1288
1289func (c *Module) UseSdk() bool {
1290 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001291 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001292 }
1293 return false
1294}
1295
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001296func (c *Module) isCoverageVariant() bool {
1297 return c.coverage.Properties.IsCoverageVariant
1298}
1299
Colin Cross95f1ca02020-10-29 20:47:22 -07001300func (c *Module) IsNdk(config android.Config) bool {
1301 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001302}
1303
Colin Cross127bb8b2020-12-16 16:46:01 -08001304func (c *Module) IsLlndk() bool {
1305 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001306}
1307
Colin Cross127bb8b2020-12-16 16:46:01 -08001308func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001309 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001310}
1311
Colin Cross1f3f1302021-04-26 18:37:44 -07001312func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001313 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001314 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001315}
1316
Colin Cross5271fea2021-04-27 13:06:04 -07001317func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1318 lib := moduleLibraryInterface(m)
1319 return lib != nil && (lib.hasVendorPublicLibrary())
1320}
1321
1322// IsVendorPublicLibrary returns true for vendor public libraries.
1323func (c *Module) IsVendorPublicLibrary() bool {
1324 return c.VendorProperties.IsVendorPublicLibrary
1325}
1326
Ivan Lozanof1868af2022-04-12 13:08:36 -04001327func (c *Module) IsVndkPrebuiltLibrary() bool {
1328 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1329 return true
1330 }
1331 return false
1332}
1333
1334func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1335 return c.Properties.SdkAndPlatformVariantVisibleToMake
1336}
1337
Ivan Lozanod7586b62021-04-01 09:49:36 -04001338func (c *Module) HasLlndkStubs() bool {
1339 lib := moduleLibraryInterface(c)
1340 return lib != nil && lib.hasLLNDKStubs()
1341}
1342
1343func (c *Module) StubsVersion() string {
1344 if lib, ok := c.linker.(versionedInterface); ok {
1345 return lib.stubsVersion()
1346 }
1347 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1348}
1349
Colin Cross127bb8b2020-12-16 16:46:01 -08001350// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1351// and does not set llndk.vendor_available: false.
1352func (c *Module) isImplementationForLLNDKPublic() bool {
1353 library, _ := c.library.(*libraryDecorator)
1354 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001355 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001356}
1357
Justin Yunfd9e8042020-12-23 18:23:14 +09001358// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001359func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001360 // Check if VNDK-core-private or VNDK-SP-private
1361 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001362 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001363 }
1364
1365 // Check if LLNDK-private
1366 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001367 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001368 }
1369
1370 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001371}
1372
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001373// IsVndk() returns true if this module has a vndk variant.
1374// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1375// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001376func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001377 if vndkdep := c.vndkdep; vndkdep != nil {
1378 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001379 }
1380 return false
1381}
1382
Yi Kong4ef54592022-02-14 20:00:10 +08001383func (c *Module) isAfdoCompile() bool {
1384 if afdo := c.afdo; afdo != nil {
Ke-Yu Lu351d3642024-02-06 02:15:03 +00001385 return afdo.Properties.FdoProfilePath != nil
Yi Kong4ef54592022-02-14 20:00:10 +08001386 }
1387 return false
1388}
1389
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001390func (c *Module) isOrderfileCompile() bool {
1391 if orderfile := c.orderfile; orderfile != nil {
1392 return orderfile.Properties.OrderfileLoad
1393 }
1394 return false
1395}
1396
Yi Kongc702ebd2022-08-19 16:02:45 +08001397func (c *Module) isCfi() bool {
1398 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001399 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001400 }
1401 return false
1402}
1403
Yi Konged79fa32023-06-04 17:15:42 +09001404func (c *Module) isFuzzer() bool {
1405 if sanitize := c.sanitize; sanitize != nil {
1406 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1407 }
1408 return false
1409}
1410
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001411func (c *Module) isNDKStubLibrary() bool {
1412 if _, ok := c.compiler.(*stubDecorator); ok {
1413 return true
1414 }
1415 return false
1416}
1417
Ivan Lozanod7586b62021-04-01 09:49:36 -04001418func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001419 if vndkdep := c.vndkdep; vndkdep != nil {
1420 return vndkdep.isVndkSp()
1421 }
1422 return false
1423}
1424
Ivan Lozanof9e21722020-12-02 09:00:51 -05001425func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001426 if vndkdep := c.vndkdep; vndkdep != nil {
1427 return vndkdep.isVndkExt()
1428 }
1429 return false
1430}
1431
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001432func (c *Module) SubName() string {
1433 return c.Properties.SubName
1434}
1435
Ivan Lozano52767be2019-10-18 14:49:46 -07001436func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001437 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001438}
1439
Logan Chienf3511742017-10-31 18:04:35 +08001440func (c *Module) getVndkExtendsModuleName() string {
1441 if vndkdep := c.vndkdep; vndkdep != nil {
1442 return vndkdep.getVndkExtendsModuleName()
1443 }
1444 return ""
1445}
1446
Jiyong Park25fc6a92018-11-18 18:02:45 +09001447func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001448 if lib := c.library; lib != nil {
1449 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001450 }
1451 return false
1452}
1453
1454func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001455 if lib := c.library; lib != nil {
1456 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001457 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001458 return false
1459}
1460
Alan Stokes73feba32022-11-14 12:21:24 +00001461func (c *Module) IsStubsImplementationRequired() bool {
1462 if lib := c.library; lib != nil {
1463 return lib.isStubsImplementationRequired()
1464 }
1465 return false
1466}
1467
Colin Cross0477b422020-10-13 18:43:54 -07001468// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1469// the implementation. If it is an implementation library it returns its own name.
1470func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1471 name := ctx.OtherModuleName(c)
1472 if versioned, ok := c.linker.(versionedInterface); ok {
1473 name = versioned.implementationModuleName(name)
1474 }
1475 return name
1476}
1477
Martin Stjernholm2856c662020-12-02 15:03:42 +00001478// Similar to ImplementationModuleName, but uses the Make variant of the module
1479// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1480// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1481// under the premise that the prebuilt module overrides its source counterpart
1482// if it is exposed to Make).
1483func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1484 name := c.BaseModuleName()
1485 if versioned, ok := c.linker.(versionedInterface); ok {
1486 name = versioned.implementationModuleName(name)
1487 }
1488 return name
1489}
1490
Jiyong Park7d55b612021-06-11 17:22:09 +09001491func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001492 return Bool(c.Properties.Bootstrap)
1493}
1494
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001495func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001496 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1497 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1498 return false
1499 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001500 return c.linker != nil && c.linker.nativeCoverage()
1501}
1502
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001503func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001504 if p, ok := c.linker.(SnapshotInterface); ok {
1505 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001506 }
1507 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001508}
1509
Bill Peckham945441c2020-08-31 16:07:58 -07001510func (c *Module) ExcludeFromVendorSnapshot() bool {
1511 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1512}
1513
Jose Galmesf7294582020-11-13 12:07:36 -08001514func (c *Module) ExcludeFromRecoverySnapshot() bool {
1515 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1516}
1517
Jiyong Parkf1194352019-02-25 11:05:47 +09001518func isBionic(name string) bool {
1519 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001520 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001521 return true
1522 }
1523 return false
1524}
1525
Martin Stjernholm279de572019-09-10 23:18:20 +01001526func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001527 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001528 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001529 }
1530 return isBionic(name)
1531}
1532
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001533func (c *Module) XrefCcFiles() android.Paths {
1534 return c.kytheFiles
1535}
1536
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001537func (c *Module) isCfiAssemblySupportEnabled() bool {
1538 return c.sanitize != nil &&
1539 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1540}
1541
Inseob Kim800d1142021-06-14 12:03:51 +09001542func (c *Module) InstallInRoot() bool {
1543 return c.installer != nil && c.installer.installInRoot()
1544}
1545
Colin Crossca860ac2016-01-04 14:34:37 -08001546type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001547 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001548 moduleContextImpl
1549}
1550
Colin Cross37047f12016-12-13 17:06:13 -08001551type depsContext struct {
1552 android.BottomUpMutatorContext
1553 moduleContextImpl
1554}
1555
Colin Crossca860ac2016-01-04 14:34:37 -08001556type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001557 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001558 moduleContextImpl
1559}
1560
1561type moduleContextImpl struct {
1562 mod *Module
1563 ctx BaseModuleContext
1564}
1565
Colin Crossb98c8b02016-07-29 13:44:28 -07001566func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001567 return ctx.mod.toolchain(ctx.ctx)
1568}
1569
1570func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001571 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001572}
1573
1574func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001575 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001576}
1577
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001578func (ctx *moduleContextImpl) testBinary() bool {
1579 return ctx.mod.testBinary()
1580}
1581
Yi Kong56fc1b62022-09-06 16:24:00 +08001582func (ctx *moduleContextImpl) testLibrary() bool {
1583 return ctx.mod.testLibrary()
1584}
1585
Jiyong Park1d1119f2019-07-29 21:27:18 +09001586func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001587 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001588}
1589
Inseob Kim7f283f42020-06-01 21:53:49 +09001590func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001591 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001592}
1593
Inseob Kim1042d292020-06-01 23:23:05 +09001594func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001595 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001596}
1597
Jooyung Hanccce2f22020-03-07 03:45:53 +09001598func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001599 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001600}
1601
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001602func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001603 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001604}
1605
1606func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001607 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001608 config := ctx.ctx.Config()
1609 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001610 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001611 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001612 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001613 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001614 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001615 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001616 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001617 }
1618 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001619}
1620
Jiyong Parkb35a8192020-08-10 15:59:36 +09001621func (ctx *moduleContextImpl) minSdkVersion() string {
1622 ver := ctx.mod.MinSdkVersion()
1623 if ver == "apex_inherit" && !ctx.isForPlatform() {
1624 ver = ctx.apexSdkVersion().String()
1625 }
1626 if ver == "apex_inherit" || ver == "" {
1627 ver = ctx.sdkVersion()
1628 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001629
1630 if ctx.ctx.Device() {
1631 config := ctx.ctx.Config()
1632 if config.IsVndkDeprecated() && ctx.inVendor() {
1633 // If building for vendor with final API, then use the latest _stable_ API as "current".
1634 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1635 ver = config.PlatformSdkVersion().String()
1636 }
1637 }
1638 }
1639
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001640 // For crt objects, the meaning of min_sdk_version is very different from other types of
1641 // module. For them, min_sdk_version defines the oldest version that the build system will
1642 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1643 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1644 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001645 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1646 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1647 // support such an old version. The version is set to the later version in case when the
1648 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1649 // it's for an APEX.
1650 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1651 if ctx.isForPlatform() {
1652 ver = strconv.Itoa(android.FutureApiLevelInt)
1653 } else { // for apex
1654 ver = ctx.apexSdkVersion().String()
1655 if ver == "" { // in case when min_sdk_version was not set by the APEX
1656 ver = ctx.sdkVersion()
1657 }
1658 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001659 }
1660
Jiyong Parkb35a8192020-08-10 15:59:36 +09001661 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1662 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1663 minSdkVersionInt, err2 := strconv.Atoi(ver)
1664 if err == nil && err2 == nil {
1665 if sdkVersionInt < minSdkVersionInt {
1666 return strconv.Itoa(sdkVersionInt)
1667 }
1668 }
1669 return ver
1670}
1671
1672func (ctx *moduleContextImpl) isSdkVariant() bool {
1673 return ctx.mod.IsSdkVariant()
1674}
1675
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001676func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001677 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001678}
Justin Yun8effde42017-06-23 19:24:43 +09001679
Kiyoung Kimaa394802024-01-08 12:55:45 +09001680func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1681 return ctx.mod.InVendorOrProduct()
1682}
1683
Colin Cross95f1ca02020-10-29 20:47:22 -07001684func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1685 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001686}
1687
Colin Cross127bb8b2020-12-16 16:46:01 -08001688func (ctx *moduleContextImpl) IsLlndk() bool {
1689 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001690}
1691
Colin Cross127bb8b2020-12-16 16:46:01 -08001692func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1693 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001694}
1695
Colin Cross127bb8b2020-12-16 16:46:01 -08001696func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1697 return ctx.mod.isImplementationForLLNDKPublic()
1698}
1699
1700func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1701 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001702}
1703
Logan Chienf3511742017-10-31 18:04:35 +08001704func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001705 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001706}
1707
Yi Kong4ef54592022-02-14 20:00:10 +08001708func (ctx *moduleContextImpl) isAfdoCompile() bool {
1709 return ctx.mod.isAfdoCompile()
1710}
1711
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001712func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1713 return ctx.mod.isOrderfileCompile()
1714}
1715
Yi Kongc702ebd2022-08-19 16:02:45 +08001716func (ctx *moduleContextImpl) isCfi() bool {
1717 return ctx.mod.isCfi()
1718}
1719
Yi Konged79fa32023-06-04 17:15:42 +09001720func (ctx *moduleContextImpl) isFuzzer() bool {
1721 return ctx.mod.isFuzzer()
1722}
1723
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001724func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1725 return ctx.mod.isNDKStubLibrary()
1726}
1727
Justin Yun8effde42017-06-23 19:24:43 +09001728func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001729 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001730}
1731
Ivan Lozanof9e21722020-12-02 09:00:51 -05001732func (ctx *moduleContextImpl) IsVndkExt() bool {
1733 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001734}
1735
Colin Cross5271fea2021-04-27 13:06:04 -07001736func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1737 return ctx.mod.IsVendorPublicLibrary()
1738}
1739
Vic Yangefd249e2018-11-12 20:19:56 -08001740func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001741 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001742}
1743
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001744func (ctx *moduleContextImpl) selectedStl() string {
1745 if stl := ctx.mod.stl; stl != nil {
1746 return stl.Properties.SelectedStl
1747 }
1748 return ""
1749}
1750
Ivan Lozanobd721262018-11-27 14:33:03 -08001751func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1752 return ctx.mod.linker.useClangLld(actx)
1753}
1754
Colin Crossce75d2c2016-10-06 16:12:58 -07001755func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001756 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001757}
1758
Logan Chienf3511742017-10-31 18:04:35 +08001759func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1760 return ctx.mod.getVndkExtendsModuleName()
1761}
1762
Logan Chiene274fc92019-12-03 11:18:32 -08001763func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001764 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1765 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001766}
1767
Colin Crosse07f2312020-08-13 11:24:56 -07001768func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001769 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1770 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001771}
1772
Dan Albertc8060532020-07-22 22:32:17 -07001773func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001774 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001775}
1776
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001777func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001778 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001779}
1780
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001781func (ctx *moduleContextImpl) nativeCoverage() bool {
1782 return ctx.mod.nativeCoverage()
1783}
1784
Colin Cross56a83212020-09-15 18:30:11 -07001785func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1786 return ctx.mod.DirectlyInAnyApex()
1787}
1788
Colin Cross95b07f22020-12-16 11:06:50 -08001789func (ctx *moduleContextImpl) isPreventInstall() bool {
1790 return ctx.mod.Properties.PreventInstall
1791}
1792
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001793func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1794 shared := &ctx.mod.sharedFlags
1795 if shared.flagsMap == nil {
1796 shared.numSharedFlags = 0
1797 shared.flagsMap = make(map[string]string)
1798 }
1799 return shared
1800}
1801
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001802func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1803 return ctx.mod.isCfiAssemblySupportEnabled()
1804}
1805
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001806func (ctx *moduleContextImpl) notInPlatform() bool {
1807 return ctx.mod.NotInPlatform()
1808}
1809
Colin Cross635c3b02016-05-18 15:37:25 -07001810func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001811 return &Module{
1812 hod: hod,
1813 multilib: multilib,
1814 }
1815}
1816
Colin Cross635c3b02016-05-18 15:37:25 -07001817func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001818 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001819 module.features = []feature{
1820 &tidyFeature{},
1821 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001822 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001823 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001824 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001825 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001826 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001827 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001828 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001829 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001830 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001831 return module
1832}
1833
Colin Crossce75d2c2016-10-06 16:12:58 -07001834func (c *Module) Prebuilt() *android.Prebuilt {
1835 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1836 return p.prebuilt()
1837 }
1838 return nil
1839}
1840
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001841func (c *Module) IsPrebuilt() bool {
1842 return c.Prebuilt() != nil
1843}
1844
Colin Crossce75d2c2016-10-06 16:12:58 -07001845func (c *Module) Name() string {
1846 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001847 if p, ok := c.linker.(interface {
1848 Name(string) string
1849 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001850 name = p.Name(name)
1851 }
1852 return name
1853}
1854
Alex Light3d673592019-01-18 14:37:31 -08001855func (c *Module) Symlinks() []string {
1856 if p, ok := c.installer.(interface {
1857 symlinkList() []string
1858 }); ok {
1859 return p.symlinkList()
1860 }
1861 return nil
1862}
1863
Roland Levillainf89cd092019-07-29 16:22:59 +01001864func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1865 test, ok := c.linker.(testPerSrc)
1866 return ok && test.isAllTestsVariation()
1867}
1868
Chris Parsons216e10a2020-07-09 17:12:52 -04001869func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001870 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001871 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001872 }); ok {
1873 return p.dataPaths()
1874 }
1875 return nil
1876}
1877
Ivan Lozanof1868af2022-04-12 13:08:36 -04001878func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001879 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1880 // "current", it will append the VNDK version to the name suffix.
1881 var vndkVersion string
1882 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001883 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001884 if c.ProductSpecific() {
1885 // If the module is product specific with 'product_specific: true',
1886 // do not add a name suffix because it is a base module.
1887 return ""
1888 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001889 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001890 } else {
1891 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001892 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001893 }
1894 if vndkVersion == "current" {
1895 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1896 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001897 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001898 // add version suffix only if the module is using different vndk version than the
1899 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001900 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001901 }
1902 return nameSuffix
1903}
1904
Ivan Lozanof1868af2022-04-12 13:08:36 -04001905func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1906 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001907
1908 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001909 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001910 }
1911
Colin Cross127bb8b2020-12-16 16:46:01 -08001912 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001913 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001914 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1915 // added for product variant only when we have vendor and product variants with core
1916 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001917 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001918 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001919 subName += vendorPublicLibrarySuffix
1920 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001921 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1922 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001923 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001924 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001925 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001926 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001927 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001928 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001929 subName += RecoverySuffix
1930 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1931 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001932 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001933 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001934 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001935 } else if c.IsStubs() && c.IsSdkVariant() {
1936 // Public API surface (NDK)
1937 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1938 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001939 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001940
1941 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001942}
1943
Sam Delmerico75dbca22023-04-20 13:13:25 +00001944func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1945 ctx := &moduleContext{
1946 ModuleContext: actx,
1947 moduleContextImpl: moduleContextImpl{
1948 mod: c,
1949 },
1950 }
1951 ctx.ctx = ctx
1952 return ctx
1953}
1954
Spandan Das20fce2d2023-04-12 17:21:39 +00001955// TODO (b/277651159): Remove this allowlist
1956var (
1957 skipStubLibraryMultipleApexViolation = map[string]bool{
1958 "libclang_rt.asan": true,
1959 "libclang_rt.hwasan": true,
1960 // runtime apex
1961 "libc": true,
1962 "libc_hwasan": true,
1963 "libdl_android": true,
1964 "libm": true,
1965 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001966 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001967 // art apex
1968 "libandroidio": true,
1969 "libdexfile": true,
1970 "libnativebridge": true,
1971 "libnativehelper": true,
1972 "libnativeloader": true,
1973 "libsigchain": true,
1974 }
1975)
1976
1977// Returns true if a stub library could be installed in multiple apexes
1978func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1979 // If this is not an apex variant, no check necessary
1980 if !c.InAnyApex() {
1981 return false
1982 }
1983 // If this is not a stub library, no check necessary
1984 if !c.HasStubsVariants() {
1985 return false
1986 }
1987 // Skip the allowlist
1988 // Use BaseModuleName so that this matches prebuilts.
1989 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1990 return false
1991 }
1992
1993 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1994 // Stub libraries should not have more than one apex_available
1995 if len(aaWithoutTestApexes) > 1 {
1996 return true
1997 }
1998 // Stub libraries should not use the wildcard
1999 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2000 return true
2001 }
2002 // Default: no violation
2003 return false
2004}
2005
LaMont Jonesafe7baf2024-01-09 22:47:39 +00002006func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2007 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
2008}
2009
Chris Parsons8d6e4332021-02-22 16:13:50 -05002010func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05002011 // Handle the case of a test module split by `test_per_src` mutator.
2012 //
2013 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2014 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2015 // module and return early, as this module does not produce an output file per se.
2016 if c.IsTestPerSrcAllTestsVariation() {
2017 c.outputFile = android.OptionalPath{}
2018 return
2019 }
2020
Ivan Lozanof1868af2022-04-12 13:08:36 -04002021 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002022 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002023 if !apexInfo.IsForPlatform() {
2024 c.hideApexVariantFromMake = true
2025 }
2026
Chris Parsonseefc9e62021-04-02 17:36:47 -04002027 c.makeLinkType = GetMakeLinkType(actx, c)
2028
Sam Delmerico75dbca22023-04-20 13:13:25 +00002029 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002030
Colin Crossf18e1102017-11-16 14:33:08 -08002031 deps := c.depsToPaths(ctx)
2032 if ctx.Failed() {
2033 return
2034 }
2035
Joe Onorato37f900c2023-07-18 16:58:16 -07002036 for _, generator := range c.generators {
2037 gen := generator.GeneratorSources(ctx)
2038 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2039 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2040 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2041 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2042 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2043 if len(deps.Objs.objFiles) == 0 {
2044 // If we are reusuing object files (which happens when we're a shared library and we're
2045 // reusing our static variant's object files), then skip adding the actual source files,
2046 // because we already have the object for it.
2047 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2048 }
2049 }
2050
2051 if ctx.Failed() {
2052 return
2053 }
2054
Spandan Das20fce2d2023-04-12 17:21:39 +00002055 if c.stubLibraryMultipleApexViolation(actx) {
2056 actx.PropertyErrorf("apex_available",
2057 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2058 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002059 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2060 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002061 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2062 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002063 }
2064
Colin Crossca860ac2016-01-04 14:34:37 -08002065 flags := Flags{
2066 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002067 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002068 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002069 for _, generator := range c.generators {
2070 flags = generator.GeneratorFlags(ctx, flags, deps)
2071 }
Colin Crossca860ac2016-01-04 14:34:37 -08002072 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002073 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002074 }
2075 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002076 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002077 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002078 if c.stl != nil {
2079 flags = c.stl.flags(ctx, flags)
2080 }
Colin Cross16b23492016-01-06 14:41:07 -08002081 if c.sanitize != nil {
2082 flags = c.sanitize.flags(ctx, flags)
2083 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002084 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002085 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002086 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002087 if c.fuzzer != nil {
2088 flags = c.fuzzer.flags(ctx, flags)
2089 }
Stephen Craneba090d12017-05-09 15:44:35 -07002090 if c.lto != nil {
2091 flags = c.lto.flags(ctx, flags)
2092 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002093 if c.afdo != nil {
2094 flags = c.afdo.flags(ctx, flags)
2095 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002096 if c.orderfile != nil {
2097 flags = c.orderfile.flags(ctx, flags)
2098 }
Colin Crossca860ac2016-01-04 14:34:37 -08002099 for _, feature := range c.features {
2100 flags = feature.flags(ctx, flags)
2101 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002102 if ctx.Failed() {
2103 return
2104 }
2105
Colin Cross4af21ed2019-11-04 09:37:55 -08002106 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2107 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2108 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002109
Colin Cross4af21ed2019-11-04 09:37:55 -08002110 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002111
2112 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002113 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002114 }
2115 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002116 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002117 }
2118
Colin Cross3e5e7782022-06-17 22:17:05 +00002119 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2120
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002121 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002122 // We need access to all the flags seen by a source file.
2123 if c.sabi != nil {
2124 flags = c.sabi.flags(ctx, flags)
2125 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002126
Colin Cross4af21ed2019-11-04 09:37:55 -08002127 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002128
Joe Onorato37f900c2023-07-18 16:58:16 -07002129 for _, generator := range c.generators {
2130 generator.GeneratorBuildActions(ctx, flags, deps)
2131 }
2132
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002133 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002134 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002135 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002136 if ctx.Failed() {
2137 return
2138 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002139 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002140 c.objFiles = objs.objFiles
2141 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002142 }
2143
Colin Crossca860ac2016-01-04 14:34:37 -08002144 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002145 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002146 if ctx.Failed() {
2147 return
2148 }
Colin Cross635c3b02016-05-18 15:37:25 -07002149 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002150
Chris Parsons94a0bba2021-06-04 15:03:47 -04002151 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002152
Jose Galmes6f843bc2020-12-11 13:36:29 -08002153 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2154 // RECOVERY_SNAPSHOT_VERSION is current.
2155 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002156 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002157 i.collectHeadersForSnapshot(ctx)
2158 }
2159 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002160 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002161 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002162 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002163 }
Colin Cross40213022023-12-13 15:19:49 -08002164 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002165
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002166 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002167
Chris Parsons94a0bba2021-06-04 15:03:47 -04002168 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002169
2170 if c.linker != nil {
2171 moduleInfoJSON := ctx.ModuleInfoJSON()
2172 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2173 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2174 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2175 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2176 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2177
2178 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2179 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2180 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2181 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2182
2183 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2184 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2185 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2186 moduleInfoJSON.SubName += ".cfi"
2187 }
2188 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2189 moduleInfoJSON.SubName += ".hwasan"
2190 }
2191 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2192 moduleInfoJSON.SubName += ".scs"
2193 }
2194 }
2195 moduleInfoJSON.SubName += c.Properties.SubName
2196
2197 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2198 moduleInfoJSON.Uninstallable = true
2199 }
2200
2201 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002202}
2203
2204func (c *Module) maybeUnhideFromMake() {
2205 // If a lib is directly included in any of the APEXes or is not available to the
2206 // platform (which is often the case when the stub is provided as a prebuilt),
2207 // unhide the stubs variant having the latest version gets visible to make. In
2208 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2209 // force anything in the make world to link against the stubs library. (unless it
2210 // is explicitly referenced via .bootstrap suffix or the module is marked with
2211 // 'bootstrap: true').
2212 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002213 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002214 c.IsStubs() && !c.InVendorRamdisk() {
2215 c.Properties.HideFromMake = false // unhide
2216 // Note: this is still non-installable
2217 }
2218}
2219
Colin Cross8ff10582023-12-07 13:10:56 -08002220// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2221// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002222func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002223 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002224 // If the module has been specifically configure to not be installed then
2225 // hide from make as otherwise it will break when running inside make
2226 // as the output path to install will not be specified. Not all uninstallable
2227 // modules can be hidden from make as some are needed for resolving make side
2228 // dependencies.
2229 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002230 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002231 c.SkipInstall()
2232 }
2233
2234 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2235 // to allow using the outputs in a genrule.
2236 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002237 c.installer.install(ctx, c.outputFile.Path())
2238 if ctx.Failed() {
2239 return
Colin Crossca860ac2016-01-04 14:34:37 -08002240 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002241 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002242}
2243
Colin Cross0ea8ba82019-06-06 14:33:29 -07002244func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002245 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002246 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002247 }
Colin Crossca860ac2016-01-04 14:34:37 -08002248 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002249}
2250
Colin Crossca860ac2016-01-04 14:34:37 -08002251func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002252 for _, generator := range c.generators {
2253 generator.GeneratorInit(ctx)
2254 }
Colin Crossca860ac2016-01-04 14:34:37 -08002255 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002256 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002257 }
Colin Crossca860ac2016-01-04 14:34:37 -08002258 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002259 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002260 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002261 if c.stl != nil {
2262 c.stl.begin(ctx)
2263 }
Colin Cross16b23492016-01-06 14:41:07 -08002264 if c.sanitize != nil {
2265 c.sanitize.begin(ctx)
2266 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002267 if c.coverage != nil {
2268 c.coverage.begin(ctx)
2269 }
Yi Kong9723e332023-12-04 14:52:53 +09002270 if c.afdo != nil {
2271 c.afdo.begin(ctx)
2272 }
Stephen Craneba090d12017-05-09 15:44:35 -07002273 if c.lto != nil {
2274 c.lto.begin(ctx)
2275 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002276 if c.orderfile != nil {
2277 c.orderfile.begin(ctx)
2278 }
Dan Albert92fe7402020-07-15 13:33:30 -07002279 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002280 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002281 if err != nil {
2282 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002283 c.Properties.Sdk_version = nil
2284 } else {
2285 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002286 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002287 }
Colin Crossca860ac2016-01-04 14:34:37 -08002288}
2289
Colin Cross37047f12016-12-13 17:06:13 -08002290func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002291 deps := Deps{}
2292
Joe Onorato37f900c2023-07-18 16:58:16 -07002293 for _, generator := range c.generators {
2294 deps = generator.GeneratorDeps(ctx, deps)
2295 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002296 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002297 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002298 }
2299 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002300 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002301 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002302 if c.stl != nil {
2303 deps = c.stl.deps(ctx, deps)
2304 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002305 if c.coverage != nil {
2306 deps = c.coverage.deps(ctx, deps)
2307 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002308
Colin Crossb6715442017-10-24 11:13:31 -07002309 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2310 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2311 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2312 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2313 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2314 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002315 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002316
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002317 for _, lib := range deps.ReexportSharedLibHeaders {
2318 if !inList(lib, deps.SharedLibs) {
2319 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2320 }
2321 }
2322
2323 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002324 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2325 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 -07002326 }
2327 }
2328
Colin Cross5950f382016-12-13 12:50:57 -08002329 for _, lib := range deps.ReexportHeaderLibHeaders {
2330 if !inList(lib, deps.HeaderLibs) {
2331 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2332 }
2333 }
2334
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002335 for _, gen := range deps.ReexportGeneratedHeaders {
2336 if !inList(gen, deps.GeneratedHeaders) {
2337 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2338 }
2339 }
2340
Colin Crossc99deeb2016-04-11 15:06:20 -07002341 return deps
2342}
2343
Dan Albert7e9d2952016-08-04 13:02:36 -07002344func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002345 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002346 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002347 moduleContextImpl: moduleContextImpl{
2348 mod: c,
2349 },
2350 }
2351 ctx.ctx = ctx
2352
Colin Crossca860ac2016-01-04 14:34:37 -08002353 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002354}
2355
Jiyong Park7ed9de32018-10-15 22:25:07 +09002356// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002357func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002358 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2359 version := name[sharp+1:]
2360 libname := name[:sharp]
2361 return libname, version
2362 }
2363 return name, ""
2364}
2365
Dan Albert92fe7402020-07-15 13:33:30 -07002366func GetCrtVariations(ctx android.BottomUpMutatorContext,
2367 m LinkableInterface) []blueprint.Variation {
2368 if ctx.Os() != android.Android {
2369 return nil
2370 }
2371 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002372 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2373 minSdkVersion := m.MinSdkVersion()
2374 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2375 minSdkVersion = m.SdkVersion()
2376 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002377 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2378 if err != nil {
2379 ctx.PropertyErrorf("min_sdk_version", err.Error())
2380 }
Colin Cross363ec762023-01-13 13:45:14 -08002381
2382 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002383 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002384 if apiLevel.LessThan(minApiForArch) {
2385 apiLevel = minApiForArch
2386 }
2387
Dan Albert92fe7402020-07-15 13:33:30 -07002388 return []blueprint.Variation{
2389 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002390 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002391 }
2392 }
2393 return []blueprint.Variation{
2394 {Mutator: "sdk", Variation: ""},
2395 }
2396}
2397
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002398func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2399 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002400
2401 variations = append([]blueprint.Variation(nil), variations...)
2402
Liz Kammer23942242022-04-08 15:41:00 -04002403 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002404 // Version is explicitly specified. i.e. libFoo#30
2405 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002406 if tag, ok := depTag.(libraryDependencyTag); ok {
2407 tag.explicitlyVersioned = true
2408 } else {
2409 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2410 }
Colin Crosse7257d22020-09-24 09:56:18 -07002411 }
Colin Crosse7257d22020-09-24 09:56:18 -07002412
Colin Cross0de8a1e2020-09-18 14:15:30 -07002413 if far {
2414 ctx.AddFarVariationDependencies(variations, depTag, name)
2415 } else {
2416 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002417 }
2418}
2419
Kiyoung Kim487689e2022-07-26 09:48:22 +09002420func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2421 apiImportInfo := multitree.ApiImportInfo{}
2422
2423 if c.Device() {
2424 var apiImportModule []blueprint.Module
2425 if actx.OtherModuleExists("api_imports") {
2426 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2427 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002428 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002429 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002430 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002431 }
2432 }
2433 }
2434
2435 return apiImportInfo
2436}
2437
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002438func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002439 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002440 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002441 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002442 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2443 // between the modules in the snapshot and the snapshot itself.
2444 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002445 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002446 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002447 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002448 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2449 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002450 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002451 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002452 *snapshotInfo = &snapshot
2453 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002454 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002455 }
2456 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002457 if *snapshotInfo == nil {
2458 *snapshotInfo = &SnapshotInfo{}
2459 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002460 return **snapshotInfo
2461}
2462
Kiyoung Kim487689e2022-07-26 09:48:22 +09002463func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2464 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002465 return snapshot
2466 }
2467
2468 return lib
2469}
2470
2471// RewriteLibs takes a list of names of shared libraries and scans it for three types
2472// of names:
2473//
2474// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002475//
2476// For each of these, it adds the name of the prebuilt module (which will be in
2477// prebuilts/ndk) to the list of nonvariant libs.
2478//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002479// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002480//
2481// For each of these, it adds the name of the ndk_library module to the list of
2482// variant libs.
2483//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002484// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002485//
2486// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002487//
2488// The caller can then know to add the variantLibs dependencies differently from the
2489// nonvariantLibs
2490func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2491 variantLibs = []string{}
2492
2493 nonvariantLibs = []string{}
2494 for _, entry := range list {
2495 // strip #version suffix out
2496 name, _ := StubsLibNameAndVersion(entry)
2497 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002498 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002499 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2500 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2501 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002502 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002503 } else {
2504 // put name#version back
2505 nonvariantLibs = append(nonvariantLibs, entry)
2506 }
2507 }
2508 return nonvariantLibs, variantLibs
2509}
2510
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002511func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2512 nonVariantLibs := []string{}
2513 variantLibs := []string{}
2514
2515 for _, lib := range libs {
2516 replaceLibName := GetReplaceModuleName(lib, replaceList)
2517 if replaceLibName == lib {
2518 // Do not handle any libs which are not in API imports
2519 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2520 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2521 variantLibs = append(variantLibs, replaceLibName)
2522 } else {
2523 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2524 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002525 }
2526
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002527 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002528}
2529
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002530func (c *Module) shouldUseApiSurface() bool {
2531 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2532 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2533 // LLNDK Variant
2534 return true
2535 }
2536
2537 if c.Properties.IsSdkVariant {
2538 // NDK Variant
2539 return true
2540 }
2541
2542 if c.isImportedApiLibrary() {
2543 // API Library should depend on API headers
2544 return true
2545 }
2546 }
2547
2548 return false
2549}
2550
Colin Cross1e676be2016-10-12 14:38:15 -07002551func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002552 if !c.Enabled() {
2553 return
2554 }
2555
Colin Cross37047f12016-12-13 17:06:13 -08002556 ctx := &depsContext{
2557 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002558 moduleContextImpl: moduleContextImpl{
2559 mod: c,
2560 },
2561 }
2562 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002563
Colin Crossc99deeb2016-04-11 15:06:20 -07002564 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002565 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002566
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002567 apiNdkLibs := []string{}
2568 apiLateNdkLibs := []string{}
2569
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002570 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002571 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2572 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2573 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2574 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2575 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002576 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002577
Yo Chiang219968c2020-09-22 18:45:04 +08002578 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2579
Colin Crosse0edaf92021-01-11 17:31:17 -08002580 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002581
Dan Albert914449f2016-06-17 16:45:24 -07002582 variantNdkLibs := []string{}
2583 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002584 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002585 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2586 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2587 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002588
2589 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002590 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002591 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002592 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002593
Colin Cross32ec36c2016-12-15 07:39:51 -08002594 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002595 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002596 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002597 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002598 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002599
Kiyoung Kim51279d32022-08-24 14:10:46 +09002600 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002601 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002602 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2603 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002604 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002605
Spandan Das73bcafc2022-08-18 23:26:00 +00002606 if c.isNDKStubLibrary() {
2607 // ndk_headers do not have any variations
2608 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002609 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002610 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002611 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002612 } else {
2613 actx.AddVariationDependencies(nil, depTag, lib)
2614 }
2615 }
2616
Dan Albertf1d14c72020-07-30 14:32:55 -07002617 if c.isNDKStubLibrary() {
2618 // NDK stubs depend on their implementation because the ABI dumps are
2619 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002620
Spandan Das8b08aea2023-03-14 19:29:34 +00002621 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2622 c.ImageVariation(),
2623 blueprint.Variation{Mutator: "link", Variation: "shared"},
2624 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002625 }
2626
Jiyong Park5d1598f2019-02-25 22:14:17 +09002627 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002628 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002629
Kiyoung Kim487689e2022-07-26 09:48:22 +09002630 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002631
Jiyong Park5d1598f2019-02-25 22:14:17 +09002632 actx.AddVariationDependencies([]blueprint.Variation{
2633 {Mutator: "link", Variation: "static"},
2634 }, depTag, lib)
2635 }
2636
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002637 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002638 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002639 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002640 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002641 }
Jiyong Parke3867542020-12-03 17:28:25 +09002642 if inList(lib, deps.ExcludeLibsForApex) {
2643 depTag.excludeInApex = true
2644 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002645
Kiyoung Kim487689e2022-07-26 09:48:22 +09002646 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002647
Dan Willemsen59339a22018-07-22 21:18:45 -07002648 actx.AddVariationDependencies([]blueprint.Variation{
2649 {Mutator: "link", Variation: "static"},
2650 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002651 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002652
Jooyung Han75568392020-03-20 04:29:24 +09002653 // staticUnwinderDep is treated as staticDep for Q apexes
2654 // so that native libraries/binaries are linked with static unwinder
2655 // because Q libc doesn't have unwinder APIs
2656 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002657 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002658 actx.AddVariationDependencies([]blueprint.Variation{
2659 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002660 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002661 }
2662
Jiyong Park7ed9de32018-10-15 22:25:07 +09002663 // shared lib names without the #version suffix
2664 var sharedLibNames []string
2665
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002666 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002667 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002668 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002669 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002670 }
Jiyong Parke3867542020-12-03 17:28:25 +09002671 if inList(lib, deps.ExcludeLibsForApex) {
2672 depTag.excludeInApex = true
2673 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002674 if inList(lib, deps.ExcludeLibsForNonApex) {
2675 depTag.excludeInNonApex = true
2676 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002677
Jiyong Park73c54ee2019-10-22 20:31:18 +09002678 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002679 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2680 name = apiLibraryName
2681 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002682 sharedLibNames = append(sharedLibNames, name)
2683
Colin Crosse7257d22020-09-24 09:56:18 -07002684 variations := []blueprint.Variation{
2685 {Mutator: "link", Variation: "shared"},
2686 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002687
2688 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2689 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2690 }
2691
2692 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2693 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2694 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002695 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002696
Colin Crossfe9acfe2021-06-14 16:13:03 -07002697 for _, lib := range deps.LateStaticLibs {
2698 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2699 actx.AddVariationDependencies([]blueprint.Variation{
2700 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002701 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002702 }
2703
Colin Cross3e5e7782022-06-17 22:17:05 +00002704 for _, lib := range deps.UnexportedStaticLibs {
2705 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2706 actx.AddVariationDependencies([]blueprint.Variation{
2707 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002708 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002709 }
2710
Jiyong Park7ed9de32018-10-15 22:25:07 +09002711 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002712 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002713 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2714 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2715 // linking against both the stubs lib and the non-stubs lib at the same time.
2716 continue
2717 }
Colin Cross6e511a92020-07-27 21:26:48 -07002718 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002719 variations := []blueprint.Variation{
2720 {Mutator: "link", Variation: "shared"},
2721 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002722 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002723 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002724
Dan Willemsen59339a22018-07-22 21:18:45 -07002725 actx.AddVariationDependencies([]blueprint.Variation{
2726 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002727 }, dataLibDepTag, deps.DataLibs...)
2728
Colin Crossc8caa062021-09-24 16:50:14 -07002729 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2730
Chris Parsons79d66a52020-06-05 17:26:16 -04002731 actx.AddVariationDependencies([]blueprint.Variation{
2732 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002733 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002734
Colin Cross68861832016-07-08 10:41:41 -07002735 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002736
2737 for _, gen := range deps.GeneratedHeaders {
2738 depTag := genHeaderDepTag
2739 if inList(gen, deps.ReexportGeneratedHeaders) {
2740 depTag = genHeaderExportDepTag
2741 }
2742 actx.AddDependency(c, depTag, gen)
2743 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002744
Dan Albert92fe7402020-07-15 13:33:30 -07002745 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002746 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002747 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002748 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002749 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002750 }
Colin Crossc465efd2021-06-11 18:00:04 -07002751 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002752 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002753 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002754 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002755 if deps.DynamicLinker != "" {
2756 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002757 }
Dan Albert914449f2016-06-17 16:45:24 -07002758
2759 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002760
2761 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002762 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002763 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002764 {Mutator: "link", Variation: "shared"},
2765 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002766 actx.AddVariationDependencies([]blueprint.Variation{
2767 {Mutator: "version", Variation: version},
2768 {Mutator: "link", Variation: "shared"},
2769 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002770
2771 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002772 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002773 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002774 {Mutator: "link", Variation: "shared"},
2775 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002776 actx.AddVariationDependencies([]blueprint.Variation{
2777 {Mutator: "version", Variation: version},
2778 {Mutator: "link", Variation: "shared"},
2779 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002780
2781 if vndkdep := c.vndkdep; vndkdep != nil {
2782 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002783 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002784 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002785 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002786 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002787 }
2788 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002789
Vinh Tran367d89d2023-04-28 11:21:25 -04002790 if len(deps.AidlLibs) > 0 {
2791 actx.AddDependency(
2792 c,
2793 aidlLibraryTag,
2794 deps.AidlLibs...,
2795 )
2796 }
2797
Kiyoung Kimee58c932022-10-25 22:59:41 +09002798 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002799}
Colin Cross21b9a242015-03-24 14:15:58 -07002800
Colin Crosse40b4ea2018-10-02 22:25:58 -07002801func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002802 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2803 c.beginMutator(ctx)
2804 }
2805}
2806
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002807// Whether a module can link to another module, taking into
2808// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002809func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002810 tag blueprint.DependencyTag) {
2811
2812 switch t := tag.(type) {
2813 case dependencyTag:
2814 if t != vndkExtDepTag {
2815 return
2816 }
2817 case libraryDependencyTag:
2818 default:
2819 return
2820 }
2821
Ivan Lozanof9e21722020-12-02 09:00:51 -05002822 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002823 // Host code is not restricted
2824 return
2825 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002826
2827 // VNDK is cc.Module supported only for now.
2828 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002829 // Though allowed dependency is limited by the image mutator,
2830 // each vendor and product module needs to check link-type
2831 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002832 if ccTo, ok := to.(*Module); ok {
2833 if ccFrom.vndkdep != nil {
2834 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2835 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002836 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002837 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002838 }
2839 return
2840 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002841 // TODO(b/244244438) : Remove this once all variants are implemented
2842 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2843 return
2844 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002845 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002846 // Platform code can link to anything
2847 return
2848 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002849 if from.InRamdisk() {
2850 // Ramdisk code is not NDK
2851 return
2852 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002853 if from.InVendorRamdisk() {
2854 // Vendor ramdisk code is not NDK
2855 return
2856 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002857 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002858 // Recovery code is not NDK
2859 return
2860 }
Colin Cross31076b32020-10-23 17:22:06 -07002861 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002862 if c.NdkPrebuiltStl() {
2863 // These are allowed, but they don't set sdk_version
2864 return
2865 }
2866 if c.StubDecorator() {
2867 // These aren't real libraries, but are the stub shared libraries that are included in
2868 // the NDK.
2869 return
2870 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002871 if c.isImportedApiLibrary() {
2872 // Imported library from the API surface is a stub library built against interface definition.
2873 return
2874 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002875 }
Logan Chien834b9a62019-01-14 15:39:03 +08002876
Ivan Lozano52767be2019-10-18 14:49:46 -07002877 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002878 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2879 // to link to libc++ (non-NDK and without sdk_version).
2880 return
2881 }
2882
Ivan Lozano52767be2019-10-18 14:49:46 -07002883 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002884 // NDK code linking to platform code is never okay.
2885 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002886 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002887 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002888 }
2889
2890 // At this point we know we have two NDK libraries, but we need to
2891 // check that we're not linking against anything built against a higher
2892 // API level, as it is only valid to link against older or equivalent
2893 // APIs.
2894
Inseob Kim01a28722018-04-11 09:48:45 +09002895 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002896 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002897 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002898 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002899 // Current can't be linked against by anything else.
2900 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002901 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002902 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002903 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002904 if err != nil {
2905 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002906 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002907 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002908 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002909 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002910 if err != nil {
2911 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002912 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002913 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002914 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002915
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002916 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002917 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002918 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002919 }
2920 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002921 }
Dan Albert202fe492017-12-15 13:56:59 -08002922
2923 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002924 fromStl := from.SelectedStl()
2925 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002926 if fromStl == "" || toStl == "" {
2927 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002928 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002929 // We can be permissive with the system "STL" since it is only the C++
2930 // ABI layer, but in the future we should make sure that everyone is
2931 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002932 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002933 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002934 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2935 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002936 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002937}
2938
Jooyung Han479ca172020-10-19 18:51:07 +09002939func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2940 if c, ok := ctx.Module().(*Module); ok {
2941 ctx.VisitDirectDeps(func(dep android.Module) {
2942 depTag := ctx.OtherModuleDependencyTag(dep)
2943 ccDep, ok := dep.(LinkableInterface)
2944 if ok {
2945 checkLinkType(ctx, c, ccDep, depTag)
2946 }
2947 })
2948 }
2949}
2950
Jiyong Park5fb8c102018-04-09 12:03:06 +09002951// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002952// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2953// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002954// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002955func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2956 check := func(child, parent android.Module) bool {
2957 to, ok := child.(*Module)
2958 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002959 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002960 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002961
Jooyung Hana70f0672019-01-18 15:20:43 +09002962 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2963 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002964 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002965
Jiyong Park0474e1f2021-01-14 14:26:06 +09002966 // These dependencies are not excercised at runtime. Tracking these will give us
2967 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002968 depTag := ctx.OtherModuleDependencyTag(child)
2969 if IsHeaderDepTag(depTag) {
2970 return false
2971 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002972 if depTag == staticVariantTag {
2973 return false
2974 }
2975 if depTag == stubImplDepTag {
2976 return false
2977 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002978
Justin Yun63e9ec72020-10-29 16:49:43 +09002979 // Even if target lib has no vendor variant, keep checking dependency
2980 // graph in case it depends on vendor_available or product_available
2981 // but not double_loadable transtively.
2982 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002983 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002984 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002985
Jiyong Park0474e1f2021-01-14 14:26:06 +09002986 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2987 // one.
2988 if Bool(to.VendorProperties.Double_loadable) {
2989 return true
2990 }
2991
Ivan Lozanod7586b62021-04-01 09:49:36 -04002992 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002993 return false
2994 }
2995
Jooyung Hana70f0672019-01-18 15:20:43 +09002996 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2997 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002998 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002999 return false
3000 }
3001 if module, ok := ctx.Module().(*Module); ok {
3002 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003003 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003004 ctx.WalkDeps(check)
3005 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003006 }
3007 }
3008}
3009
Yu Liue4312402023-01-18 09:15:31 -08003010func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3011 // For the dependency from platform to apex, use the latest stubs
3012 apexSdkVersion := android.FutureApiLevel
3013 if !apexInfo.IsForPlatform() {
3014 apexSdkVersion = apexInfo.MinSdkVersion
3015 }
3016
3017 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3018 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3019 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3020 // (b/144430859)
3021 apexSdkVersion = android.FutureApiLevel
3022 }
3023
3024 return apexSdkVersion
3025}
3026
Colin Crossc99deeb2016-04-11 15:06:20 -07003027// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003028func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003029 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003030
Colin Cross0de8a1e2020-09-18 14:15:30 -07003031 var directStaticDeps []StaticLibraryInfo
3032 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003033
Colin Cross0de8a1e2020-09-18 14:15:30 -07003034 reexportExporter := func(exporter FlagExporterInfo) {
3035 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3036 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3037 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3038 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3039 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003040 }
3041
Colin Crossff694a82023-12-13 15:54:49 -08003042 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003043 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003044
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003045 skipModuleList := map[string]bool{}
3046
3047 var apiImportInfo multitree.ApiImportInfo
3048 hasApiImportInfo := false
3049
3050 ctx.VisitDirectDeps(func(dep android.Module) {
3051 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003052 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003053 hasApiImportInfo = true
3054 }
3055 })
3056
3057 if hasApiImportInfo {
3058 targetStubModuleList := map[string]string{}
3059 targetOrigModuleList := map[string]string{}
3060
3061 // Search for dependency which both original module and API imported library with APEX stub exists
3062 ctx.VisitDirectDeps(func(dep android.Module) {
3063 depName := ctx.OtherModuleName(dep)
3064 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3065 targetStubModuleList[apiLibrary] = depName
3066 }
3067 })
3068 ctx.VisitDirectDeps(func(dep android.Module) {
3069 depName := ctx.OtherModuleName(dep)
3070 if origLibrary, ok := targetStubModuleList[depName]; ok {
3071 targetOrigModuleList[origLibrary] = depName
3072 }
3073 })
3074
3075 // Decide which library should be used between original and API imported library
3076 ctx.VisitDirectDeps(func(dep android.Module) {
3077 depName := ctx.OtherModuleName(dep)
3078 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003079 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003080 skipModuleList[depName] = true
3081 } else {
3082 skipModuleList[apiLibrary] = true
3083 }
3084 }
3085 })
3086 }
3087
Colin Crossd11fcda2017-10-23 17:59:01 -07003088 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003089 depName := ctx.OtherModuleName(dep)
3090 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003091
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003092 if _, ok := skipModuleList[depName]; ok {
3093 // skip this module because original module or API imported module matching with this should be used instead.
3094 return
3095 }
3096
Dan Willemsen47450072021-10-19 20:24:49 -07003097 if depTag == android.DarwinUniversalVariantTag {
3098 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3099 return
3100 }
3101
Vinh Tran367d89d2023-04-28 11:21:25 -04003102 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003103 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003104 depPaths.AidlLibraryInfos = append(
3105 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003106 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003107 )
3108 }
3109 }
3110
Ivan Lozano52767be2019-10-18 14:49:46 -07003111 ccDep, ok := dep.(LinkableInterface)
3112 if !ok {
3113
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003114 // handling for a few module types that aren't cc Module but that are also supported
3115 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003116 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003117 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003118 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3119 genRule.GeneratedSourceFiles()...)
3120 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003121 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003122 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003123 // Support exported headers from a generated_sources dependency
3124 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003125 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003126 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003127 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003128 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003129 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003130 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003131 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003132 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003133 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3134 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003135 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003136 // 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 +09003137 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003138
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003139 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003140 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003141 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003142 }
Colin Crosscef792e2021-06-11 18:01:26 -07003143 case CrtBeginDepTag:
3144 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3145 case CrtEndDepTag:
3146 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003147 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003148 return
3149 }
3150
Colin Crossfe17f6f2019-03-28 19:30:56 -07003151 if depTag == android.ProtoPluginDepTag {
3152 return
3153 }
3154
Colin Crossd11fcda2017-10-23 17:59:01 -07003155 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003156 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3157 return
3158 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003159 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003160 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3161 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003162 return
3163 }
3164
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003165 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003166 // Skip reused objects for stub libraries, they use their own stub object file instead.
3167 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3168 // version mutator, so the stubs variant is created from the shared variant that
3169 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003170 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003171 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003172 objs := staticAnalogue.ReuseObjects
3173 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003174 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003175 reexportExporter(depExporterInfo)
3176 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003177 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003178 }
3179
Colin Cross6e511a92020-07-27 21:26:48 -07003180 linkFile := ccDep.OutputFile()
3181
3182 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3183 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003184 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003185 return
3186 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003187
Jiyong Parke3867542020-12-03 17:28:25 +09003188 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3189 return
3190 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003191 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3192 return
3193 }
Jiyong Parke3867542020-12-03 17:28:25 +09003194
Colin Cross313aa542023-12-13 13:47:44 -08003195 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003196
Colin Cross6e511a92020-07-27 21:26:48 -07003197 var ptr *android.Paths
3198 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003199
Colin Cross6e511a92020-07-27 21:26:48 -07003200 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003201
Colin Cross6e511a92020-07-27 21:26:48 -07003202 switch {
3203 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003204 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003205 if !ctx.Config().AllowMissingDependencies() {
3206 ctx.ModuleErrorf("module %q is not a header library", depName)
3207 } else {
3208 ctx.AddMissingDependencies([]string{depName})
3209 }
3210 return
3211 }
Colin Cross6e511a92020-07-27 21:26:48 -07003212 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003213 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003214 if !ctx.Config().AllowMissingDependencies() {
3215 ctx.ModuleErrorf("module %q is not a shared library", depName)
3216 } else {
3217 ctx.AddMissingDependencies([]string{depName})
3218 }
3219 return
3220 }
Jiyong Parke3867542020-12-03 17:28:25 +09003221
Jiyong Park7d55b612021-06-11 17:22:09 +09003222 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3223 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003224
Jiyong Park1ad8e162020-12-01 23:40:09 +09003225 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3226 // linkFile, depFile, and ptr.
3227 if c.IsStubs() {
3228 break
3229 }
3230
Colin Cross0de8a1e2020-09-18 14:15:30 -07003231 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3232 depFile = sharedLibraryInfo.TableOfContents
3233
Colin Cross6e511a92020-07-27 21:26:48 -07003234 ptr = &depPaths.SharedLibs
3235 switch libDepTag.Order {
3236 case earlyLibraryDependency:
3237 ptr = &depPaths.EarlySharedLibs
3238 depPtr = &depPaths.EarlySharedLibsDeps
3239 case normalLibraryDependency:
3240 ptr = &depPaths.SharedLibs
3241 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003242 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003243 case lateLibraryDependency:
3244 ptr = &depPaths.LateSharedLibs
3245 depPtr = &depPaths.LateSharedLibsDeps
3246 default:
3247 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003248 }
Colin Cross6e511a92020-07-27 21:26:48 -07003249 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003250 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3251 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003252 if !ctx.Config().AllowMissingDependencies() {
3253 ctx.ModuleErrorf("module %q is not a static library", depName)
3254 } else {
3255 ctx.AddMissingDependencies([]string{depName})
3256 }
3257 return
3258 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003259
3260 // Stubs lib doesn't link to the static lib dependencies. Don't set
3261 // linkFile, depFile, and ptr.
3262 if c.IsStubs() {
3263 break
3264 }
3265
Colin Cross0de8a1e2020-09-18 14:15:30 -07003266 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003267 if libDepTag.wholeStatic {
3268 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003269 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3270 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003271 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003272 // This case normally catches prebuilt static
3273 // libraries, but it can also occur when
3274 // AllowMissingDependencies is on and the
3275 // dependencies has no sources of its own
3276 // but has a whole_static_libs dependency
3277 // on a missing library. We want to depend
3278 // on the .a file so that there is something
3279 // in the dependency tree that contains the
3280 // error rule for the missing transitive
3281 // dependency.
3282 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003283 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003284 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3285 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003286 } else {
3287 switch libDepTag.Order {
3288 case earlyLibraryDependency:
3289 panic(fmt.Errorf("early static libs not suppported"))
3290 case normalLibraryDependency:
3291 // static dependencies will be handled separately so they can be ordered
3292 // using transitive dependencies.
3293 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003294 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003295 case lateLibraryDependency:
3296 ptr = &depPaths.LateStaticLibs
3297 default:
3298 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003299 }
3300 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003301 if libDepTag.unexportedSymbols {
3302 depPaths.LdFlags = append(depPaths.LdFlags,
3303 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3304 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003305 }
3306
Colin Cross6e511a92020-07-27 21:26:48 -07003307 if libDepTag.static() && !libDepTag.wholeStatic {
3308 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3309 ctx.ModuleErrorf("module %q not a static library", depName)
3310 return
3311 }
Logan Chien43d34c32017-12-20 01:17:32 +08003312
Colin Cross6e511a92020-07-27 21:26:48 -07003313 // When combining coverage files for shared libraries and executables, coverage files
3314 // in static libraries act as if they were whole static libraries. The same goes for
3315 // source based Abi dump files.
3316 if c, ok := ccDep.(*Module); ok {
3317 staticLib := c.linker.(libraryInterface)
3318 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3319 staticLib.objs().coverageFiles...)
3320 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3321 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003322 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003323 // Handle non-CC modules here
3324 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003325 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003326 }
3327 }
3328
Colin Cross6e511a92020-07-27 21:26:48 -07003329 if ptr != nil {
3330 if !linkFile.Valid() {
3331 if !ctx.Config().AllowMissingDependencies() {
3332 ctx.ModuleErrorf("module %q missing output file", depName)
3333 } else {
3334 ctx.AddMissingDependencies([]string{depName})
3335 }
3336 return
3337 }
3338 *ptr = append(*ptr, linkFile.Path())
3339 }
3340
3341 if depPtr != nil {
3342 dep := depFile
3343 if !dep.Valid() {
3344 dep = linkFile
3345 }
3346 *depPtr = append(*depPtr, dep.Path())
3347 }
3348
Colin Cross0de8a1e2020-09-18 14:15:30 -07003349 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3350 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3351 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3352 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3353
3354 if libDepTag.reexportFlags {
3355 reexportExporter(depExporterInfo)
3356 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3357 // Re-exported shared library headers must be included as well since they can help us with type information
3358 // about template instantiations (instantiated from their headers).
3359 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3360 // scripts.
3361 c.sabi.Properties.ReexportedIncludes = append(
3362 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3363 }
3364
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003365 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003366 switch {
3367 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003368 c.Properties.AndroidMkHeaderLibs = append(
3369 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003370 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003371 if lib := moduleLibraryInterface(dep); lib != nil {
3372 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003373 // Add the dependency to the APEX(es) providing the library so that
3374 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003375 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003376 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003377 c.Properties.ApexesProvidingSharedLibs = append(
3378 c.Properties.ApexesProvidingSharedLibs, an)
3379 }
3380 }
3381 }
3382
3383 // Note: the order of libs in this list is not important because
3384 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003385 c.Properties.AndroidMkSharedLibs = append(
3386 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003387 // Record BaseLibName for snapshots.
3388 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003389 case libDepTag.static():
3390 if libDepTag.wholeStatic {
3391 c.Properties.AndroidMkWholeStaticLibs = append(
3392 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3393 } else {
3394 c.Properties.AndroidMkStaticLibs = append(
3395 c.Properties.AndroidMkStaticLibs, makeLibName)
3396 }
Justin Yun5e035862021-06-29 20:50:37 +09003397 // Record BaseLibName for snapshots.
3398 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003399 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003400 } else if !c.IsStubs() {
3401 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3402
Colin Cross6e511a92020-07-27 21:26:48 -07003403 switch depTag {
3404 case runtimeDepTag:
3405 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003406 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003407 // Record BaseLibName for snapshots.
3408 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003409 case objDepTag:
3410 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3411 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003412 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003413 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003414 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003415 case dynamicLinkerDepTag:
3416 depPaths.DynamicLinker = linkFile
3417 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003418 }
Colin Crossca860ac2016-01-04 14:34:37 -08003419 })
3420
Jeff Gaston294356f2017-09-27 17:05:30 -07003421 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003422 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3423 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3424 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003425
Colin Crossdd84e052017-05-17 13:44:16 -07003426 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003427 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003428 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3429 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003430 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003431 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3432 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003433 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003434 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003435 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003436
3437 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003438 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003439 }
Colin Crossdd84e052017-05-17 13:44:16 -07003440
Colin Crossca860ac2016-01-04 14:34:37 -08003441 return depPaths
3442}
3443
Spandan Das604f3762023-03-16 22:51:40 +00003444func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003445 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003446 thisModule, ok := ctx.Module().(android.ApexModule)
3447 if !ok {
3448 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3449 }
3450
Kiyoung Kimaa394802024-01-08 12:55:45 +09003451 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003452 bootstrap := false
3453 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3454 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3455 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003456 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003457 bootstrap = linkable.Bootstrap()
3458 }
3459
Colin Crossff694a82023-12-13 15:54:49 -08003460 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003461
3462 useStubs := false
3463
Kiyoung Kimaa394802024-01-08 12:55:45 +09003464 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003465 if !apexInfo.IsForPlatform() {
3466 // For platform libraries, use current version of LLNDK
3467 // If this is for use_vendor apex we will apply the same rules
3468 // of apex sdk enforcement below to choose right version.
3469 useStubs = true
3470 }
3471 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3472 // If not building for APEX or the containing APEX allows the use of
3473 // platform APIs, use stubs only when it is from an APEX (and not from
3474 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3475 // bootstrap modules, always link to non-stub variant
3476 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3477
3478 isApexImportedApiLibrary := false
3479
3480 if cc, ok := dep.(*Module); ok {
3481 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3482 if apiLibrary.hasApexStubs() {
3483 isApexImportedApiLibrary = true
3484 }
3485 }
3486 }
3487
3488 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3489
3490 if useStubs {
3491 // Another exception: if this module is a test for an APEX, then
3492 // it is linked with the non-stub variant of a module in the APEX
3493 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003494 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003495 for _, apexContents := range testFor.ApexContents {
3496 if apexContents.DirectlyInApex(depName) {
3497 useStubs = false
3498 break
3499 }
3500 }
3501 }
3502 if useStubs {
3503 // Yet another exception: If this module and the dependency are
3504 // available to the same APEXes then skip stubs between their
3505 // platform variants. This complements the test_for case above,
3506 // which avoids the stubs on a direct APEX library dependency, by
3507 // avoiding stubs for indirect test dependencies as well.
3508 //
3509 // TODO(b/183882457): This doesn't work if the two libraries have
3510 // only partially overlapping apex_available. For that test_for
3511 // modules would need to be split into APEX variants and resolved
3512 // separately for each APEX they have access to.
3513 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3514 useStubs = false
3515 }
3516 }
3517 } else {
3518 // If building for APEX, use stubs when the parent is in any APEX that
3519 // the child is not in.
3520 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3521 }
3522
3523 return useStubs
3524}
3525
3526// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3527// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3528// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3529// has different level of updatability. For example, if a library foo in an APEX depends on a
3530// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3531// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3532// same APEX as foo, the non-stub variant of bar is used.
3533func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3534 depTag := ctx.OtherModuleDependencyTag(dep)
3535 libDepTag, ok := depTag.(libraryDependencyTag)
3536 if !ok || !libDepTag.shared() {
3537 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3538 }
3539
Colin Cross313aa542023-12-13 13:47:44 -08003540 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3541 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3542 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003543
3544 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003545 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003546 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003547 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3548 toUse := stubs[len(stubs)-1]
3549 sharedLibraryInfo = toUse.SharedLibraryInfo
3550 depExporterInfo = toUse.FlagExporterInfo
3551 }
3552 }
3553 return sharedLibraryInfo, depExporterInfo
3554}
3555
Colin Cross0de8a1e2020-09-18 14:15:30 -07003556// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3557// to match the topological order of the dependency tree, including any static analogues of
3558// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3559// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003560func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3561 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003562 var staticPaths android.Paths
3563 for _, staticDep := range staticDeps {
3564 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3565 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3566 }
3567 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003568 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3569 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003570 }
3571 }
3572 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3573
3574 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3575
3576 // reorder the dependencies based on transitive dependencies
3577 staticPaths = android.FirstUniquePaths(staticPaths)
3578 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3579
3580 if len(orderedStaticPaths) != len(staticPaths) {
3581 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3582 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3583 }
3584
3585 return orderedStaticPaths, transitiveStaticLibs
3586}
3587
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003588// BaseLibName trims known prefixes and suffixes
3589func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003590 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3591 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003592 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003593 return libName
3594}
3595
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003596func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003597 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003598 ccDepModule, _ := ccDep.(*Module)
3599 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003600 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003601
Justin Yuncbca3732021-02-03 19:24:13 +09003602 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003603 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003604 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003605 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003606
Ivan Lozanod1dec542021-05-26 15:33:11 -04003607 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003608 }
3609 }
3610
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003611 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3612 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003613 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3614 // core module instead.
3615 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003616 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003617 // The vendor and product modules in Make will have been renamed to not conflict with the
3618 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003619 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003620 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003621 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003622 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003623 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003624 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003625 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003626 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003627 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003628 } else {
3629 return libName
3630 }
3631}
3632
Colin Crossca860ac2016-01-04 14:34:37 -08003633func (c *Module) InstallInData() bool {
3634 if c.installer == nil {
3635 return false
3636 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003637 return c.installer.inData()
3638}
3639
3640func (c *Module) InstallInSanitizerDir() bool {
3641 if c.installer == nil {
3642 return false
3643 }
3644 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003645 return true
3646 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003647 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003648}
3649
Yifan Hong1b3348d2020-01-21 15:53:22 -08003650func (c *Module) InstallInRamdisk() bool {
3651 return c.InRamdisk()
3652}
3653
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003654func (c *Module) InstallInVendorRamdisk() bool {
3655 return c.InVendorRamdisk()
3656}
3657
Jiyong Parkf9332f12018-02-01 00:54:12 +09003658func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003659 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003660}
3661
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003662func (c *Module) MakeUninstallable() {
3663 if c.installer == nil {
3664 c.ModuleBase.MakeUninstallable()
3665 return
3666 }
3667 c.installer.makeUninstallable(c)
3668}
3669
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003670func (c *Module) HostToolPath() android.OptionalPath {
3671 if c.installer == nil {
3672 return android.OptionalPath{}
3673 }
3674 return c.installer.hostToolPath()
3675}
3676
Nan Zhangd4e641b2017-07-12 12:55:28 -07003677func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3678 return c.outputFile
3679}
3680
Colin Cross41955e82019-05-29 14:40:35 -07003681func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3682 switch tag {
3683 case "":
3684 if c.outputFile.Valid() {
3685 return android.Paths{c.outputFile.Path()}, nil
3686 }
3687 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003688 case "unstripped":
3689 if c.linker != nil {
3690 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3691 }
3692 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003693 case "stripped_all":
3694 if c.linker != nil {
3695 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3696 }
3697 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003698 default:
3699 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003700 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003701}
3702
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003703func (c *Module) static() bool {
3704 if static, ok := c.linker.(interface {
3705 static() bool
3706 }); ok {
3707 return static.static()
3708 }
3709 return false
3710}
3711
Jiyong Park379de2f2018-12-19 02:47:14 +09003712func (c *Module) staticBinary() bool {
3713 if static, ok := c.linker.(interface {
3714 staticBinary() bool
3715 }); ok {
3716 return static.staticBinary()
3717 }
3718 return false
3719}
3720
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003721func (c *Module) testBinary() bool {
3722 if test, ok := c.linker.(interface {
3723 testBinary() bool
3724 }); ok {
3725 return test.testBinary()
3726 }
3727 return false
3728}
3729
Jingwen Chen537242c2022-08-24 11:53:27 +00003730func (c *Module) testLibrary() bool {
3731 if test, ok := c.linker.(interface {
3732 testLibrary() bool
3733 }); ok {
3734 return test.testLibrary()
3735 }
3736 return false
3737}
3738
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003739func (c *Module) benchmarkBinary() bool {
3740 if b, ok := c.linker.(interface {
3741 benchmarkBinary() bool
3742 }); ok {
3743 return b.benchmarkBinary()
3744 }
3745 return false
3746}
3747
3748func (c *Module) fuzzBinary() bool {
3749 if f, ok := c.linker.(interface {
3750 fuzzBinary() bool
3751 }); ok {
3752 return f.fuzzBinary()
3753 }
3754 return false
3755}
3756
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003757// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3758func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003759 if h, ok := c.linker.(interface {
3760 header() bool
3761 }); ok {
3762 return h.header()
3763 }
3764 return false
3765}
3766
Ivan Lozanod7586b62021-04-01 09:49:36 -04003767func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003768 if b, ok := c.linker.(interface {
3769 binary() bool
3770 }); ok {
3771 return b.binary()
3772 }
3773 return false
3774}
3775
Justin Yun5e035862021-06-29 20:50:37 +09003776func (c *Module) StaticExecutable() bool {
3777 if b, ok := c.linker.(*binaryDecorator); ok {
3778 return b.static()
3779 }
3780 return false
3781}
3782
Ivan Lozanod7586b62021-04-01 09:49:36 -04003783func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003784 if o, ok := c.linker.(interface {
3785 object() bool
3786 }); ok {
3787 return o.object()
3788 }
3789 return false
3790}
3791
Ivan Lozanof9e21722020-12-02 09:00:51 -05003792func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003793 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003794 if c.IsLlndk() {
3795 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003796 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003797 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003798 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003799 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003800 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003801 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003802 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003803 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003804 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003805 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003806 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003807 return "native:product"
3808 }
Jooyung Han38002912019-05-16 04:01:54 +09003809 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003810 } else if c.InRamdisk() {
3811 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003812 } else if c.InVendorRamdisk() {
3813 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003814 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003815 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003816 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003817 return "native:ndk:none:none"
3818 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3819 //family, link := getNdkStlFamilyAndLinkType(c)
3820 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003821 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003822 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003823 } else {
3824 return "native:platform"
3825 }
3826}
3827
Jiyong Park9d452992018-10-03 00:38:19 +09003828// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003829// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003830func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003831 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003832 // Stub libs and prebuilt libs in a versioned SDK are not
3833 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003834 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003835 } else if _, ok := c.linker.(testPerSrc); ok {
3836 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003837 }
3838 return false
3839}
3840
Jiyong Parka90ca002019-10-07 15:47:24 +09003841func (c *Module) AvailableFor(what string) bool {
3842 if linker, ok := c.linker.(interface {
3843 availableFor(string) bool
3844 }); ok {
3845 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3846 } else {
3847 return c.ApexModuleBase.AvailableFor(what)
3848 }
3849}
3850
Jiyong Park62304bb2020-04-13 16:19:48 +09003851func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003852 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003853}
3854
Paul Duffin0cb37b92020-03-04 14:52:46 +00003855func (c *Module) EverInstallable() bool {
3856 return c.installer != nil &&
3857 // Check to see whether the module is actually ever installable.
3858 c.installer.everInstallable()
3859}
3860
Ivan Lozanod7586b62021-04-01 09:49:36 -04003861func (c *Module) PreventInstall() bool {
3862 return c.Properties.PreventInstall
3863}
3864
3865func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003866 if c.library != nil {
3867 if i := c.library.installable(); i != nil {
3868 return i
3869 }
3870 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003871 return c.Properties.Installable
3872}
3873
3874func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003875 ret := c.EverInstallable() &&
3876 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003877 proptools.BoolDefault(c.Installable(), true) &&
3878 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003879
3880 // The platform variant doesn't need further condition. Apex variants however might not
3881 // be installable because it will likely to be included in the APEX and won't appear
3882 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003883 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003884 return ret
3885 }
3886
3887 // Special case for modules that are configured to be installed to /data, which includes
3888 // test modules. For these modules, both APEX and non-APEX variants are considered as
3889 // installable. This is because even the APEX variants won't be included in the APEX, but
3890 // will anyway be installed to /data/*.
3891 // See b/146995717
3892 if c.InstallInData() {
3893 return ret
3894 }
3895
3896 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003897}
3898
Logan Chien41eabe62019-04-10 13:33:58 +08003899func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3900 if c.linker != nil {
3901 if library, ok := c.linker.(*libraryDecorator); ok {
3902 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3903 }
3904 }
3905}
3906
Jiyong Park45bf82e2020-12-15 22:29:02 +09003907var _ android.ApexModule = (*Module)(nil)
3908
3909// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003910func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003911 depTag := ctx.OtherModuleDependencyTag(dep)
3912 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3913
3914 if cc, ok := dep.(*Module); ok {
3915 if cc.HasStubsVariants() {
3916 if isLibDepTag && libDepTag.shared() {
3917 // dynamic dep to a stubs lib crosses APEX boundary
3918 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003919 }
Colin Cross6e511a92020-07-27 21:26:48 -07003920 if IsRuntimeDepTag(depTag) {
3921 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003922 return false
3923 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003924 }
Zhijun Heec285872021-04-24 10:47:08 -07003925 if cc.IsLlndk() {
3926 return false
3927 }
Colin Crossaac32222020-07-29 12:51:56 -07003928 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003929 // shared_lib dependency from a static lib is considered as crossing
3930 // the APEX boundary because the dependency doesn't actually is
3931 // linked; the dependency is used only during the compilation phase.
3932 return false
3933 }
Jiyong Parke3867542020-12-03 17:28:25 +09003934
3935 if isLibDepTag && libDepTag.excludeInApex {
3936 return false
3937 }
Colin Cross6e511a92020-07-27 21:26:48 -07003938 }
Colin Crossc1b36442021-05-06 13:42:48 -07003939 if depTag == stubImplDepTag {
3940 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003941 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003942 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003943 if depTag == staticVariantTag {
3944 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3945 // actually mean that the static lib (and its dependencies) are copied into the
3946 // APEX.
3947 return false
3948 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003949 return true
3950}
3951
Jiyong Park45bf82e2020-12-15 22:29:02 +09003952// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003953func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3954 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003955 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3956 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3957 return nil
3958 }
Jooyung Han749dc692020-04-15 11:03:39 +09003959 // We don't check for prebuilt modules
3960 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3961 return nil
3962 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003963
Jooyung Han749dc692020-04-15 11:03:39 +09003964 minSdkVersion := c.MinSdkVersion()
3965 if minSdkVersion == "apex_inherit" {
3966 return nil
3967 }
3968 if minSdkVersion == "" {
3969 // JNI libs within APK-in-APEX fall into here
3970 // Those are okay to set sdk_version instead
3971 // We don't have to check if this is a SDK variant because
3972 // non-SDK variant resets sdk_version, which works too.
3973 minSdkVersion = c.SdkVersion()
3974 }
Dan Albertc8060532020-07-22 22:32:17 -07003975 if minSdkVersion == "" {
3976 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3977 }
3978 // Not using nativeApiLevelFromUser because the context here is not
3979 // necessarily a native context.
3980 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003981 if err != nil {
3982 return err
3983 }
Dan Albertc8060532020-07-22 22:32:17 -07003984
Colin Cross8ca61c12022-10-06 21:00:14 -07003985 // A dependency only needs to support a min_sdk_version at least
3986 // as high as the api level that the architecture was introduced in.
3987 // This allows introducing new architectures in the platform that
3988 // need to be included in apexes that normally require an older
3989 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003990 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003991 if sdkVersion.LessThan(minApiForArch) {
3992 sdkVersion = minApiForArch
3993 }
3994
Dan Albertc8060532020-07-22 22:32:17 -07003995 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003996 return fmt.Errorf("newer SDK(%v)", ver)
3997 }
3998 return nil
3999}
4000
Paul Duffinb5769c12021-05-12 16:16:51 +01004001// Implements android.ApexModule
4002func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4003 // stub libraries and native bridge libraries are always available to platform
4004 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4005}
4006
Jooyung Han91f92032022-02-04 12:36:33 +09004007// Overrides android.ApexModuleBase.UniqueApexVariations
4008func (c *Module) UniqueApexVariations() bool {
4009 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4010 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4011 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004012 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004013 return c.UseVndk() && c.IsVndk()
4014}
4015
Inseob Kima1888ce2022-10-04 14:42:02 +09004016func (c *Module) overriddenModules() []string {
4017 if o, ok := c.linker.(overridable); ok {
4018 return o.overriddenModules()
4019 }
4020 return nil
4021}
4022
Rob Seymour925aa092021-08-10 20:42:03 +00004023var _ snapshot.RelativeInstallPath = (*Module)(nil)
4024
Liz Kammer35ca77e2021-12-22 15:31:40 -05004025type moduleType int
4026
4027const (
4028 unknownType moduleType = iota
4029 binary
4030 object
4031 fullLibrary
4032 staticLibrary
4033 sharedLibrary
4034 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004035 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004036 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004037 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004038)
4039
4040func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004041 if c.testBinary() {
4042 // testBinary is also a binary, so this comes before the c.Binary()
4043 // conditional. A testBinary has additional implicit dependencies and
4044 // other test-only semantics.
4045 return testBin
4046 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004047 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004048 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004049 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004050 } else if c.testLibrary() {
4051 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4052 // will let them add implicit compile deps on gtest, for example.
4053 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004054 // For now, treat them as regular libraries.
4055 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004056 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004057 static := false
4058 shared := false
4059 if library, ok := c.linker.(*libraryDecorator); ok {
4060 static = library.MutatedProperties.BuildStatic
4061 shared = library.MutatedProperties.BuildShared
4062 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4063 static = library.MutatedProperties.BuildStatic
4064 shared = library.MutatedProperties.BuildShared
4065 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004066 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004067 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004068 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004069 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004070 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004071 return staticLibrary
4072 }
4073 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004074 } else if c.isNDKStubLibrary() {
4075 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004076 } else if c.IsNdkPrebuiltStl() {
4077 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004078 }
4079 return unknownType
4080}
4081
Colin Crosscfad1192015-11-02 16:43:11 -08004082// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004083type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004084 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004085 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004086 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004087
4088 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4089 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004090}
4091
Patrice Arrudac249c712019-03-19 17:00:29 -07004092// cc_defaults provides a set of properties that can be inherited by other cc
4093// modules. A module can use the properties from a cc_defaults using
4094// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4095// merged (when possible) by prepending the default module's values to the
4096// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004097func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004098 return DefaultsFactory()
4099}
4100
Colin Cross36242852017-06-23 15:06:31 -07004101func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004102 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004103
Colin Cross36242852017-06-23 15:06:31 -07004104 module.AddProperties(props...)
4105 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004106 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004107 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004108 &BaseCompilerProperties{},
4109 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004110 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004111 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004112 &StaticProperties{},
4113 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004114 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004115 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004116 &TestLinkerProperties{},
4117 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004118 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004119 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004120 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004121 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004122 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004123 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004124 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004125 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004126 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004127 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004128 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004129 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004130 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004131 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004132 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004133 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4134 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004135 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004136 )
Colin Crosscfad1192015-11-02 16:43:11 -08004137
Jooyung Hancc372c52019-09-25 15:18:44 +09004138 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004139
4140 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004141}
4142
Jiyong Park2286afd2020-06-16 21:58:53 +09004143func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004144 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004145}
4146
Kiyoung Kim51279d32022-08-24 14:10:46 +09004147func (c *Module) isImportedApiLibrary() bool {
4148 _, ok := c.linker.(*apiLibraryDecorator)
4149 return ok
4150}
4151
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004152func kytheExtractAllFactory() android.Singleton {
4153 return &kytheExtractAllSingleton{}
4154}
4155
4156type kytheExtractAllSingleton struct {
4157}
4158
4159func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4160 var xrefTargets android.Paths
4161 ctx.VisitAllModules(func(module android.Module) {
4162 if ccModule, ok := module.(xref); ok {
4163 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4164 }
4165 })
4166 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4167 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004168 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004169 }
4170}
4171
Jihoon Kangf78a8902022-09-01 22:47:07 +00004172func (c *Module) Partition() string {
4173 if p, ok := c.installer.(interface {
4174 getPartition() string
4175 }); ok {
4176 return p.getPartition()
4177 }
4178 return ""
4179}
4180
Spandan Das2b6dfb52024-01-19 00:22:22 +00004181type sourceModuleName interface {
4182 sourceModuleName() string
4183}
4184
4185func (c *Module) BaseModuleName() string {
4186 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4187 // if the prebuilt module sets a source_module_name in Android.bp, use that
4188 return smn.sourceModuleName()
4189 }
4190 return c.ModuleBase.BaseModuleName()
4191}
4192
Colin Cross06a931b2015-10-28 17:23:31 -07004193var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004194var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004195var BoolPtr = proptools.BoolPtr
4196var String = proptools.String
4197var StringPtr = proptools.StringPtr