blob: 40e40e96b25c9465d479cf68dba1bab5ce90b9a2 [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 Cross1e676be2016-10-12 14:38:15 -070058 })
Colin Cross16b23492016-01-06 14:41:07 -080059
Paul Duffin036e7002019-12-19 19:16:28 +000060 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040061 for _, san := range Sanitizers {
62 san.registerMutators(ctx)
63 }
Dan Willemsen581341d2017-02-09 16:16:31 -080064
Colin Cross0b908332019-06-19 23:00:20 -070065 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090066 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080067
Cory Barkera1da26f2022-06-07 20:12:06 +000068 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000069
Colin Crossf5f4ad32024-01-19 15:41:48 -080070 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -070071
Colin Crossd38feb02024-01-23 16:38:06 -080072 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +080073
Colin Cross33e0c812024-01-23 16:36:07 -080074 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000075
Colin Cross6ac83a82024-01-23 11:23:10 -080076 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +090077
Jooyung Han479ca172020-10-19 18:51:07 +090078 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090079 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070080 })
Colin Crossb98c8b02016-07-29 13:44:28 -070081
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080082 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
83 // sabi mutator needs to be run after apex mutator finishes.
84 ctx.TopDown("sabi_deps", sabiDepsMutator)
85 })
86
LaMont Jones0c10e4d2023-05-16 00:58:37 +000087 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070088}
89
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050090// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
91// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
92// edges to these modules.
93// This object is constructed in DepsMutator, by calling to various module delegates to set
94// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
95// dependencies.
96// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
97// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080098type Deps struct {
99 SharedLibs, LateSharedLibs []string
100 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800101 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800102 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700103
Colin Cross3e5e7782022-06-17 22:17:05 +0000104 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
105 // prevent automatically exporting symbols.
106 UnexportedStaticLibs []string
107
Chris Parsons79d66a52020-06-05 17:26:16 -0400108 // Used for data dependencies adjacent to tests
109 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700110 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400111
Yo Chiang219968c2020-09-22 18:45:04 +0800112 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
113 SystemSharedLibs []string
114
Vinh Tran367d89d2023-04-28 11:21:25 -0400115 // Used by DepMutator to pass aidl_library modules to aidl compiler
116 AidlLibs []string
117
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500118 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800119 StaticUnwinderIfLegacy bool
120
Colin Cross5950f382016-12-13 12:50:57 -0800121 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700122
Colin Cross81413472016-04-11 14:37:39 -0700123 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700124
Dan Willemsenb40aab62016-04-20 14:21:14 -0700125 GeneratedSources []string
126 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900127 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700128
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700129 ReexportGeneratedHeaders []string
130
Colin Crossc465efd2021-06-11 18:00:04 -0700131 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700132
133 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700134 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900135
136 // List of libs that need to be excluded for APEX variant
137 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900138 // List of libs that need to be excluded for non-APEX variant
139 ExcludeLibsForNonApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700140}
141
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500142// PathDeps is a struct containing file paths to dependencies of a module.
143// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
144// It's used to construct flags for various build statements (such as for compiling and linking).
145// It is then passed to module decorator functions responsible for registering build statements
146// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800147type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700148 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900149 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700150 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900151 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700152 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700153 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700154
Colin Cross0de8a1e2020-09-18 14:15:30 -0700155 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700156 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700157
Colin Cross26c34ed2016-09-30 17:10:16 -0700158 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100159 Objs Objects
160 // Paths to .o files in dependencies that provide them. Note that these lists
161 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800162 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700163 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700164
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100165 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
166 // the libs from all whole_static_lib dependencies.
167 WholeStaticLibsFromPrebuilts android.Paths
168
Colin Cross26c34ed2016-09-30 17:10:16 -0700169 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700170 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900171 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700172
Inseob Kimd110f872019-12-06 13:15:38 +0900173 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000174 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900175 IncludeDirs android.Paths
176 SystemIncludeDirs android.Paths
177 ReexportedDirs android.Paths
178 ReexportedSystemDirs android.Paths
179 ReexportedFlags []string
180 ReexportedGeneratedHeaders android.Paths
181 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700182
Colin Cross26c34ed2016-09-30 17:10:16 -0700183 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700184 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700185
Dan Willemsena0790e32018-10-12 00:24:23 -0700186 // Path to the dynamic linker binary
187 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700188
189 // For Darwin builds, the path to the second architecture's output that should
190 // be combined with this architectures's output into a FAT MachO file.
191 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400192
193 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
194 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700195}
196
Colin Cross4af21ed2019-11-04 09:37:55 -0800197// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
198// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
199// command line so they can be overridden by the local module flags).
200type LocalOrGlobalFlags struct {
201 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700202 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800203 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700204 CFlags []string // Flags that apply to C and C++ source files
205 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
206 ConlyFlags []string // Flags that apply to C source files
207 CppFlags []string // Flags that apply to C++ source files
208 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700209 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800210}
211
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500212// Flags contains various types of command line flags (and settings) for use in building build
213// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800214type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500215 // Local flags (which individual modules are responsible for). These may override global flags.
216 Local LocalOrGlobalFlags
217 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700218 Global LocalOrGlobalFlags
219 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800220
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
Colin Cross3513fb12024-01-24 14:44:47 -0800529 isAfdoCompile(ctx ModuleContext) 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
Yu Liu67a28422024-03-05 00:36:31 +0000770func (d libraryDependencyTag) PropagateAconfigValidation() bool {
771 return d.static()
772}
773
774var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
775
Colin Crosse9fe2942020-11-10 18:12:15 -0800776// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700777// libraryDependencyTag. Each tag object is created globally and reused for multiple
778// dependencies (although since the object contains no references, assigning a tag to a
779// variable and modifying it will not modify the original). Users can compare the tag
780// returned by ctx.OtherModuleDependencyTag against the global original
781type dependencyTag struct {
782 blueprint.BaseDependencyTag
783 name string
784}
785
Colin Crosse9fe2942020-11-10 18:12:15 -0800786// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
787// libraryDependencyTag, but where the dependency needs to be installed when the parent is
788// installed.
789type installDependencyTag struct {
790 blueprint.BaseDependencyTag
791 android.InstallAlwaysNeededDependencyTag
792 name string
793}
794
Colin Crossc99deeb2016-04-11 15:06:20 -0700795var (
Colin Cross6e511a92020-07-27 21:26:48 -0700796 genSourceDepTag = dependencyTag{name: "gen source"}
797 genHeaderDepTag = dependencyTag{name: "gen header"}
798 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
799 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900800 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700801 reuseObjTag = dependencyTag{name: "reuse objects"}
802 staticVariantTag = dependencyTag{name: "static variant"}
803 vndkExtDepTag = dependencyTag{name: "vndk extends"}
804 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700805 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800806 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700807 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700808 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000809 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500810 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400811 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700812)
813
Roland Levillainf89cd092019-07-29 16:22:59 +0100814func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700815 ccLibDepTag, ok := depTag.(libraryDependencyTag)
816 return ok && ccLibDepTag.shared()
817}
818
819func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
820 ccLibDepTag, ok := depTag.(libraryDependencyTag)
821 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100822}
823
Zach Johnson3df4e632020-11-06 11:56:27 -0800824func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
825 ccLibDepTag, ok := depTag.(libraryDependencyTag)
826 return ok && ccLibDepTag.header()
827}
828
Roland Levillainf89cd092019-07-29 16:22:59 +0100829func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800830 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100831}
832
833func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700834 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100835 return ok && ccDepTag == testPerSrcDepTag
836}
837
Colin Crossca860ac2016-01-04 14:34:37 -0800838// Module contains the properties and members used by all C/C++ module types, and implements
839// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500840// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
841// interface.
842//
843// To define a C/C++ related module, construct a new Module object and point its delegates to
844// type-specific structs. These delegates will be invoked to register module-specific build
845// statements which may be unique to the module type. For example, module.compiler.compile() should
846// be defined so as to register build statements which are responsible for compiling the module.
847//
848// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
849// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
850// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
851// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800852type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700853 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700854
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700855 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700856 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700857
Colin Crossca860ac2016-01-04 14:34:37 -0800858 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000859 hod android.HostOrDeviceSupported
860 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000861 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700862
Paul Duffina0843f62019-12-13 19:50:38 +0000863 // Allowable SdkMemberTypes of this module type.
864 sdkMemberTypes []android.SdkMemberType
865
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500866 // decorator delegates, initialize before calling Init
867 // these may contain module-specific implementations, and effectively allow for custom
868 // type-specific logic. These members may reference different objects or the same object.
869 // Functions of these decorators will be invoked to initialize and register type-specific
870 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800871 generators []Generator
872 compiler compiler
873 linker linker
874 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500875
Spandan Dase12d2522023-09-12 21:42:31 +0000876 features []feature
877 stl *stl
878 sanitize *sanitize
879 coverage *coverage
880 fuzzer *fuzzer
881 sabi *sabi
882 vndkdep *vndkdep
883 lto *lto
884 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000885 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800886
Colin Cross31076b32020-10-23 17:22:06 -0700887 library libraryInterface
888
Colin Cross635c3b02016-05-18 15:37:25 -0700889 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800890
Colin Crossb98c8b02016-07-29 13:44:28 -0700891 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700892
893 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800894
895 // Flags used to compile this module
896 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700897
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800898 // Shared flags among build rules of this module
899 sharedFlags SharedFlags
900
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800901 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700902 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900903
904 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800905 // Kythe (source file indexer) paths for this compilation module
906 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700907 // Object .o file output paths for this compilation module
908 objFiles android.Paths
909 // Tidy .tidy file output paths for this compilation module
910 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900911
912 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700913 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700914
915 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800916
917 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800918 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700919}
920
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200921func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400922 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
923 if b, ok := c.compiler.(*baseCompiler); ok {
924 hasAidl = b.hasSrcExt(".aidl")
925 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
926 hasProto = b.hasSrcExt(".proto")
927 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
928 hasSysprop = b.hasSrcExt(".sysprop")
929 hasWinMsg = b.hasSrcExt(".mc")
930 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
931 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200932 c.AndroidModuleBase().AddJSONData(d)
933 (*d)["Cc"] = map[string]interface{}{
934 "SdkVersion": c.SdkVersion(),
935 "MinSdkVersion": c.MinSdkVersion(),
936 "VndkVersion": c.VndkVersion(),
937 "ProductSpecific": c.ProductSpecific(),
938 "SocSpecific": c.SocSpecific(),
939 "DeviceSpecific": c.DeviceSpecific(),
940 "InProduct": c.InProduct(),
941 "InVendor": c.InVendor(),
942 "InRamdisk": c.InRamdisk(),
943 "InVendorRamdisk": c.InVendorRamdisk(),
944 "InRecovery": c.InRecovery(),
945 "VendorAvailable": c.VendorAvailable(),
946 "ProductAvailable": c.ProductAvailable(),
947 "RamdiskAvailable": c.RamdiskAvailable(),
948 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
949 "RecoveryAvailable": c.RecoveryAvailable(),
950 "OdmAvailable": c.OdmAvailable(),
951 "InstallInData": c.InstallInData(),
952 "InstallInRamdisk": c.InstallInRamdisk(),
953 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
954 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
955 "InstallInRecovery": c.InstallInRecovery(),
956 "InstallInRoot": c.InstallInRoot(),
957 "IsVndk": c.IsVndk(),
958 "IsVndkExt": c.IsVndkExt(),
959 "IsVndkPrivate": c.IsVndkPrivate(),
960 "IsVndkSp": c.IsVndkSp(),
961 "IsLlndk": c.IsLlndk(),
962 "IsLlndkPublic": c.IsLlndkPublic(),
963 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
964 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
965 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
966 "ApexSdkVersion": c.apexSdkVersion,
967 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400968 "AidlSrcs": hasAidl,
969 "LexSrcs": hasLex,
970 "ProtoSrcs": hasProto,
971 "RenderscriptSrcs": hasRenderscript,
972 "SyspropSrcs": hasSysprop,
973 "WinMsgSrcs": hasWinMsg,
974 "YaccSrsc": hasYacc,
975 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200976 }
977}
978
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500979func (c *Module) SetPreventInstall() {
980 c.Properties.PreventInstall = true
981}
982
983func (c *Module) SetHideFromMake() {
984 c.Properties.HideFromMake = true
985}
986
Ivan Lozanod7586b62021-04-01 09:49:36 -0400987func (c *Module) HiddenFromMake() bool {
988 return c.Properties.HideFromMake
989}
990
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800991func (c *Module) RequiredModuleNames() []string {
992 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
993 if c.ImageVariation().Variation == android.CoreVariation {
994 required = append(required, c.Properties.Target.Platform.Required...)
995 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
996 } else if c.InRecovery() {
997 required = append(required, c.Properties.Target.Recovery.Required...)
998 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
999 }
1000 return android.FirstUniqueStrings(required)
1001}
1002
Ivan Lozano52767be2019-10-18 14:49:46 -07001003func (c *Module) Toc() android.OptionalPath {
1004 if c.linker != nil {
1005 if library, ok := c.linker.(libraryInterface); ok {
1006 return library.toc()
1007 }
1008 }
1009 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1010}
1011
1012func (c *Module) ApiLevel() string {
1013 if c.linker != nil {
1014 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001015 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001016 }
1017 }
1018 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1019}
1020
1021func (c *Module) Static() bool {
1022 if c.linker != nil {
1023 if library, ok := c.linker.(libraryInterface); ok {
1024 return library.static()
1025 }
1026 }
1027 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1028}
1029
1030func (c *Module) Shared() bool {
1031 if c.linker != nil {
1032 if library, ok := c.linker.(libraryInterface); ok {
1033 return library.shared()
1034 }
1035 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001036
Ivan Lozano52767be2019-10-18 14:49:46 -07001037 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1038}
1039
1040func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001041 if c.stl != nil {
1042 return c.stl.Properties.SelectedStl
1043 }
1044 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001045}
1046
Ivan Lozano52767be2019-10-18 14:49:46 -07001047func (c *Module) NdkPrebuiltStl() bool {
1048 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1049 return true
1050 }
1051 return false
1052}
1053
1054func (c *Module) StubDecorator() bool {
1055 if _, ok := c.linker.(*stubDecorator); ok {
1056 return true
1057 }
1058 return false
1059}
1060
1061func (c *Module) SdkVersion() string {
1062 return String(c.Properties.Sdk_version)
1063}
1064
Artur Satayev480e25b2020-04-27 18:53:18 +01001065func (c *Module) MinSdkVersion() string {
1066 return String(c.Properties.Min_sdk_version)
1067}
1068
Jiyong Park5df7bd32021-08-25 16:18:46 +09001069func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001070 if linker, ok := c.linker.(*objectLinker); ok {
1071 return linker.isCrt()
1072 }
1073 return false
1074}
1075
Jiyong Park5df7bd32021-08-25 16:18:46 +09001076func (c *Module) SplitPerApiLevel() bool {
1077 return c.canUseSdk() && c.isCrt()
1078}
1079
Colin Crossc511bc52020-04-07 16:50:32 +00001080func (c *Module) AlwaysSdk() bool {
1081 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1082}
1083
Ivan Lozano183a3212019-10-18 14:18:45 -07001084func (c *Module) CcLibrary() bool {
1085 if c.linker != nil {
1086 if _, ok := c.linker.(*libraryDecorator); ok {
1087 return true
1088 }
Colin Crossd48fe732020-09-23 20:37:24 -07001089 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1090 return true
1091 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001092 }
1093 return false
1094}
1095
1096func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001097 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001098 return true
1099 }
1100 return false
1101}
1102
Spandan Dase12d2522023-09-12 21:42:31 +00001103func (c *Module) IsNdkPrebuiltStl() bool {
1104 if c.linker == nil {
1105 return false
1106 }
1107 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1108 return true
1109 }
1110 return false
1111}
1112
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001113func (c *Module) RlibStd() bool {
1114 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1115}
1116
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001117func (c *Module) RustLibraryInterface() bool {
1118 return false
1119}
1120
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001121func (c *Module) IsFuzzModule() bool {
1122 if _, ok := c.compiler.(*fuzzBinary); ok {
1123 return true
1124 }
1125 return false
1126}
1127
1128func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1129 return c.FuzzModule
1130}
1131
1132func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1133 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1134 return fuzzer.fuzzPackagedModule
1135 }
1136 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1137}
1138
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001139func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001140 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1141 return fuzzer.sharedLibraries
1142 }
1143 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1144}
1145
Ivan Lozano2b262972019-11-21 12:30:50 -08001146func (c *Module) NonCcVariants() bool {
1147 return false
1148}
1149
Ivan Lozano183a3212019-10-18 14:18:45 -07001150func (c *Module) SetStatic() {
1151 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001152 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001153 library.setStatic()
1154 return
1155 }
1156 }
1157 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1158}
1159
1160func (c *Module) SetShared() {
1161 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001162 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001163 library.setShared()
1164 return
1165 }
1166 }
1167 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1168}
1169
1170func (c *Module) BuildStaticVariant() bool {
1171 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001172 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001173 return library.buildStatic()
1174 }
1175 }
1176 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1177}
1178
1179func (c *Module) BuildSharedVariant() bool {
1180 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001181 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001182 return library.buildShared()
1183 }
1184 }
1185 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1186}
1187
1188func (c *Module) Module() android.Module {
1189 return c
1190}
1191
Jiyong Parkc20eee32018-09-05 22:36:17 +09001192func (c *Module) OutputFile() android.OptionalPath {
1193 return c.outputFile
1194}
1195
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001196func (c *Module) CoverageFiles() android.Paths {
1197 if c.linker != nil {
1198 if library, ok := c.linker.(libraryInterface); ok {
1199 return library.objs().coverageFiles
1200 }
1201 }
1202 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1203}
1204
Ivan Lozano183a3212019-10-18 14:18:45 -07001205var _ LinkableInterface = (*Module)(nil)
1206
Jiyong Park719b4462019-01-13 00:39:51 +09001207func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001208 if c.linker != nil {
1209 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001210 }
1211 return nil
1212}
1213
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001214func (c *Module) CoverageOutputFile() android.OptionalPath {
1215 if c.linker != nil {
1216 return c.linker.coverageOutputFilePath()
1217 }
1218 return android.OptionalPath{}
1219}
1220
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001221func (c *Module) RelativeInstallPath() string {
1222 if c.installer != nil {
1223 return c.installer.relativeInstallPath()
1224 }
1225 return ""
1226}
1227
Jooyung Han344d5432019-08-23 11:17:39 +09001228func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001229 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001230}
1231
Colin Cross36242852017-06-23 15:06:31 -07001232func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001233 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001234 for _, generator := range c.generators {
1235 c.AddProperties(generator.GeneratorProps()...)
1236 }
Colin Crossca860ac2016-01-04 14:34:37 -08001237 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001238 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001239 }
1240 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001241 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001242 }
1243 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001244 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001245 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001246 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001247 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001248 }
Colin Cross16b23492016-01-06 14:41:07 -08001249 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001250 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001251 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001252 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001253 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001254 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001255 if c.fuzzer != nil {
1256 c.AddProperties(c.fuzzer.props()...)
1257 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001258 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001259 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001260 }
Justin Yun8effde42017-06-23 19:24:43 +09001261 if c.vndkdep != nil {
1262 c.AddProperties(c.vndkdep.props()...)
1263 }
Stephen Craneba090d12017-05-09 15:44:35 -07001264 if c.lto != nil {
1265 c.AddProperties(c.lto.props()...)
1266 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001267 if c.afdo != nil {
1268 c.AddProperties(c.afdo.props()...)
1269 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001270 if c.orderfile != nil {
1271 c.AddProperties(c.orderfile.props()...)
1272 }
Colin Crossca860ac2016-01-04 14:34:37 -08001273 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001274 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001275 }
Colin Crossc472d572015-03-17 15:06:21 -07001276
Colin Cross36242852017-06-23 15:06:31 -07001277 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001278 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001279 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001280
Colin Cross36242852017-06-23 15:06:31 -07001281 return c
Colin Crossc472d572015-03-17 15:06:21 -07001282}
1283
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001284// UseVndk() returns true if this module is built against VNDK.
1285// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001286func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001287 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001288}
1289
Colin Crossc511bc52020-04-07 16:50:32 +00001290func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001291 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001292 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001293}
1294
1295func (c *Module) UseSdk() bool {
1296 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001297 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001298 }
1299 return false
1300}
1301
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001302func (c *Module) isCoverageVariant() bool {
1303 return c.coverage.Properties.IsCoverageVariant
1304}
1305
Colin Cross95f1ca02020-10-29 20:47:22 -07001306func (c *Module) IsNdk(config android.Config) bool {
1307 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001308}
1309
Colin Cross127bb8b2020-12-16 16:46:01 -08001310func (c *Module) IsLlndk() bool {
1311 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001312}
1313
Colin Cross127bb8b2020-12-16 16:46:01 -08001314func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001315 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001316}
1317
Colin Cross1f3f1302021-04-26 18:37:44 -07001318func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001319 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001320 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001321}
1322
Colin Cross5271fea2021-04-27 13:06:04 -07001323func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1324 lib := moduleLibraryInterface(m)
1325 return lib != nil && (lib.hasVendorPublicLibrary())
1326}
1327
1328// IsVendorPublicLibrary returns true for vendor public libraries.
1329func (c *Module) IsVendorPublicLibrary() bool {
1330 return c.VendorProperties.IsVendorPublicLibrary
1331}
1332
Ivan Lozanof1868af2022-04-12 13:08:36 -04001333func (c *Module) IsVndkPrebuiltLibrary() bool {
1334 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1335 return true
1336 }
1337 return false
1338}
1339
1340func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1341 return c.Properties.SdkAndPlatformVariantVisibleToMake
1342}
1343
Ivan Lozanod7586b62021-04-01 09:49:36 -04001344func (c *Module) HasLlndkStubs() bool {
1345 lib := moduleLibraryInterface(c)
1346 return lib != nil && lib.hasLLNDKStubs()
1347}
1348
1349func (c *Module) StubsVersion() string {
1350 if lib, ok := c.linker.(versionedInterface); ok {
1351 return lib.stubsVersion()
1352 }
1353 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1354}
1355
Colin Cross127bb8b2020-12-16 16:46:01 -08001356// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1357// and does not set llndk.vendor_available: false.
1358func (c *Module) isImplementationForLLNDKPublic() bool {
1359 library, _ := c.library.(*libraryDecorator)
1360 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001361 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001362}
1363
Justin Yunfd9e8042020-12-23 18:23:14 +09001364// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001365func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001366 // Check if VNDK-core-private or VNDK-SP-private
1367 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001368 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001369 }
1370
1371 // Check if LLNDK-private
1372 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001373 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001374 }
1375
1376 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001377}
1378
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001379// IsVndk() returns true if this module has a vndk variant.
1380// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1381// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001382func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001383 if vndkdep := c.vndkdep; vndkdep != nil {
1384 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001385 }
1386 return false
1387}
1388
Colin Cross3513fb12024-01-24 14:44:47 -08001389func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001390 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001391 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001392 }
1393 return false
1394}
1395
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001396func (c *Module) isOrderfileCompile() bool {
1397 if orderfile := c.orderfile; orderfile != nil {
1398 return orderfile.Properties.OrderfileLoad
1399 }
1400 return false
1401}
1402
Yi Kongc702ebd2022-08-19 16:02:45 +08001403func (c *Module) isCfi() bool {
1404 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001405 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001406 }
1407 return false
1408}
1409
Yi Konged79fa32023-06-04 17:15:42 +09001410func (c *Module) isFuzzer() bool {
1411 if sanitize := c.sanitize; sanitize != nil {
1412 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1413 }
1414 return false
1415}
1416
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001417func (c *Module) isNDKStubLibrary() bool {
1418 if _, ok := c.compiler.(*stubDecorator); ok {
1419 return true
1420 }
1421 return false
1422}
1423
Ivan Lozanod7586b62021-04-01 09:49:36 -04001424func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001425 if vndkdep := c.vndkdep; vndkdep != nil {
1426 return vndkdep.isVndkSp()
1427 }
1428 return false
1429}
1430
Ivan Lozanof9e21722020-12-02 09:00:51 -05001431func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001432 if vndkdep := c.vndkdep; vndkdep != nil {
1433 return vndkdep.isVndkExt()
1434 }
1435 return false
1436}
1437
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001438func (c *Module) SubName() string {
1439 return c.Properties.SubName
1440}
1441
Ivan Lozano52767be2019-10-18 14:49:46 -07001442func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001443 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001444}
1445
Logan Chienf3511742017-10-31 18:04:35 +08001446func (c *Module) getVndkExtendsModuleName() string {
1447 if vndkdep := c.vndkdep; vndkdep != nil {
1448 return vndkdep.getVndkExtendsModuleName()
1449 }
1450 return ""
1451}
1452
Jiyong Park25fc6a92018-11-18 18:02:45 +09001453func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001454 if lib := c.library; lib != nil {
1455 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001456 }
1457 return false
1458}
1459
1460func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001461 if lib := c.library; lib != nil {
1462 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001463 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001464 return false
1465}
1466
Alan Stokes73feba32022-11-14 12:21:24 +00001467func (c *Module) IsStubsImplementationRequired() bool {
1468 if lib := c.library; lib != nil {
1469 return lib.isStubsImplementationRequired()
1470 }
1471 return false
1472}
1473
Colin Cross0477b422020-10-13 18:43:54 -07001474// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1475// the implementation. If it is an implementation library it returns its own name.
1476func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1477 name := ctx.OtherModuleName(c)
1478 if versioned, ok := c.linker.(versionedInterface); ok {
1479 name = versioned.implementationModuleName(name)
1480 }
1481 return name
1482}
1483
Martin Stjernholm2856c662020-12-02 15:03:42 +00001484// Similar to ImplementationModuleName, but uses the Make variant of the module
1485// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1486// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1487// under the premise that the prebuilt module overrides its source counterpart
1488// if it is exposed to Make).
1489func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1490 name := c.BaseModuleName()
1491 if versioned, ok := c.linker.(versionedInterface); ok {
1492 name = versioned.implementationModuleName(name)
1493 }
1494 return name
1495}
1496
Jiyong Park7d55b612021-06-11 17:22:09 +09001497func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001498 return Bool(c.Properties.Bootstrap)
1499}
1500
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001501func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001502 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1503 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1504 return false
1505 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001506 return c.linker != nil && c.linker.nativeCoverage()
1507}
1508
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001509func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001510 if p, ok := c.linker.(SnapshotInterface); ok {
1511 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001512 }
1513 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001514}
1515
Bill Peckham945441c2020-08-31 16:07:58 -07001516func (c *Module) ExcludeFromVendorSnapshot() bool {
1517 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1518}
1519
Jose Galmesf7294582020-11-13 12:07:36 -08001520func (c *Module) ExcludeFromRecoverySnapshot() bool {
1521 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1522}
1523
Jiyong Parkf1194352019-02-25 11:05:47 +09001524func isBionic(name string) bool {
1525 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001526 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001527 return true
1528 }
1529 return false
1530}
1531
Martin Stjernholm279de572019-09-10 23:18:20 +01001532func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001533 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001534 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001535 }
1536 return isBionic(name)
1537}
1538
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001539func (c *Module) XrefCcFiles() android.Paths {
1540 return c.kytheFiles
1541}
1542
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001543func (c *Module) isCfiAssemblySupportEnabled() bool {
1544 return c.sanitize != nil &&
1545 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1546}
1547
Inseob Kim800d1142021-06-14 12:03:51 +09001548func (c *Module) InstallInRoot() bool {
1549 return c.installer != nil && c.installer.installInRoot()
1550}
1551
Colin Crossca860ac2016-01-04 14:34:37 -08001552type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001553 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001554 moduleContextImpl
1555}
1556
Colin Cross37047f12016-12-13 17:06:13 -08001557type depsContext struct {
1558 android.BottomUpMutatorContext
1559 moduleContextImpl
1560}
1561
Colin Crossca860ac2016-01-04 14:34:37 -08001562type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001563 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001564 moduleContextImpl
1565}
1566
1567type moduleContextImpl struct {
1568 mod *Module
1569 ctx BaseModuleContext
1570}
1571
Colin Crossb98c8b02016-07-29 13:44:28 -07001572func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001573 return ctx.mod.toolchain(ctx.ctx)
1574}
1575
1576func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001577 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001578}
1579
1580func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001581 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001582}
1583
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001584func (ctx *moduleContextImpl) testBinary() bool {
1585 return ctx.mod.testBinary()
1586}
1587
Yi Kong56fc1b62022-09-06 16:24:00 +08001588func (ctx *moduleContextImpl) testLibrary() bool {
1589 return ctx.mod.testLibrary()
1590}
1591
Jiyong Park1d1119f2019-07-29 21:27:18 +09001592func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001593 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001594}
1595
Inseob Kim7f283f42020-06-01 21:53:49 +09001596func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001597 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001598}
1599
Inseob Kim1042d292020-06-01 23:23:05 +09001600func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001601 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001602}
1603
Jooyung Hanccce2f22020-03-07 03:45:53 +09001604func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001605 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001606}
1607
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001608func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001609 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001610}
1611
1612func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001613 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001614 config := ctx.ctx.Config()
1615 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001616 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001617 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001618 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001619 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001620 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001621 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001622 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001623 }
1624 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001625}
1626
Jiyong Parkb35a8192020-08-10 15:59:36 +09001627func (ctx *moduleContextImpl) minSdkVersion() string {
1628 ver := ctx.mod.MinSdkVersion()
1629 if ver == "apex_inherit" && !ctx.isForPlatform() {
1630 ver = ctx.apexSdkVersion().String()
1631 }
1632 if ver == "apex_inherit" || ver == "" {
1633 ver = ctx.sdkVersion()
1634 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001635
1636 if ctx.ctx.Device() {
1637 config := ctx.ctx.Config()
1638 if config.IsVndkDeprecated() && ctx.inVendor() {
1639 // If building for vendor with final API, then use the latest _stable_ API as "current".
1640 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1641 ver = config.PlatformSdkVersion().String()
1642 }
1643 }
1644 }
1645
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001646 // For crt objects, the meaning of min_sdk_version is very different from other types of
1647 // module. For them, min_sdk_version defines the oldest version that the build system will
1648 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1649 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1650 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001651 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1652 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1653 // support such an old version. The version is set to the later version in case when the
1654 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1655 // it's for an APEX.
1656 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1657 if ctx.isForPlatform() {
1658 ver = strconv.Itoa(android.FutureApiLevelInt)
1659 } else { // for apex
1660 ver = ctx.apexSdkVersion().String()
1661 if ver == "" { // in case when min_sdk_version was not set by the APEX
1662 ver = ctx.sdkVersion()
1663 }
1664 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001665 }
1666
Jiyong Parkb35a8192020-08-10 15:59:36 +09001667 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1668 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1669 minSdkVersionInt, err2 := strconv.Atoi(ver)
1670 if err == nil && err2 == nil {
1671 if sdkVersionInt < minSdkVersionInt {
1672 return strconv.Itoa(sdkVersionInt)
1673 }
1674 }
1675 return ver
1676}
1677
1678func (ctx *moduleContextImpl) isSdkVariant() bool {
1679 return ctx.mod.IsSdkVariant()
1680}
1681
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001682func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001683 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001684}
Justin Yun8effde42017-06-23 19:24:43 +09001685
Kiyoung Kimaa394802024-01-08 12:55:45 +09001686func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1687 return ctx.mod.InVendorOrProduct()
1688}
1689
Colin Cross95f1ca02020-10-29 20:47:22 -07001690func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1691 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001692}
1693
Colin Cross127bb8b2020-12-16 16:46:01 -08001694func (ctx *moduleContextImpl) IsLlndk() bool {
1695 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001696}
1697
Colin Cross127bb8b2020-12-16 16:46:01 -08001698func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1699 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001700}
1701
Colin Cross127bb8b2020-12-16 16:46:01 -08001702func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1703 return ctx.mod.isImplementationForLLNDKPublic()
1704}
1705
1706func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1707 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001708}
1709
Logan Chienf3511742017-10-31 18:04:35 +08001710func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001711 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001712}
1713
Colin Cross3513fb12024-01-24 14:44:47 -08001714func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1715 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001716}
1717
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001718func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1719 return ctx.mod.isOrderfileCompile()
1720}
1721
Yi Kongc702ebd2022-08-19 16:02:45 +08001722func (ctx *moduleContextImpl) isCfi() bool {
1723 return ctx.mod.isCfi()
1724}
1725
Yi Konged79fa32023-06-04 17:15:42 +09001726func (ctx *moduleContextImpl) isFuzzer() bool {
1727 return ctx.mod.isFuzzer()
1728}
1729
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001730func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1731 return ctx.mod.isNDKStubLibrary()
1732}
1733
Justin Yun8effde42017-06-23 19:24:43 +09001734func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001735 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001736}
1737
Ivan Lozanof9e21722020-12-02 09:00:51 -05001738func (ctx *moduleContextImpl) IsVndkExt() bool {
1739 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001740}
1741
Colin Cross5271fea2021-04-27 13:06:04 -07001742func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1743 return ctx.mod.IsVendorPublicLibrary()
1744}
1745
Vic Yangefd249e2018-11-12 20:19:56 -08001746func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001747 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001748}
1749
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001750func (ctx *moduleContextImpl) selectedStl() string {
1751 if stl := ctx.mod.stl; stl != nil {
1752 return stl.Properties.SelectedStl
1753 }
1754 return ""
1755}
1756
Ivan Lozanobd721262018-11-27 14:33:03 -08001757func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1758 return ctx.mod.linker.useClangLld(actx)
1759}
1760
Colin Crossce75d2c2016-10-06 16:12:58 -07001761func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001762 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001763}
1764
Logan Chienf3511742017-10-31 18:04:35 +08001765func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1766 return ctx.mod.getVndkExtendsModuleName()
1767}
1768
Logan Chiene274fc92019-12-03 11:18:32 -08001769func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001770 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1771 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001772}
1773
Colin Crosse07f2312020-08-13 11:24:56 -07001774func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001775 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1776 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001777}
1778
Dan Albertc8060532020-07-22 22:32:17 -07001779func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001780 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001781}
1782
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001783func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001784 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001785}
1786
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001787func (ctx *moduleContextImpl) nativeCoverage() bool {
1788 return ctx.mod.nativeCoverage()
1789}
1790
Colin Cross56a83212020-09-15 18:30:11 -07001791func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1792 return ctx.mod.DirectlyInAnyApex()
1793}
1794
Colin Cross95b07f22020-12-16 11:06:50 -08001795func (ctx *moduleContextImpl) isPreventInstall() bool {
1796 return ctx.mod.Properties.PreventInstall
1797}
1798
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001799func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1800 shared := &ctx.mod.sharedFlags
1801 if shared.flagsMap == nil {
1802 shared.numSharedFlags = 0
1803 shared.flagsMap = make(map[string]string)
1804 }
1805 return shared
1806}
1807
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001808func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1809 return ctx.mod.isCfiAssemblySupportEnabled()
1810}
1811
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001812func (ctx *moduleContextImpl) notInPlatform() bool {
1813 return ctx.mod.NotInPlatform()
1814}
1815
Colin Cross635c3b02016-05-18 15:37:25 -07001816func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001817 return &Module{
1818 hod: hod,
1819 multilib: multilib,
1820 }
1821}
1822
Colin Cross635c3b02016-05-18 15:37:25 -07001823func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001824 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001825 module.features = []feature{
1826 &tidyFeature{},
1827 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001828 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001829 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001830 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001831 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001832 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001833 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001834 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001835 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001836 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001837 return module
1838}
1839
Colin Crossce75d2c2016-10-06 16:12:58 -07001840func (c *Module) Prebuilt() *android.Prebuilt {
1841 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1842 return p.prebuilt()
1843 }
1844 return nil
1845}
1846
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001847func (c *Module) IsPrebuilt() bool {
1848 return c.Prebuilt() != nil
1849}
1850
Colin Crossce75d2c2016-10-06 16:12:58 -07001851func (c *Module) Name() string {
1852 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001853 if p, ok := c.linker.(interface {
1854 Name(string) string
1855 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001856 name = p.Name(name)
1857 }
1858 return name
1859}
1860
Alex Light3d673592019-01-18 14:37:31 -08001861func (c *Module) Symlinks() []string {
1862 if p, ok := c.installer.(interface {
1863 symlinkList() []string
1864 }); ok {
1865 return p.symlinkList()
1866 }
1867 return nil
1868}
1869
Roland Levillainf89cd092019-07-29 16:22:59 +01001870func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1871 test, ok := c.linker.(testPerSrc)
1872 return ok && test.isAllTestsVariation()
1873}
1874
Chris Parsons216e10a2020-07-09 17:12:52 -04001875func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001876 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001877 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001878 }); ok {
1879 return p.dataPaths()
1880 }
1881 return nil
1882}
1883
Ivan Lozanof1868af2022-04-12 13:08:36 -04001884func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001885 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1886 // "current", it will append the VNDK version to the name suffix.
1887 var vndkVersion string
1888 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001889 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001890 if c.ProductSpecific() {
1891 // If the module is product specific with 'product_specific: true',
1892 // do not add a name suffix because it is a base module.
1893 return ""
1894 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001895 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001896 } else {
1897 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001898 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001899 }
1900 if vndkVersion == "current" {
1901 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1902 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001903 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001904 // add version suffix only if the module is using different vndk version than the
1905 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001906 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001907 }
1908 return nameSuffix
1909}
1910
Ivan Lozanof1868af2022-04-12 13:08:36 -04001911func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1912 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001913
1914 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001915 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001916 }
1917
Colin Cross127bb8b2020-12-16 16:46:01 -08001918 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001919 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001920 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1921 // added for product variant only when we have vendor and product variants with core
1922 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001923 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001924 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001925 subName += vendorPublicLibrarySuffix
1926 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001927 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1928 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001929 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001930 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001931 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001932 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001933 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001934 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001935 subName += RecoverySuffix
1936 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1937 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001938 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001939 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001940 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001941 } else if c.IsStubs() && c.IsSdkVariant() {
1942 // Public API surface (NDK)
1943 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1944 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001945 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001946
1947 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001948}
1949
Sam Delmerico75dbca22023-04-20 13:13:25 +00001950func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1951 ctx := &moduleContext{
1952 ModuleContext: actx,
1953 moduleContextImpl: moduleContextImpl{
1954 mod: c,
1955 },
1956 }
1957 ctx.ctx = ctx
1958 return ctx
1959}
1960
Spandan Das20fce2d2023-04-12 17:21:39 +00001961// TODO (b/277651159): Remove this allowlist
1962var (
1963 skipStubLibraryMultipleApexViolation = map[string]bool{
1964 "libclang_rt.asan": true,
1965 "libclang_rt.hwasan": true,
1966 // runtime apex
1967 "libc": true,
1968 "libc_hwasan": true,
1969 "libdl_android": true,
1970 "libm": true,
1971 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001972 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001973 // art apex
1974 "libandroidio": true,
1975 "libdexfile": true,
1976 "libnativebridge": true,
1977 "libnativehelper": true,
1978 "libnativeloader": true,
1979 "libsigchain": true,
1980 }
1981)
1982
1983// Returns true if a stub library could be installed in multiple apexes
1984func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1985 // If this is not an apex variant, no check necessary
1986 if !c.InAnyApex() {
1987 return false
1988 }
1989 // If this is not a stub library, no check necessary
1990 if !c.HasStubsVariants() {
1991 return false
1992 }
1993 // Skip the allowlist
1994 // Use BaseModuleName so that this matches prebuilts.
1995 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1996 return false
1997 }
1998
1999 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
2000 // Stub libraries should not have more than one apex_available
2001 if len(aaWithoutTestApexes) > 1 {
2002 return true
2003 }
2004 // Stub libraries should not use the wildcard
2005 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2006 return true
2007 }
2008 // Default: no violation
2009 return false
2010}
2011
LaMont Jonesafe7baf2024-01-09 22:47:39 +00002012func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2013 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
2014}
2015
Chris Parsons8d6e4332021-02-22 16:13:50 -05002016func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05002017 // Handle the case of a test module split by `test_per_src` mutator.
2018 //
2019 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2020 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2021 // module and return early, as this module does not produce an output file per se.
2022 if c.IsTestPerSrcAllTestsVariation() {
2023 c.outputFile = android.OptionalPath{}
2024 return
2025 }
2026
Ivan Lozanof1868af2022-04-12 13:08:36 -04002027 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002028 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002029 if !apexInfo.IsForPlatform() {
2030 c.hideApexVariantFromMake = true
2031 }
2032
Chris Parsonseefc9e62021-04-02 17:36:47 -04002033 c.makeLinkType = GetMakeLinkType(actx, c)
2034
Sam Delmerico75dbca22023-04-20 13:13:25 +00002035 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002036
Colin Crossf18e1102017-11-16 14:33:08 -08002037 deps := c.depsToPaths(ctx)
2038 if ctx.Failed() {
2039 return
2040 }
2041
Joe Onorato37f900c2023-07-18 16:58:16 -07002042 for _, generator := range c.generators {
2043 gen := generator.GeneratorSources(ctx)
2044 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2045 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2046 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2047 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2048 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2049 if len(deps.Objs.objFiles) == 0 {
2050 // If we are reusuing object files (which happens when we're a shared library and we're
2051 // reusing our static variant's object files), then skip adding the actual source files,
2052 // because we already have the object for it.
2053 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2054 }
2055 }
2056
2057 if ctx.Failed() {
2058 return
2059 }
2060
Spandan Das20fce2d2023-04-12 17:21:39 +00002061 if c.stubLibraryMultipleApexViolation(actx) {
2062 actx.PropertyErrorf("apex_available",
2063 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2064 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002065 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2066 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002067 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2068 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002069 }
2070
Colin Crossca860ac2016-01-04 14:34:37 -08002071 flags := Flags{
2072 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002073 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002074 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002075 for _, generator := range c.generators {
2076 flags = generator.GeneratorFlags(ctx, flags, deps)
2077 }
Colin Crossca860ac2016-01-04 14:34:37 -08002078 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002079 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002080 }
2081 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002082 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002083 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002084 if c.stl != nil {
2085 flags = c.stl.flags(ctx, flags)
2086 }
Colin Cross16b23492016-01-06 14:41:07 -08002087 if c.sanitize != nil {
2088 flags = c.sanitize.flags(ctx, flags)
2089 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002090 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002091 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002092 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002093 if c.fuzzer != nil {
2094 flags = c.fuzzer.flags(ctx, flags)
2095 }
Stephen Craneba090d12017-05-09 15:44:35 -07002096 if c.lto != nil {
2097 flags = c.lto.flags(ctx, flags)
2098 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002099 if c.afdo != nil {
2100 flags = c.afdo.flags(ctx, flags)
2101 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002102 if c.orderfile != nil {
2103 flags = c.orderfile.flags(ctx, flags)
2104 }
Colin Crossca860ac2016-01-04 14:34:37 -08002105 for _, feature := range c.features {
2106 flags = feature.flags(ctx, flags)
2107 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002108 if ctx.Failed() {
2109 return
2110 }
2111
Colin Cross4af21ed2019-11-04 09:37:55 -08002112 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2113 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2114 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002115
Colin Cross4af21ed2019-11-04 09:37:55 -08002116 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002117
2118 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002119 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002120 }
2121 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002122 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002123 }
2124
Colin Cross3e5e7782022-06-17 22:17:05 +00002125 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2126
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002127 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002128 // We need access to all the flags seen by a source file.
2129 if c.sabi != nil {
2130 flags = c.sabi.flags(ctx, flags)
2131 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002132
Colin Cross4af21ed2019-11-04 09:37:55 -08002133 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002134
Joe Onorato37f900c2023-07-18 16:58:16 -07002135 for _, generator := range c.generators {
2136 generator.GeneratorBuildActions(ctx, flags, deps)
2137 }
2138
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002139 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002140 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002141 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002142 if ctx.Failed() {
2143 return
2144 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002145 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002146 c.objFiles = objs.objFiles
2147 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002148 }
2149
Colin Crossca860ac2016-01-04 14:34:37 -08002150 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002151 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002152 if ctx.Failed() {
2153 return
2154 }
Colin Cross635c3b02016-05-18 15:37:25 -07002155 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002156
Chris Parsons94a0bba2021-06-04 15:03:47 -04002157 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002158
Jose Galmes6f843bc2020-12-11 13:36:29 -08002159 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2160 // RECOVERY_SNAPSHOT_VERSION is current.
2161 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002162 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002163 i.collectHeadersForSnapshot(ctx)
2164 }
2165 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002166 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002167 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002168 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002169 }
Colin Cross40213022023-12-13 15:19:49 -08002170 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002171
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002172 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002173
Chris Parsons94a0bba2021-06-04 15:03:47 -04002174 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002175
2176 if c.linker != nil {
2177 moduleInfoJSON := ctx.ModuleInfoJSON()
2178 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2179 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2180 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2181 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2182 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2183
2184 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2185 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2186 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2187 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2188
2189 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2190 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2191 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2192 moduleInfoJSON.SubName += ".cfi"
2193 }
2194 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2195 moduleInfoJSON.SubName += ".hwasan"
2196 }
2197 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2198 moduleInfoJSON.SubName += ".scs"
2199 }
2200 }
2201 moduleInfoJSON.SubName += c.Properties.SubName
2202
2203 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2204 moduleInfoJSON.Uninstallable = true
2205 }
2206
2207 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002208}
2209
2210func (c *Module) maybeUnhideFromMake() {
2211 // If a lib is directly included in any of the APEXes or is not available to the
2212 // platform (which is often the case when the stub is provided as a prebuilt),
2213 // unhide the stubs variant having the latest version gets visible to make. In
2214 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2215 // force anything in the make world to link against the stubs library. (unless it
2216 // is explicitly referenced via .bootstrap suffix or the module is marked with
2217 // 'bootstrap: true').
2218 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002219 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002220 c.IsStubs() && !c.InVendorRamdisk() {
2221 c.Properties.HideFromMake = false // unhide
2222 // Note: this is still non-installable
2223 }
2224}
2225
Colin Cross8ff10582023-12-07 13:10:56 -08002226// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2227// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002228func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002229 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002230 // If the module has been specifically configure to not be installed then
2231 // hide from make as otherwise it will break when running inside make
2232 // as the output path to install will not be specified. Not all uninstallable
2233 // modules can be hidden from make as some are needed for resolving make side
2234 // dependencies.
2235 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002236 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002237 c.SkipInstall()
2238 }
2239
2240 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2241 // to allow using the outputs in a genrule.
2242 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002243 c.installer.install(ctx, c.outputFile.Path())
2244 if ctx.Failed() {
2245 return
Colin Crossca860ac2016-01-04 14:34:37 -08002246 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002247 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002248}
2249
Colin Cross0ea8ba82019-06-06 14:33:29 -07002250func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002251 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002252 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002253 }
Colin Crossca860ac2016-01-04 14:34:37 -08002254 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002255}
2256
Colin Crossca860ac2016-01-04 14:34:37 -08002257func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002258 for _, generator := range c.generators {
2259 generator.GeneratorInit(ctx)
2260 }
Colin Crossca860ac2016-01-04 14:34:37 -08002261 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002262 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002263 }
Colin Crossca860ac2016-01-04 14:34:37 -08002264 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002265 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002266 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002267 if c.stl != nil {
2268 c.stl.begin(ctx)
2269 }
Colin Cross16b23492016-01-06 14:41:07 -08002270 if c.sanitize != nil {
2271 c.sanitize.begin(ctx)
2272 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002273 if c.coverage != nil {
2274 c.coverage.begin(ctx)
2275 }
Yi Kong9723e332023-12-04 14:52:53 +09002276 if c.afdo != nil {
2277 c.afdo.begin(ctx)
2278 }
Stephen Craneba090d12017-05-09 15:44:35 -07002279 if c.lto != nil {
2280 c.lto.begin(ctx)
2281 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002282 if c.orderfile != nil {
2283 c.orderfile.begin(ctx)
2284 }
Dan Albert92fe7402020-07-15 13:33:30 -07002285 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002286 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002287 if err != nil {
2288 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002289 c.Properties.Sdk_version = nil
2290 } else {
2291 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002292 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002293 }
Colin Crossca860ac2016-01-04 14:34:37 -08002294}
2295
Colin Cross37047f12016-12-13 17:06:13 -08002296func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002297 deps := Deps{}
2298
Joe Onorato37f900c2023-07-18 16:58:16 -07002299 for _, generator := range c.generators {
2300 deps = generator.GeneratorDeps(ctx, deps)
2301 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002302 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002303 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002304 }
2305 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002306 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002307 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002308 if c.stl != nil {
2309 deps = c.stl.deps(ctx, deps)
2310 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002311 if c.coverage != nil {
2312 deps = c.coverage.deps(ctx, deps)
2313 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002314
Colin Crossb6715442017-10-24 11:13:31 -07002315 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2316 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2317 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2318 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2319 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2320 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002321 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002322
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002323 for _, lib := range deps.ReexportSharedLibHeaders {
2324 if !inList(lib, deps.SharedLibs) {
2325 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2326 }
2327 }
2328
2329 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002330 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2331 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 -07002332 }
2333 }
2334
Colin Cross5950f382016-12-13 12:50:57 -08002335 for _, lib := range deps.ReexportHeaderLibHeaders {
2336 if !inList(lib, deps.HeaderLibs) {
2337 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2338 }
2339 }
2340
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002341 for _, gen := range deps.ReexportGeneratedHeaders {
2342 if !inList(gen, deps.GeneratedHeaders) {
2343 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2344 }
2345 }
2346
Colin Crossc99deeb2016-04-11 15:06:20 -07002347 return deps
2348}
2349
Dan Albert7e9d2952016-08-04 13:02:36 -07002350func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002351 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002352 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002353 moduleContextImpl: moduleContextImpl{
2354 mod: c,
2355 },
2356 }
2357 ctx.ctx = ctx
2358
Colin Crossca860ac2016-01-04 14:34:37 -08002359 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002360}
2361
Jiyong Park7ed9de32018-10-15 22:25:07 +09002362// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002363func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002364 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2365 version := name[sharp+1:]
2366 libname := name[:sharp]
2367 return libname, version
2368 }
2369 return name, ""
2370}
2371
Dan Albert92fe7402020-07-15 13:33:30 -07002372func GetCrtVariations(ctx android.BottomUpMutatorContext,
2373 m LinkableInterface) []blueprint.Variation {
2374 if ctx.Os() != android.Android {
2375 return nil
2376 }
2377 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002378 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2379 minSdkVersion := m.MinSdkVersion()
2380 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2381 minSdkVersion = m.SdkVersion()
2382 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002383 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2384 if err != nil {
2385 ctx.PropertyErrorf("min_sdk_version", err.Error())
2386 }
Colin Cross363ec762023-01-13 13:45:14 -08002387
2388 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002389 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002390 if apiLevel.LessThan(minApiForArch) {
2391 apiLevel = minApiForArch
2392 }
2393
Dan Albert92fe7402020-07-15 13:33:30 -07002394 return []blueprint.Variation{
2395 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002396 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002397 }
2398 }
2399 return []blueprint.Variation{
2400 {Mutator: "sdk", Variation: ""},
2401 }
2402}
2403
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002404func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2405 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002406
2407 variations = append([]blueprint.Variation(nil), variations...)
2408
Liz Kammer23942242022-04-08 15:41:00 -04002409 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002410 // Version is explicitly specified. i.e. libFoo#30
2411 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002412 if tag, ok := depTag.(libraryDependencyTag); ok {
2413 tag.explicitlyVersioned = true
2414 } else {
2415 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2416 }
Colin Crosse7257d22020-09-24 09:56:18 -07002417 }
Colin Crosse7257d22020-09-24 09:56:18 -07002418
Colin Cross0de8a1e2020-09-18 14:15:30 -07002419 if far {
2420 ctx.AddFarVariationDependencies(variations, depTag, name)
2421 } else {
2422 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002423 }
2424}
2425
Kiyoung Kim487689e2022-07-26 09:48:22 +09002426func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2427 apiImportInfo := multitree.ApiImportInfo{}
2428
2429 if c.Device() {
2430 var apiImportModule []blueprint.Module
2431 if actx.OtherModuleExists("api_imports") {
2432 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2433 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002434 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002435 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002436 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002437 }
2438 }
2439 }
2440
2441 return apiImportInfo
2442}
2443
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002444func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002445 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002446 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002447 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002448 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2449 // between the modules in the snapshot and the snapshot itself.
2450 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002451 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002452 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002453 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002454 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2455 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002456 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002457 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002458 *snapshotInfo = &snapshot
2459 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002460 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002461 }
2462 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002463 if *snapshotInfo == nil {
2464 *snapshotInfo = &SnapshotInfo{}
2465 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002466 return **snapshotInfo
2467}
2468
Kiyoung Kim487689e2022-07-26 09:48:22 +09002469func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2470 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002471 return snapshot
2472 }
2473
2474 return lib
2475}
2476
2477// RewriteLibs takes a list of names of shared libraries and scans it for three types
2478// of names:
2479//
2480// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002481//
2482// For each of these, it adds the name of the prebuilt module (which will be in
2483// prebuilts/ndk) to the list of nonvariant libs.
2484//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002485// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002486//
2487// For each of these, it adds the name of the ndk_library module to the list of
2488// variant libs.
2489//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002490// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002491//
2492// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002493//
2494// The caller can then know to add the variantLibs dependencies differently from the
2495// nonvariantLibs
2496func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2497 variantLibs = []string{}
2498
2499 nonvariantLibs = []string{}
2500 for _, entry := range list {
2501 // strip #version suffix out
2502 name, _ := StubsLibNameAndVersion(entry)
2503 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002504 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002505 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2506 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2507 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002508 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002509 } else {
2510 // put name#version back
2511 nonvariantLibs = append(nonvariantLibs, entry)
2512 }
2513 }
2514 return nonvariantLibs, variantLibs
2515}
2516
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002517func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2518 nonVariantLibs := []string{}
2519 variantLibs := []string{}
2520
2521 for _, lib := range libs {
2522 replaceLibName := GetReplaceModuleName(lib, replaceList)
2523 if replaceLibName == lib {
2524 // Do not handle any libs which are not in API imports
2525 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2526 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2527 variantLibs = append(variantLibs, replaceLibName)
2528 } else {
2529 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2530 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002531 }
2532
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002533 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002534}
2535
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002536func (c *Module) shouldUseApiSurface() bool {
2537 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2538 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2539 // LLNDK Variant
2540 return true
2541 }
2542
2543 if c.Properties.IsSdkVariant {
2544 // NDK Variant
2545 return true
2546 }
2547
2548 if c.isImportedApiLibrary() {
2549 // API Library should depend on API headers
2550 return true
2551 }
2552 }
2553
2554 return false
2555}
2556
Colin Cross1e676be2016-10-12 14:38:15 -07002557func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002558 if !c.Enabled() {
2559 return
2560 }
2561
Colin Cross37047f12016-12-13 17:06:13 -08002562 ctx := &depsContext{
2563 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002564 moduleContextImpl: moduleContextImpl{
2565 mod: c,
2566 },
2567 }
2568 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002569
Colin Crossc99deeb2016-04-11 15:06:20 -07002570 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002571 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002572
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002573 apiNdkLibs := []string{}
2574 apiLateNdkLibs := []string{}
2575
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002576 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002577 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2578 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2579 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2580 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2581 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002582 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002583
Yo Chiang219968c2020-09-22 18:45:04 +08002584 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2585
Colin Crosse0edaf92021-01-11 17:31:17 -08002586 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002587
Dan Albert914449f2016-06-17 16:45:24 -07002588 variantNdkLibs := []string{}
2589 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002590 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002591 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2592 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2593 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002594
2595 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002596 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002597 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002598 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002599
Colin Cross32ec36c2016-12-15 07:39:51 -08002600 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002601 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002602 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002603 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002604 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002605
Kiyoung Kim51279d32022-08-24 14:10:46 +09002606 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002607 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002608 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2609 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002610 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002611
Spandan Das73bcafc2022-08-18 23:26:00 +00002612 if c.isNDKStubLibrary() {
2613 // ndk_headers do not have any variations
2614 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002615 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002616 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002617 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002618 } else {
2619 actx.AddVariationDependencies(nil, depTag, lib)
2620 }
2621 }
2622
Dan Albertf1d14c72020-07-30 14:32:55 -07002623 if c.isNDKStubLibrary() {
2624 // NDK stubs depend on their implementation because the ABI dumps are
2625 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002626
Spandan Das8b08aea2023-03-14 19:29:34 +00002627 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2628 c.ImageVariation(),
2629 blueprint.Variation{Mutator: "link", Variation: "shared"},
2630 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002631 }
2632
Jiyong Park5d1598f2019-02-25 22:14:17 +09002633 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002634 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002635
Kiyoung Kim487689e2022-07-26 09:48:22 +09002636 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002637
Jiyong Park5d1598f2019-02-25 22:14:17 +09002638 actx.AddVariationDependencies([]blueprint.Variation{
2639 {Mutator: "link", Variation: "static"},
2640 }, depTag, lib)
2641 }
2642
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002643 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002644 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002645 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002646 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002647 }
Jiyong Parke3867542020-12-03 17:28:25 +09002648 if inList(lib, deps.ExcludeLibsForApex) {
2649 depTag.excludeInApex = true
2650 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002651
Kiyoung Kim487689e2022-07-26 09:48:22 +09002652 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002653
Dan Willemsen59339a22018-07-22 21:18:45 -07002654 actx.AddVariationDependencies([]blueprint.Variation{
2655 {Mutator: "link", Variation: "static"},
2656 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002657 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002658
Jooyung Han75568392020-03-20 04:29:24 +09002659 // staticUnwinderDep is treated as staticDep for Q apexes
2660 // so that native libraries/binaries are linked with static unwinder
2661 // because Q libc doesn't have unwinder APIs
2662 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002663 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002664 actx.AddVariationDependencies([]blueprint.Variation{
2665 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002666 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002667 }
2668
Jiyong Park7ed9de32018-10-15 22:25:07 +09002669 // shared lib names without the #version suffix
2670 var sharedLibNames []string
2671
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002672 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002673 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002674 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002675 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002676 }
Jiyong Parke3867542020-12-03 17:28:25 +09002677 if inList(lib, deps.ExcludeLibsForApex) {
2678 depTag.excludeInApex = true
2679 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002680 if inList(lib, deps.ExcludeLibsForNonApex) {
2681 depTag.excludeInNonApex = true
2682 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002683
Jiyong Park73c54ee2019-10-22 20:31:18 +09002684 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002685 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2686 name = apiLibraryName
2687 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002688 sharedLibNames = append(sharedLibNames, name)
2689
Colin Crosse7257d22020-09-24 09:56:18 -07002690 variations := []blueprint.Variation{
2691 {Mutator: "link", Variation: "shared"},
2692 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002693
2694 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2695 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2696 }
2697
2698 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2699 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2700 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002701 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002702
Colin Crossfe9acfe2021-06-14 16:13:03 -07002703 for _, lib := range deps.LateStaticLibs {
2704 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2705 actx.AddVariationDependencies([]blueprint.Variation{
2706 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002707 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002708 }
2709
Colin Cross3e5e7782022-06-17 22:17:05 +00002710 for _, lib := range deps.UnexportedStaticLibs {
2711 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2712 actx.AddVariationDependencies([]blueprint.Variation{
2713 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002714 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002715 }
2716
Jiyong Park7ed9de32018-10-15 22:25:07 +09002717 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002718 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002719 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2720 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2721 // linking against both the stubs lib and the non-stubs lib at the same time.
2722 continue
2723 }
Colin Cross6e511a92020-07-27 21:26:48 -07002724 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002725 variations := []blueprint.Variation{
2726 {Mutator: "link", Variation: "shared"},
2727 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002728 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002729 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002730
Dan Willemsen59339a22018-07-22 21:18:45 -07002731 actx.AddVariationDependencies([]blueprint.Variation{
2732 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002733 }, dataLibDepTag, deps.DataLibs...)
2734
Colin Crossc8caa062021-09-24 16:50:14 -07002735 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2736
Chris Parsons79d66a52020-06-05 17:26:16 -04002737 actx.AddVariationDependencies([]blueprint.Variation{
2738 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002739 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002740
Colin Cross68861832016-07-08 10:41:41 -07002741 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002742
2743 for _, gen := range deps.GeneratedHeaders {
2744 depTag := genHeaderDepTag
2745 if inList(gen, deps.ReexportGeneratedHeaders) {
2746 depTag = genHeaderExportDepTag
2747 }
2748 actx.AddDependency(c, depTag, gen)
2749 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002750
Dan Albert92fe7402020-07-15 13:33:30 -07002751 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002752 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002753 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002754 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002755 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002756 }
Colin Crossc465efd2021-06-11 18:00:04 -07002757 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002758 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002759 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002760 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002761 if deps.DynamicLinker != "" {
2762 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002763 }
Dan Albert914449f2016-06-17 16:45:24 -07002764
2765 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002766
2767 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002768 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002769 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002770 {Mutator: "link", Variation: "shared"},
2771 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002772 actx.AddVariationDependencies([]blueprint.Variation{
2773 {Mutator: "version", Variation: version},
2774 {Mutator: "link", Variation: "shared"},
2775 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002776
2777 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002778 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002779 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002780 {Mutator: "link", Variation: "shared"},
2781 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002782 actx.AddVariationDependencies([]blueprint.Variation{
2783 {Mutator: "version", Variation: version},
2784 {Mutator: "link", Variation: "shared"},
2785 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002786
2787 if vndkdep := c.vndkdep; vndkdep != nil {
2788 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002789 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002790 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002791 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002792 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002793 }
2794 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002795
Vinh Tran367d89d2023-04-28 11:21:25 -04002796 if len(deps.AidlLibs) > 0 {
2797 actx.AddDependency(
2798 c,
2799 aidlLibraryTag,
2800 deps.AidlLibs...,
2801 )
2802 }
2803
Kiyoung Kimee58c932022-10-25 22:59:41 +09002804 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002805}
Colin Cross21b9a242015-03-24 14:15:58 -07002806
Colin Crosse40b4ea2018-10-02 22:25:58 -07002807func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002808 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2809 c.beginMutator(ctx)
2810 }
2811}
2812
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002813// Whether a module can link to another module, taking into
2814// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002815func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002816 tag blueprint.DependencyTag) {
2817
2818 switch t := tag.(type) {
2819 case dependencyTag:
2820 if t != vndkExtDepTag {
2821 return
2822 }
2823 case libraryDependencyTag:
2824 default:
2825 return
2826 }
2827
Ivan Lozanof9e21722020-12-02 09:00:51 -05002828 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002829 // Host code is not restricted
2830 return
2831 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002832
2833 // VNDK is cc.Module supported only for now.
2834 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002835 // Though allowed dependency is limited by the image mutator,
2836 // each vendor and product module needs to check link-type
2837 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002838 if ccTo, ok := to.(*Module); ok {
2839 if ccFrom.vndkdep != nil {
2840 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2841 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002842 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002843 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002844 }
2845 return
2846 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002847 // TODO(b/244244438) : Remove this once all variants are implemented
2848 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2849 return
2850 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002851 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002852 // Platform code can link to anything
2853 return
2854 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002855 if from.InRamdisk() {
2856 // Ramdisk code is not NDK
2857 return
2858 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002859 if from.InVendorRamdisk() {
2860 // Vendor ramdisk code is not NDK
2861 return
2862 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002863 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002864 // Recovery code is not NDK
2865 return
2866 }
Colin Cross31076b32020-10-23 17:22:06 -07002867 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002868 if c.NdkPrebuiltStl() {
2869 // These are allowed, but they don't set sdk_version
2870 return
2871 }
2872 if c.StubDecorator() {
2873 // These aren't real libraries, but are the stub shared libraries that are included in
2874 // the NDK.
2875 return
2876 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002877 if c.isImportedApiLibrary() {
2878 // Imported library from the API surface is a stub library built against interface definition.
2879 return
2880 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002881 }
Logan Chien834b9a62019-01-14 15:39:03 +08002882
Ivan Lozano52767be2019-10-18 14:49:46 -07002883 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002884 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2885 // to link to libc++ (non-NDK and without sdk_version).
2886 return
2887 }
2888
Ivan Lozano52767be2019-10-18 14:49:46 -07002889 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002890 // NDK code linking to platform code is never okay.
2891 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002892 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002893 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002894 }
2895
2896 // At this point we know we have two NDK libraries, but we need to
2897 // check that we're not linking against anything built against a higher
2898 // API level, as it is only valid to link against older or equivalent
2899 // APIs.
2900
Inseob Kim01a28722018-04-11 09:48:45 +09002901 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002902 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002903 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002904 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002905 // Current can't be linked against by anything else.
2906 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002907 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002908 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002909 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.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 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002914 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002915 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002916 if err != nil {
2917 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002918 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002919 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002920 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002921
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002922 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002923 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002924 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002925 }
2926 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002927 }
Dan Albert202fe492017-12-15 13:56:59 -08002928
2929 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002930 fromStl := from.SelectedStl()
2931 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002932 if fromStl == "" || toStl == "" {
2933 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002934 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002935 // We can be permissive with the system "STL" since it is only the C++
2936 // ABI layer, but in the future we should make sure that everyone is
2937 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002938 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002939 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002940 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2941 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002942 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002943}
2944
Jooyung Han479ca172020-10-19 18:51:07 +09002945func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2946 if c, ok := ctx.Module().(*Module); ok {
2947 ctx.VisitDirectDeps(func(dep android.Module) {
2948 depTag := ctx.OtherModuleDependencyTag(dep)
2949 ccDep, ok := dep.(LinkableInterface)
2950 if ok {
2951 checkLinkType(ctx, c, ccDep, depTag)
2952 }
2953 })
2954 }
2955}
2956
Jiyong Park5fb8c102018-04-09 12:03:06 +09002957// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002958// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2959// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002960// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002961func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2962 check := func(child, parent android.Module) bool {
2963 to, ok := child.(*Module)
2964 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002965 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002966 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002967
Jooyung Hana70f0672019-01-18 15:20:43 +09002968 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2969 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002970 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002971
Jiyong Park0474e1f2021-01-14 14:26:06 +09002972 // These dependencies are not excercised at runtime. Tracking these will give us
2973 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002974 depTag := ctx.OtherModuleDependencyTag(child)
2975 if IsHeaderDepTag(depTag) {
2976 return false
2977 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002978 if depTag == staticVariantTag {
2979 return false
2980 }
2981 if depTag == stubImplDepTag {
2982 return false
2983 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09002984 if depTag == android.RequiredDepTag {
2985 return false
2986 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002987
Justin Yun63e9ec72020-10-29 16:49:43 +09002988 // Even if target lib has no vendor variant, keep checking dependency
2989 // graph in case it depends on vendor_available or product_available
2990 // but not double_loadable transtively.
2991 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002992 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002993 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002994
Jiyong Park0474e1f2021-01-14 14:26:06 +09002995 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2996 // one.
2997 if Bool(to.VendorProperties.Double_loadable) {
2998 return true
2999 }
3000
Ivan Lozanod7586b62021-04-01 09:49:36 -04003001 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003002 return false
3003 }
3004
Jooyung Hana70f0672019-01-18 15:20:43 +09003005 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3006 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003007 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003008 return false
3009 }
3010 if module, ok := ctx.Module().(*Module); ok {
3011 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003012 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003013 ctx.WalkDeps(check)
3014 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003015 }
3016 }
3017}
3018
Yu Liue4312402023-01-18 09:15:31 -08003019func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3020 // For the dependency from platform to apex, use the latest stubs
3021 apexSdkVersion := android.FutureApiLevel
3022 if !apexInfo.IsForPlatform() {
3023 apexSdkVersion = apexInfo.MinSdkVersion
3024 }
3025
3026 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3027 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3028 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3029 // (b/144430859)
3030 apexSdkVersion = android.FutureApiLevel
3031 }
3032
3033 return apexSdkVersion
3034}
3035
Colin Crossc99deeb2016-04-11 15:06:20 -07003036// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003037func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003038 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003039
Colin Cross0de8a1e2020-09-18 14:15:30 -07003040 var directStaticDeps []StaticLibraryInfo
3041 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003042
Colin Cross0de8a1e2020-09-18 14:15:30 -07003043 reexportExporter := func(exporter FlagExporterInfo) {
3044 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3045 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3046 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3047 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3048 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003049 }
3050
Colin Crossff694a82023-12-13 15:54:49 -08003051 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003052 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003053
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003054 skipModuleList := map[string]bool{}
3055
3056 var apiImportInfo multitree.ApiImportInfo
3057 hasApiImportInfo := false
3058
3059 ctx.VisitDirectDeps(func(dep android.Module) {
3060 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003061 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003062 hasApiImportInfo = true
3063 }
3064 })
3065
3066 if hasApiImportInfo {
3067 targetStubModuleList := map[string]string{}
3068 targetOrigModuleList := map[string]string{}
3069
3070 // Search for dependency which both original module and API imported library with APEX stub exists
3071 ctx.VisitDirectDeps(func(dep android.Module) {
3072 depName := ctx.OtherModuleName(dep)
3073 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3074 targetStubModuleList[apiLibrary] = depName
3075 }
3076 })
3077 ctx.VisitDirectDeps(func(dep android.Module) {
3078 depName := ctx.OtherModuleName(dep)
3079 if origLibrary, ok := targetStubModuleList[depName]; ok {
3080 targetOrigModuleList[origLibrary] = depName
3081 }
3082 })
3083
3084 // Decide which library should be used between original and API imported library
3085 ctx.VisitDirectDeps(func(dep android.Module) {
3086 depName := ctx.OtherModuleName(dep)
3087 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003088 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003089 skipModuleList[depName] = true
3090 } else {
3091 skipModuleList[apiLibrary] = true
3092 }
3093 }
3094 })
3095 }
3096
Colin Crossd11fcda2017-10-23 17:59:01 -07003097 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003098 depName := ctx.OtherModuleName(dep)
3099 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003100
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003101 if _, ok := skipModuleList[depName]; ok {
3102 // skip this module because original module or API imported module matching with this should be used instead.
3103 return
3104 }
3105
Dan Willemsen47450072021-10-19 20:24:49 -07003106 if depTag == android.DarwinUniversalVariantTag {
3107 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3108 return
3109 }
3110
Vinh Tran367d89d2023-04-28 11:21:25 -04003111 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003112 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003113 depPaths.AidlLibraryInfos = append(
3114 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003115 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003116 )
3117 }
3118 }
3119
Ivan Lozano52767be2019-10-18 14:49:46 -07003120 ccDep, ok := dep.(LinkableInterface)
3121 if !ok {
3122
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003123 // handling for a few module types that aren't cc Module but that are also supported
3124 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003125 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003126 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003127 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3128 genRule.GeneratedSourceFiles()...)
3129 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003130 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003131 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003132 // Support exported headers from a generated_sources dependency
3133 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003134 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003135 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003136 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003137 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003138 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003139 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003140 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003141 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003142 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3143 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003144 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003145 // 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 +09003146 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003147
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003148 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003149 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003150 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003151 }
Colin Crosscef792e2021-06-11 18:01:26 -07003152 case CrtBeginDepTag:
3153 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3154 case CrtEndDepTag:
3155 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003156 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003157 return
3158 }
3159
Colin Crossfe17f6f2019-03-28 19:30:56 -07003160 if depTag == android.ProtoPluginDepTag {
3161 return
3162 }
3163
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003164 if depTag == android.RequiredDepTag {
3165 return
3166 }
3167
Colin Crossd11fcda2017-10-23 17:59:01 -07003168 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003169 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3170 return
3171 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003172 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003173 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3174 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003175 return
3176 }
3177
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003178 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003179 // Skip reused objects for stub libraries, they use their own stub object file instead.
3180 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3181 // version mutator, so the stubs variant is created from the shared variant that
3182 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003183 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003184 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003185 objs := staticAnalogue.ReuseObjects
3186 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003187 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003188 reexportExporter(depExporterInfo)
3189 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003190 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003191 }
3192
Colin Cross6e511a92020-07-27 21:26:48 -07003193 linkFile := ccDep.OutputFile()
3194
3195 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3196 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003197 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003198 return
3199 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003200
Jiyong Parke3867542020-12-03 17:28:25 +09003201 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3202 return
3203 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003204 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3205 return
3206 }
Jiyong Parke3867542020-12-03 17:28:25 +09003207
Colin Cross313aa542023-12-13 13:47:44 -08003208 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003209
Colin Cross6e511a92020-07-27 21:26:48 -07003210 var ptr *android.Paths
3211 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003212
Colin Cross6e511a92020-07-27 21:26:48 -07003213 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003214
Colin Cross6e511a92020-07-27 21:26:48 -07003215 switch {
3216 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003217 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003218 if !ctx.Config().AllowMissingDependencies() {
3219 ctx.ModuleErrorf("module %q is not a header library", depName)
3220 } else {
3221 ctx.AddMissingDependencies([]string{depName})
3222 }
3223 return
3224 }
Colin Cross6e511a92020-07-27 21:26:48 -07003225 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003226 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003227 if !ctx.Config().AllowMissingDependencies() {
3228 ctx.ModuleErrorf("module %q is not a shared library", depName)
3229 } else {
3230 ctx.AddMissingDependencies([]string{depName})
3231 }
3232 return
3233 }
Jiyong Parke3867542020-12-03 17:28:25 +09003234
Jiyong Park7d55b612021-06-11 17:22:09 +09003235 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3236 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003237
Jiyong Park1ad8e162020-12-01 23:40:09 +09003238 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3239 // linkFile, depFile, and ptr.
3240 if c.IsStubs() {
3241 break
3242 }
3243
Colin Cross0de8a1e2020-09-18 14:15:30 -07003244 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3245 depFile = sharedLibraryInfo.TableOfContents
3246
Colin Cross6e511a92020-07-27 21:26:48 -07003247 ptr = &depPaths.SharedLibs
3248 switch libDepTag.Order {
3249 case earlyLibraryDependency:
3250 ptr = &depPaths.EarlySharedLibs
3251 depPtr = &depPaths.EarlySharedLibsDeps
3252 case normalLibraryDependency:
3253 ptr = &depPaths.SharedLibs
3254 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003255 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003256 case lateLibraryDependency:
3257 ptr = &depPaths.LateSharedLibs
3258 depPtr = &depPaths.LateSharedLibsDeps
3259 default:
3260 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003261 }
Colin Cross6e511a92020-07-27 21:26:48 -07003262 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003263 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3264 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003265 if !ctx.Config().AllowMissingDependencies() {
3266 ctx.ModuleErrorf("module %q is not a static library", depName)
3267 } else {
3268 ctx.AddMissingDependencies([]string{depName})
3269 }
3270 return
3271 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003272
3273 // Stubs lib doesn't link to the static lib dependencies. Don't set
3274 // linkFile, depFile, and ptr.
3275 if c.IsStubs() {
3276 break
3277 }
3278
Colin Cross0de8a1e2020-09-18 14:15:30 -07003279 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003280 if libDepTag.wholeStatic {
3281 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003282 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3283 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003284 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003285 // This case normally catches prebuilt static
3286 // libraries, but it can also occur when
3287 // AllowMissingDependencies is on and the
3288 // dependencies has no sources of its own
3289 // but has a whole_static_libs dependency
3290 // on a missing library. We want to depend
3291 // on the .a file so that there is something
3292 // in the dependency tree that contains the
3293 // error rule for the missing transitive
3294 // dependency.
3295 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003296 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003297 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3298 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003299 } else {
3300 switch libDepTag.Order {
3301 case earlyLibraryDependency:
3302 panic(fmt.Errorf("early static libs not suppported"))
3303 case normalLibraryDependency:
3304 // static dependencies will be handled separately so they can be ordered
3305 // using transitive dependencies.
3306 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003307 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003308 case lateLibraryDependency:
3309 ptr = &depPaths.LateStaticLibs
3310 default:
3311 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003312 }
3313 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003314 if libDepTag.unexportedSymbols {
3315 depPaths.LdFlags = append(depPaths.LdFlags,
3316 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3317 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003318 }
3319
Colin Cross6e511a92020-07-27 21:26:48 -07003320 if libDepTag.static() && !libDepTag.wholeStatic {
3321 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3322 ctx.ModuleErrorf("module %q not a static library", depName)
3323 return
3324 }
Logan Chien43d34c32017-12-20 01:17:32 +08003325
Colin Cross6e511a92020-07-27 21:26:48 -07003326 // When combining coverage files for shared libraries and executables, coverage files
3327 // in static libraries act as if they were whole static libraries. The same goes for
3328 // source based Abi dump files.
3329 if c, ok := ccDep.(*Module); ok {
3330 staticLib := c.linker.(libraryInterface)
3331 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3332 staticLib.objs().coverageFiles...)
3333 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3334 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003335 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003336 // Handle non-CC modules here
3337 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003338 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003339 }
3340 }
3341
Colin Cross6e511a92020-07-27 21:26:48 -07003342 if ptr != nil {
3343 if !linkFile.Valid() {
3344 if !ctx.Config().AllowMissingDependencies() {
3345 ctx.ModuleErrorf("module %q missing output file", depName)
3346 } else {
3347 ctx.AddMissingDependencies([]string{depName})
3348 }
3349 return
3350 }
3351 *ptr = append(*ptr, linkFile.Path())
3352 }
3353
3354 if depPtr != nil {
3355 dep := depFile
3356 if !dep.Valid() {
3357 dep = linkFile
3358 }
3359 *depPtr = append(*depPtr, dep.Path())
3360 }
3361
Colin Cross0de8a1e2020-09-18 14:15:30 -07003362 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3363 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3364 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3365 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3366
3367 if libDepTag.reexportFlags {
3368 reexportExporter(depExporterInfo)
3369 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3370 // Re-exported shared library headers must be included as well since they can help us with type information
3371 // about template instantiations (instantiated from their headers).
3372 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3373 // scripts.
3374 c.sabi.Properties.ReexportedIncludes = append(
3375 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3376 }
3377
Spandan Das3faa7922024-02-26 19:42:32 +00003378 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003379 switch {
3380 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003381 c.Properties.AndroidMkHeaderLibs = append(
3382 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003383 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003384 if lib := moduleLibraryInterface(dep); lib != nil {
3385 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003386 // Add the dependency to the APEX(es) providing the library so that
3387 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003388 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003389 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003390 c.Properties.ApexesProvidingSharedLibs = append(
3391 c.Properties.ApexesProvidingSharedLibs, an)
3392 }
3393 }
3394 }
3395
3396 // Note: the order of libs in this list is not important because
3397 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003398 c.Properties.AndroidMkSharedLibs = append(
3399 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003400 // Record BaseLibName for snapshots.
3401 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003402 case libDepTag.static():
3403 if libDepTag.wholeStatic {
3404 c.Properties.AndroidMkWholeStaticLibs = append(
3405 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3406 } else {
3407 c.Properties.AndroidMkStaticLibs = append(
3408 c.Properties.AndroidMkStaticLibs, makeLibName)
3409 }
Justin Yun5e035862021-06-29 20:50:37 +09003410 // Record BaseLibName for snapshots.
3411 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003412 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003413 } else if !c.IsStubs() {
3414 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3415
Colin Cross6e511a92020-07-27 21:26:48 -07003416 switch depTag {
3417 case runtimeDepTag:
3418 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003419 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003420 // Record BaseLibName for snapshots.
3421 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003422 case objDepTag:
3423 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3424 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003425 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003426 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003427 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003428 case dynamicLinkerDepTag:
3429 depPaths.DynamicLinker = linkFile
3430 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003431 }
Colin Crossca860ac2016-01-04 14:34:37 -08003432 })
3433
Jeff Gaston294356f2017-09-27 17:05:30 -07003434 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003435 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3436 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3437 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003438
Colin Crossdd84e052017-05-17 13:44:16 -07003439 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003440 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003441 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3442 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003443 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003444 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3445 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003446 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003447 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003448 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003449
3450 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003451 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003452 }
Colin Crossdd84e052017-05-17 13:44:16 -07003453
Colin Crossca860ac2016-01-04 14:34:37 -08003454 return depPaths
3455}
3456
Spandan Das604f3762023-03-16 22:51:40 +00003457func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003458 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003459 thisModule, ok := ctx.Module().(android.ApexModule)
3460 if !ok {
3461 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3462 }
3463
Kiyoung Kimaa394802024-01-08 12:55:45 +09003464 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003465 bootstrap := false
3466 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3467 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3468 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003469 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003470 bootstrap = linkable.Bootstrap()
3471 }
3472
Colin Crossff694a82023-12-13 15:54:49 -08003473 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003474
3475 useStubs := false
3476
Kiyoung Kimaa394802024-01-08 12:55:45 +09003477 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003478 if !apexInfo.IsForPlatform() {
3479 // For platform libraries, use current version of LLNDK
3480 // If this is for use_vendor apex we will apply the same rules
3481 // of apex sdk enforcement below to choose right version.
3482 useStubs = true
3483 }
3484 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3485 // If not building for APEX or the containing APEX allows the use of
3486 // platform APIs, use stubs only when it is from an APEX (and not from
3487 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3488 // bootstrap modules, always link to non-stub variant
3489 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3490
3491 isApexImportedApiLibrary := false
3492
3493 if cc, ok := dep.(*Module); ok {
3494 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3495 if apiLibrary.hasApexStubs() {
3496 isApexImportedApiLibrary = true
3497 }
3498 }
3499 }
3500
3501 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3502
3503 if useStubs {
3504 // Another exception: if this module is a test for an APEX, then
3505 // it is linked with the non-stub variant of a module in the APEX
3506 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003507 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003508 for _, apexContents := range testFor.ApexContents {
3509 if apexContents.DirectlyInApex(depName) {
3510 useStubs = false
3511 break
3512 }
3513 }
3514 }
3515 if useStubs {
3516 // Yet another exception: If this module and the dependency are
3517 // available to the same APEXes then skip stubs between their
3518 // platform variants. This complements the test_for case above,
3519 // which avoids the stubs on a direct APEX library dependency, by
3520 // avoiding stubs for indirect test dependencies as well.
3521 //
3522 // TODO(b/183882457): This doesn't work if the two libraries have
3523 // only partially overlapping apex_available. For that test_for
3524 // modules would need to be split into APEX variants and resolved
3525 // separately for each APEX they have access to.
3526 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3527 useStubs = false
3528 }
3529 }
3530 } else {
3531 // If building for APEX, use stubs when the parent is in any APEX that
3532 // the child is not in.
3533 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3534 }
3535
3536 return useStubs
3537}
3538
3539// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3540// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3541// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3542// has different level of updatability. For example, if a library foo in an APEX depends on a
3543// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3544// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3545// same APEX as foo, the non-stub variant of bar is used.
3546func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3547 depTag := ctx.OtherModuleDependencyTag(dep)
3548 libDepTag, ok := depTag.(libraryDependencyTag)
3549 if !ok || !libDepTag.shared() {
3550 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3551 }
3552
Colin Cross313aa542023-12-13 13:47:44 -08003553 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3554 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3555 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003556
3557 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003558 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003559 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003560 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3561 toUse := stubs[len(stubs)-1]
3562 sharedLibraryInfo = toUse.SharedLibraryInfo
3563 depExporterInfo = toUse.FlagExporterInfo
3564 }
3565 }
3566 return sharedLibraryInfo, depExporterInfo
3567}
3568
Colin Cross0de8a1e2020-09-18 14:15:30 -07003569// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3570// to match the topological order of the dependency tree, including any static analogues of
3571// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3572// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003573func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3574 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003575 var staticPaths android.Paths
3576 for _, staticDep := range staticDeps {
3577 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3578 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3579 }
3580 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003581 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3582 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003583 }
3584 }
3585 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3586
3587 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3588
3589 // reorder the dependencies based on transitive dependencies
3590 staticPaths = android.FirstUniquePaths(staticPaths)
3591 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3592
3593 if len(orderedStaticPaths) != len(staticPaths) {
3594 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3595 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3596 }
3597
3598 return orderedStaticPaths, transitiveStaticLibs
3599}
3600
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003601// BaseLibName trims known prefixes and suffixes
3602func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003603 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3604 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003605 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003606 return libName
3607}
3608
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003609func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003610 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003611 ccDepModule, _ := ccDep.(*Module)
3612 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003613 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003614
Justin Yuncbca3732021-02-03 19:24:13 +09003615 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003616 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003617 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003618 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003619
Ivan Lozanod1dec542021-05-26 15:33:11 -04003620 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003621 }
3622 }
3623
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003624 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3625 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003626 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3627 // core module instead.
3628 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003629 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003630 // The vendor and product modules in Make will have been renamed to not conflict with the
3631 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003632 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003633 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003634 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003635 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003636 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003637 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003638 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003639 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003640 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003641 } else {
3642 return libName
3643 }
3644}
3645
Colin Crossca860ac2016-01-04 14:34:37 -08003646func (c *Module) InstallInData() bool {
3647 if c.installer == nil {
3648 return false
3649 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003650 return c.installer.inData()
3651}
3652
3653func (c *Module) InstallInSanitizerDir() bool {
3654 if c.installer == nil {
3655 return false
3656 }
3657 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003658 return true
3659 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003660 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003661}
3662
Yifan Hong1b3348d2020-01-21 15:53:22 -08003663func (c *Module) InstallInRamdisk() bool {
3664 return c.InRamdisk()
3665}
3666
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003667func (c *Module) InstallInVendorRamdisk() bool {
3668 return c.InVendorRamdisk()
3669}
3670
Jiyong Parkf9332f12018-02-01 00:54:12 +09003671func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003672 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003673}
3674
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003675func (c *Module) MakeUninstallable() {
3676 if c.installer == nil {
3677 c.ModuleBase.MakeUninstallable()
3678 return
3679 }
3680 c.installer.makeUninstallable(c)
3681}
3682
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003683func (c *Module) HostToolPath() android.OptionalPath {
3684 if c.installer == nil {
3685 return android.OptionalPath{}
3686 }
3687 return c.installer.hostToolPath()
3688}
3689
Nan Zhangd4e641b2017-07-12 12:55:28 -07003690func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3691 return c.outputFile
3692}
3693
Colin Cross41955e82019-05-29 14:40:35 -07003694func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3695 switch tag {
3696 case "":
3697 if c.outputFile.Valid() {
3698 return android.Paths{c.outputFile.Path()}, nil
3699 }
3700 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003701 case "unstripped":
3702 if c.linker != nil {
3703 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3704 }
3705 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003706 case "stripped_all":
3707 if c.linker != nil {
3708 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3709 }
3710 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003711 default:
3712 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003713 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003714}
3715
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003716func (c *Module) static() bool {
3717 if static, ok := c.linker.(interface {
3718 static() bool
3719 }); ok {
3720 return static.static()
3721 }
3722 return false
3723}
3724
Jiyong Park379de2f2018-12-19 02:47:14 +09003725func (c *Module) staticBinary() bool {
3726 if static, ok := c.linker.(interface {
3727 staticBinary() bool
3728 }); ok {
3729 return static.staticBinary()
3730 }
3731 return false
3732}
3733
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003734func (c *Module) testBinary() bool {
3735 if test, ok := c.linker.(interface {
3736 testBinary() bool
3737 }); ok {
3738 return test.testBinary()
3739 }
3740 return false
3741}
3742
Jingwen Chen537242c2022-08-24 11:53:27 +00003743func (c *Module) testLibrary() bool {
3744 if test, ok := c.linker.(interface {
3745 testLibrary() bool
3746 }); ok {
3747 return test.testLibrary()
3748 }
3749 return false
3750}
3751
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003752func (c *Module) benchmarkBinary() bool {
3753 if b, ok := c.linker.(interface {
3754 benchmarkBinary() bool
3755 }); ok {
3756 return b.benchmarkBinary()
3757 }
3758 return false
3759}
3760
3761func (c *Module) fuzzBinary() bool {
3762 if f, ok := c.linker.(interface {
3763 fuzzBinary() bool
3764 }); ok {
3765 return f.fuzzBinary()
3766 }
3767 return false
3768}
3769
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003770// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3771func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003772 if h, ok := c.linker.(interface {
3773 header() bool
3774 }); ok {
3775 return h.header()
3776 }
3777 return false
3778}
3779
Ivan Lozanod7586b62021-04-01 09:49:36 -04003780func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003781 if b, ok := c.linker.(interface {
3782 binary() bool
3783 }); ok {
3784 return b.binary()
3785 }
3786 return false
3787}
3788
Justin Yun5e035862021-06-29 20:50:37 +09003789func (c *Module) StaticExecutable() bool {
3790 if b, ok := c.linker.(*binaryDecorator); ok {
3791 return b.static()
3792 }
3793 return false
3794}
3795
Ivan Lozanod7586b62021-04-01 09:49:36 -04003796func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003797 if o, ok := c.linker.(interface {
3798 object() bool
3799 }); ok {
3800 return o.object()
3801 }
3802 return false
3803}
3804
Ivan Lozanof9e21722020-12-02 09:00:51 -05003805func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003806 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003807 if c.IsLlndk() {
3808 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003809 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003810 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003811 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003812 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003813 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003814 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003815 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003816 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003817 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003818 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003819 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003820 return "native:product"
3821 }
Jooyung Han38002912019-05-16 04:01:54 +09003822 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003823 } else if c.InRamdisk() {
3824 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003825 } else if c.InVendorRamdisk() {
3826 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003827 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003828 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003829 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003830 return "native:ndk:none:none"
3831 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3832 //family, link := getNdkStlFamilyAndLinkType(c)
3833 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003834 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003835 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003836 } else {
3837 return "native:platform"
3838 }
3839}
3840
Jiyong Park9d452992018-10-03 00:38:19 +09003841// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003842// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003843func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003844 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003845 // Stub libs and prebuilt libs in a versioned SDK are not
3846 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003847 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003848 } else if _, ok := c.linker.(testPerSrc); ok {
3849 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003850 }
3851 return false
3852}
3853
Jiyong Parka90ca002019-10-07 15:47:24 +09003854func (c *Module) AvailableFor(what string) bool {
3855 if linker, ok := c.linker.(interface {
3856 availableFor(string) bool
3857 }); ok {
3858 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3859 } else {
3860 return c.ApexModuleBase.AvailableFor(what)
3861 }
3862}
3863
Jiyong Park62304bb2020-04-13 16:19:48 +09003864func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003865 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003866}
3867
Paul Duffin0cb37b92020-03-04 14:52:46 +00003868func (c *Module) EverInstallable() bool {
3869 return c.installer != nil &&
3870 // Check to see whether the module is actually ever installable.
3871 c.installer.everInstallable()
3872}
3873
Ivan Lozanod7586b62021-04-01 09:49:36 -04003874func (c *Module) PreventInstall() bool {
3875 return c.Properties.PreventInstall
3876}
3877
3878func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003879 if c.library != nil {
3880 if i := c.library.installable(); i != nil {
3881 return i
3882 }
3883 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003884 return c.Properties.Installable
3885}
3886
3887func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003888 ret := c.EverInstallable() &&
3889 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003890 proptools.BoolDefault(c.Installable(), true) &&
3891 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003892
3893 // The platform variant doesn't need further condition. Apex variants however might not
3894 // be installable because it will likely to be included in the APEX and won't appear
3895 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003896 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003897 return ret
3898 }
3899
3900 // Special case for modules that are configured to be installed to /data, which includes
3901 // test modules. For these modules, both APEX and non-APEX variants are considered as
3902 // installable. This is because even the APEX variants won't be included in the APEX, but
3903 // will anyway be installed to /data/*.
3904 // See b/146995717
3905 if c.InstallInData() {
3906 return ret
3907 }
3908
3909 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003910}
3911
Logan Chien41eabe62019-04-10 13:33:58 +08003912func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3913 if c.linker != nil {
3914 if library, ok := c.linker.(*libraryDecorator); ok {
3915 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3916 }
3917 }
3918}
3919
Jiyong Park45bf82e2020-12-15 22:29:02 +09003920var _ android.ApexModule = (*Module)(nil)
3921
3922// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003923func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003924 depTag := ctx.OtherModuleDependencyTag(dep)
3925 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3926
3927 if cc, ok := dep.(*Module); ok {
3928 if cc.HasStubsVariants() {
3929 if isLibDepTag && libDepTag.shared() {
3930 // dynamic dep to a stubs lib crosses APEX boundary
3931 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003932 }
Colin Cross6e511a92020-07-27 21:26:48 -07003933 if IsRuntimeDepTag(depTag) {
3934 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003935 return false
3936 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003937 }
Zhijun Heec285872021-04-24 10:47:08 -07003938 if cc.IsLlndk() {
3939 return false
3940 }
Colin Crossaac32222020-07-29 12:51:56 -07003941 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003942 // shared_lib dependency from a static lib is considered as crossing
3943 // the APEX boundary because the dependency doesn't actually is
3944 // linked; the dependency is used only during the compilation phase.
3945 return false
3946 }
Jiyong Parke3867542020-12-03 17:28:25 +09003947
3948 if isLibDepTag && libDepTag.excludeInApex {
3949 return false
3950 }
Colin Cross6e511a92020-07-27 21:26:48 -07003951 }
Colin Crossc1b36442021-05-06 13:42:48 -07003952 if depTag == stubImplDepTag {
3953 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003954 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003955 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003956 if depTag == staticVariantTag {
3957 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3958 // actually mean that the static lib (and its dependencies) are copied into the
3959 // APEX.
3960 return false
3961 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003962 return true
3963}
3964
Jiyong Park45bf82e2020-12-15 22:29:02 +09003965// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003966func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3967 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003968 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3969 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3970 return nil
3971 }
Jooyung Han749dc692020-04-15 11:03:39 +09003972 // We don't check for prebuilt modules
3973 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3974 return nil
3975 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003976
Jooyung Han749dc692020-04-15 11:03:39 +09003977 minSdkVersion := c.MinSdkVersion()
3978 if minSdkVersion == "apex_inherit" {
3979 return nil
3980 }
3981 if minSdkVersion == "" {
3982 // JNI libs within APK-in-APEX fall into here
3983 // Those are okay to set sdk_version instead
3984 // We don't have to check if this is a SDK variant because
3985 // non-SDK variant resets sdk_version, which works too.
3986 minSdkVersion = c.SdkVersion()
3987 }
Dan Albertc8060532020-07-22 22:32:17 -07003988 if minSdkVersion == "" {
3989 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3990 }
3991 // Not using nativeApiLevelFromUser because the context here is not
3992 // necessarily a native context.
3993 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003994 if err != nil {
3995 return err
3996 }
Dan Albertc8060532020-07-22 22:32:17 -07003997
Colin Cross8ca61c12022-10-06 21:00:14 -07003998 // A dependency only needs to support a min_sdk_version at least
3999 // as high as the api level that the architecture was introduced in.
4000 // This allows introducing new architectures in the platform that
4001 // need to be included in apexes that normally require an older
4002 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08004003 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07004004 if sdkVersion.LessThan(minApiForArch) {
4005 sdkVersion = minApiForArch
4006 }
4007
Dan Albertc8060532020-07-22 22:32:17 -07004008 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004009 return fmt.Errorf("newer SDK(%v)", ver)
4010 }
4011 return nil
4012}
4013
Paul Duffinb5769c12021-05-12 16:16:51 +01004014// Implements android.ApexModule
4015func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4016 // stub libraries and native bridge libraries are always available to platform
4017 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4018}
4019
Jooyung Han91f92032022-02-04 12:36:33 +09004020// Overrides android.ApexModuleBase.UniqueApexVariations
4021func (c *Module) UniqueApexVariations() bool {
4022 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4023 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4024 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004025 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004026 return c.UseVndk() && c.IsVndk()
4027}
4028
Inseob Kima1888ce2022-10-04 14:42:02 +09004029func (c *Module) overriddenModules() []string {
4030 if o, ok := c.linker.(overridable); ok {
4031 return o.overriddenModules()
4032 }
4033 return nil
4034}
4035
Rob Seymour925aa092021-08-10 20:42:03 +00004036var _ snapshot.RelativeInstallPath = (*Module)(nil)
4037
Liz Kammer35ca77e2021-12-22 15:31:40 -05004038type moduleType int
4039
4040const (
4041 unknownType moduleType = iota
4042 binary
4043 object
4044 fullLibrary
4045 staticLibrary
4046 sharedLibrary
4047 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004048 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004049 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004050 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004051)
4052
4053func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004054 if c.testBinary() {
4055 // testBinary is also a binary, so this comes before the c.Binary()
4056 // conditional. A testBinary has additional implicit dependencies and
4057 // other test-only semantics.
4058 return testBin
4059 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004060 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004061 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004062 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004063 } else if c.testLibrary() {
4064 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4065 // will let them add implicit compile deps on gtest, for example.
4066 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004067 // For now, treat them as regular libraries.
4068 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004069 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004070 static := false
4071 shared := false
4072 if library, ok := c.linker.(*libraryDecorator); ok {
4073 static = library.MutatedProperties.BuildStatic
4074 shared = library.MutatedProperties.BuildShared
4075 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4076 static = library.MutatedProperties.BuildStatic
4077 shared = library.MutatedProperties.BuildShared
4078 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004079 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004080 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004081 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004082 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004083 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004084 return staticLibrary
4085 }
4086 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004087 } else if c.isNDKStubLibrary() {
4088 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004089 } else if c.IsNdkPrebuiltStl() {
4090 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004091 }
4092 return unknownType
4093}
4094
Colin Crosscfad1192015-11-02 16:43:11 -08004095// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004096type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004097 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004098 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004099 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004100
4101 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4102 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004103}
4104
Patrice Arrudac249c712019-03-19 17:00:29 -07004105// cc_defaults provides a set of properties that can be inherited by other cc
4106// modules. A module can use the properties from a cc_defaults using
4107// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4108// merged (when possible) by prepending the default module's values to the
4109// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004110func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004111 return DefaultsFactory()
4112}
4113
Colin Cross36242852017-06-23 15:06:31 -07004114func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004115 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004116
Colin Cross36242852017-06-23 15:06:31 -07004117 module.AddProperties(props...)
4118 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004119 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004120 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004121 &BaseCompilerProperties{},
4122 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004123 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004124 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004125 &StaticProperties{},
4126 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004127 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004128 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004129 &TestLinkerProperties{},
4130 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004131 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004132 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004133 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004134 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004135 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004136 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004137 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004138 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004139 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004140 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004141 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004142 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004143 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004144 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004145 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004146 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4147 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004148 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004149 )
Colin Crosscfad1192015-11-02 16:43:11 -08004150
Jooyung Hancc372c52019-09-25 15:18:44 +09004151 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004152
4153 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004154}
4155
Jiyong Park2286afd2020-06-16 21:58:53 +09004156func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004157 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004158}
4159
Kiyoung Kim51279d32022-08-24 14:10:46 +09004160func (c *Module) isImportedApiLibrary() bool {
4161 _, ok := c.linker.(*apiLibraryDecorator)
4162 return ok
4163}
4164
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004165func kytheExtractAllFactory() android.Singleton {
4166 return &kytheExtractAllSingleton{}
4167}
4168
4169type kytheExtractAllSingleton struct {
4170}
4171
4172func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4173 var xrefTargets android.Paths
4174 ctx.VisitAllModules(func(module android.Module) {
4175 if ccModule, ok := module.(xref); ok {
4176 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4177 }
4178 })
4179 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4180 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004181 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004182 }
4183}
4184
Jihoon Kangf78a8902022-09-01 22:47:07 +00004185func (c *Module) Partition() string {
4186 if p, ok := c.installer.(interface {
4187 getPartition() string
4188 }); ok {
4189 return p.getPartition()
4190 }
4191 return ""
4192}
4193
Spandan Das2b6dfb52024-01-19 00:22:22 +00004194type sourceModuleName interface {
4195 sourceModuleName() string
4196}
4197
4198func (c *Module) BaseModuleName() string {
4199 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4200 // if the prebuilt module sets a source_module_name in Android.bp, use that
4201 return smn.sourceModuleName()
4202 }
4203 return c.ModuleBase.BaseModuleName()
4204}
4205
Colin Cross06a931b2015-10-28 17:23:31 -07004206var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004207var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004208var BoolPtr = proptools.BoolPtr
4209var String = proptools.String
4210var StringPtr = proptools.StringPtr