blob: 742d08cf3e229a74189367ffbff5a99b666fe1e2 [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
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800140
141 // LLNDK headers for the ABI checker to check LLNDK implementation library.
142 // An LLNDK implementation is the core variant. LLNDK header libs are reexported by the vendor variant.
143 // The core variant cannot depend on the vendor variant because of the order of CreateVariations.
144 // Instead, the LLNDK implementation depends on the LLNDK header libs.
145 LlndkHeaderLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700146}
147
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500148// PathDeps is a struct containing file paths to dependencies of a module.
149// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
150// It's used to construct flags for various build statements (such as for compiling and linking).
151// It is then passed to module decorator functions responsible for registering build statements
152// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800153type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700154 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900155 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700156 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900157 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700158 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700159 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700160
Colin Cross0de8a1e2020-09-18 14:15:30 -0700161 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700162 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700163
Colin Cross26c34ed2016-09-30 17:10:16 -0700164 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100165 Objs Objects
166 // Paths to .o files in dependencies that provide them. Note that these lists
167 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800168 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700169 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700170
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100171 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
172 // the libs from all whole_static_lib dependencies.
173 WholeStaticLibsFromPrebuilts android.Paths
174
Colin Cross26c34ed2016-09-30 17:10:16 -0700175 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700176 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900177 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700178
Inseob Kimd110f872019-12-06 13:15:38 +0900179 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000180 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900181 IncludeDirs android.Paths
182 SystemIncludeDirs android.Paths
183 ReexportedDirs android.Paths
184 ReexportedSystemDirs android.Paths
185 ReexportedFlags []string
186 ReexportedGeneratedHeaders android.Paths
187 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700188
Colin Cross26c34ed2016-09-30 17:10:16 -0700189 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700190 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700191
Dan Willemsena0790e32018-10-12 00:24:23 -0700192 // Path to the dynamic linker binary
193 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700194
195 // For Darwin builds, the path to the second architecture's output that should
196 // be combined with this architectures's output into a FAT MachO file.
197 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400198
199 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
200 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800201
202 // LLNDK headers for the ABI checker to check LLNDK implementation library.
203 LlndkIncludeDirs android.Paths
204 LlndkSystemIncludeDirs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700205}
206
Colin Cross4af21ed2019-11-04 09:37:55 -0800207// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
208// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
209// command line so they can be overridden by the local module flags).
210type LocalOrGlobalFlags struct {
211 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700212 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800213 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700214 CFlags []string // Flags that apply to C and C++ source files
215 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
216 ConlyFlags []string // Flags that apply to C source files
217 CppFlags []string // Flags that apply to C++ source files
218 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700219 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800220}
221
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500222// Flags contains various types of command line flags (and settings) for use in building build
223// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800224type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500225 // Local flags (which individual modules are responsible for). These may override global flags.
226 Local LocalOrGlobalFlags
227 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700228 Global LocalOrGlobalFlags
229 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800230
231 aidlFlags []string // Flags that apply to aidl source files
232 rsFlags []string // Flags that apply to renderscript source files
233 libFlags []string // Flags to add libraries early to the link order
234 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
235 TidyFlags []string // Flags that apply to clang-tidy
236 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700237
Colin Crossc3199482017-03-30 15:03:04 -0700238 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800239 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700240 SystemIncludeFlags []string
241
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800242 Toolchain config.Toolchain
243 Tidy bool // True if ninja .tidy rules should be generated.
244 NeedTidyFiles bool // True if module link should depend on .tidy files
245 GcovCoverage bool // True if coverage files should be generated.
246 SAbiDump bool // True if header abi dumps should be generated.
247 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800248
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500249 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800250 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500251 // The target-device system path to the dynamic linker.
252 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800253
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700254 CFlagsDeps android.Paths // Files depended on by compiler flags
255 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800256
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500257 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700258 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800259
Colin Cross19878da2019-03-28 14:45:07 -0700260 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700261 protoC bool // Whether to use C instead of C++
262 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700263
264 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200265 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700266}
267
Colin Crossca860ac2016-01-04 14:34:37 -0800268// Properties used to compile all C or C++ modules
269type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700270 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800271 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700272
Jiyong Parkb35a8192020-08-10 15:59:36 +0900273 // The API level that this module is built against. The APIs of this API level will be
274 // visible at build time, but use of any APIs newer than min_sdk_version will render the
275 // module unloadable on older devices. In the future it will be possible to weakly-link new
276 // APIs, making the behavior match Java: such modules will load on older devices, but
277 // calling new APIs on devices that do not support them will result in a crash.
278 //
279 // This property has the same behavior as sdk_version does for Java modules. For those
280 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
281 // does for Java code.
282 //
283 // In addition, setting this property causes two variants to be built, one for the platform
284 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800285 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700286
Jiyong Parkb35a8192020-08-10 15:59:36 +0900287 // Minimum OS API level supported by this C or C++ module. This property becomes the value
288 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
289 // this property is also used to ensure that the min_sdk_version of the containing module is
290 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
291 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
292 // min_sdk_version of the containing APEX. When the module
293 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900294 Min_sdk_version *string
295
Colin Crossc511bc52020-04-07 16:50:32 +0000296 // If true, always create an sdk variant and don't create a platform variant.
297 Sdk_variant_only *bool
298
Jiyong Parkde866cb2018-12-07 23:08:36 +0900299 AndroidMkSharedLibs []string `blueprint:"mutated"`
300 AndroidMkStaticLibs []string `blueprint:"mutated"`
301 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
302 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700303 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900304 HideFromMake bool `blueprint:"mutated"`
305 PreventInstall bool `blueprint:"mutated"`
306 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700307
Yo Chiang219968c2020-09-22 18:45:04 +0800308 // Set by DepsMutator.
309 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
310
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900311 // The name of the image this module is built for
312 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200313
314 // The VNDK version this module is built against. If empty, the module is not
315 // build against the VNDK.
316 VndkVersion string `blueprint:"mutated"`
317
318 // Suffix for the name of Android.mk entries generated by this module
319 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800320
321 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
322 // file
323 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900324
Yifan Hong39143a92020-10-26 12:43:12 -0700325 // Make this module available when building for ramdisk.
326 // On device without a dedicated recovery partition, the module is only
327 // available after switching root into
328 // /first_stage_ramdisk. To expose the module before switching root, install
329 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800330 Ramdisk_available *bool
331
Yifan Hong39143a92020-10-26 12:43:12 -0700332 // Make this module available when building for vendor ramdisk.
333 // On device without a dedicated recovery partition, the module is only
334 // available after switching root into
335 // /first_stage_ramdisk. To expose the module before switching root, install
336 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700337 Vendor_ramdisk_available *bool
338
Jiyong Parkf9332f12018-02-01 00:54:12 +0900339 // Make this module available when building for recovery
340 Recovery_available *bool
341
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200342 // Used by imageMutator, set by ImageMutatorBegin()
343 CoreVariantNeeded bool `blueprint:"mutated"`
344 RamdiskVariantNeeded bool `blueprint:"mutated"`
345 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
346 RecoveryVariantNeeded bool `blueprint:"mutated"`
347
348 // A list of variations for the "image" mutator of the form
349 //<image name> '.' <version char>, for example, 'vendor.S'
350 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900351
352 // Allows this module to use non-APEX version of libraries. Useful
353 // for building binaries that are started before APEXes are activated.
354 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900355
356 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
357 // see soong/cc/config/vndk.go
358 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900359
360 // Used by vendor snapshot to record dependencies from snapshot modules.
361 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900362 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900363 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000364
Colin Cross1bc94122021-10-28 13:25:54 -0700365 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000366
367 // Set by factories of module types that can only be referenced from variants compiled against
368 // the SDK.
369 AlwaysSdk bool `blueprint:"mutated"`
370
371 // Variant is an SDK variant created by sdkMutator
372 IsSdkVariant bool `blueprint:"mutated"`
373 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
374 // variant to have a ".sdk" suffix.
375 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700376
377 // Normally Soong uses the directory structure to decide which modules
378 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800379 // different snapshots (vendor, recovery, etc.), but this property
380 // allows a partner to exclude a module normally thought of as a
381 // framework module from the vendor snapshot.
382 Exclude_from_vendor_snapshot *bool
383
384 // Normally Soong uses the directory structure to decide which modules
385 // should be included (framework) or excluded (non-framework) from the
386 // different snapshots (vendor, recovery, etc.), but this property
387 // allows a partner to exclude a module normally thought of as a
388 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800389 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900390
391 // List of APEXes that this module has private access to for testing purpose. The module
392 // can depend on libraries that are not exported by the APEXes and use private symbols
393 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000394 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800395
396 Target struct {
397 Platform struct {
398 // List of modules required by the core variant.
399 Required []string `android:"arch_variant"`
400
401 // List of modules not required by the core variant.
402 Exclude_required []string `android:"arch_variant"`
403 } `android:"arch_variant"`
404
405 Recovery struct {
406 // List of modules required by the recovery variant.
407 Required []string `android:"arch_variant"`
408
409 // List of modules not required by the recovery variant.
410 Exclude_required []string `android:"arch_variant"`
411 } `android:"arch_variant"`
412 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700413}
414
415type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900416 // whether this module should be allowed to be directly depended by other
417 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900418 // If set to true, two variants will be built separately, one like
419 // normal, and the other limited to the set of libraries and headers
420 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700421 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900422 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700423 // so it shouldn't have any unversioned runtime dependencies, or
424 // make assumptions about the system that may not be true in the
425 // future.
426 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900427 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900428 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900429 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900430 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900431 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700432 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
433 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900434
Justin Yunebcf0c52021-01-08 18:00:19 +0900435 // This is the same as the "vendor_available" except that the install path
436 // of the vendor variant is /odm or /vendor/odm.
437 // By replacing "vendor_available: true" with "odm_available: true", the
438 // module will install its vendor variant to the /odm partition or /vendor/odm.
439 // As the modules with "odm_available: true" still create the vendor variants,
440 // they can link to the other vendor modules as the vendor_available modules do.
441 // Also, the vendor modules can link to odm_available modules.
442 //
443 // It may not be used for VNDK modules.
444 Odm_available *bool
445
Justin Yun63e9ec72020-10-29 16:49:43 +0900446 // whether this module should be allowed to be directly depended by other
447 // modules with `product_specific: true` or `product_available: true`.
448 // If set to true, an additional product variant will be built separately
449 // that is limited to the set of libraries and headers that are exposed to
450 // /product modules.
451 //
452 // The product variant may be used with a different (newer) /system,
453 // so it shouldn't have any unversioned runtime dependencies, or
454 // make assumptions about the system that may not be true in the
455 // future.
456 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900457 // If set to false, this module becomes inaccessible from /product modules.
458 //
459 // Different from the 'vendor_available' property, the modules with
460 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
461 // library without 'product_available' may not be depended on by any other
462 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900463 //
464 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
465 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
466 Product_available *bool
467
Jiyong Park5fb8c102018-04-09 12:03:06 +0900468 // whether this module is capable of being loaded with other instance
469 // (possibly an older version) of the same module in the same process.
470 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
471 // can be double loaded in a vendor process if the library is also a
472 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
473 // explicitly marked as `double_loadable: true` by the owner, or the dependency
474 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
475 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800476
477 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
478 IsLLNDK bool `blueprint:"mutated"`
479
Colin Cross78212242021-01-06 14:51:30 -0800480 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
481 // set and the module is not listed in VndkMustUseVendorVariantList.
482 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
483
484 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
485 IsVNDKCore bool `blueprint:"mutated"`
486
487 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
488 IsVNDKSP bool `blueprint:"mutated"`
489
490 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
491 // module sets the llndk.private property.
492 IsVNDKPrivate bool `blueprint:"mutated"`
493
494 // IsVNDKProduct is set if a VNDK module sets the product_available property.
495 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700496
497 // IsVendorPublicLibrary is set for the core and product variants of a library that has
498 // vendor_public_library stubs.
499 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800500}
501
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500502// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
503// to understanding details about the type of the current module.
504// For example, one might call these functions to determine whether the current module is a static
505// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800506type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800507 static() bool
508 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700509 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800510 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900511 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900512 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900513 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700514 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900515 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700516 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800517 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900518 minSdkVersion() string
519 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700520 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700521 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800522 IsLlndk() bool
523 IsLlndkPublic() bool
524 isImplementationForLLNDKPublic() bool
525 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900526 isVndk() bool
527 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500528 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700529 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900530 inProduct() bool
531 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800532 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700533 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900534 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900535 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700536 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700537 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800538 getVndkExtendsModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800539 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000540 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800541 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900542 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800543 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800544 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800545 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700546 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700547 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900548 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800549 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700550 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700551 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800552 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800553 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800554 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800555 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800556}
557
558type SharedFlags struct {
559 numSharedFlags int
560 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800561}
562
563type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700564 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800565 ModuleContextIntf
566}
567
568type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700569 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800570 ModuleContextIntf
571}
572
Colin Cross37047f12016-12-13 17:06:13 -0800573type DepsContext interface {
574 android.BottomUpMutatorContext
575 ModuleContextIntf
576}
577
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500578// feature represents additional (optional) steps to building cc-related modules, such as invocation
579// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800580type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800581 flags(ctx ModuleContext, flags Flags) Flags
582 props() []interface{}
583}
584
Joe Onorato37f900c2023-07-18 16:58:16 -0700585// Information returned from Generator about the source code it's generating
586type GeneratedSource struct {
587 IncludeDirs android.Paths
588 Sources android.Paths
589 Headers android.Paths
590 ReexportedDirs android.Paths
591}
592
593// generator allows injection of generated code
594type Generator interface {
595 GeneratorProps() []interface{}
596 GeneratorInit(ctx BaseModuleContext)
597 GeneratorDeps(ctx DepsContext, deps Deps) Deps
598 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
599 GeneratorSources(ctx ModuleContext) GeneratedSource
600 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
601}
602
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500603// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500604// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800605type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700606 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800607 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800608 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700609 compilerProps() []interface{}
610
Colin Cross76fada02016-07-27 10:31:13 -0700611 appendCflags([]string)
612 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700613 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800614}
615
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500616// linker is the interface for a linker decorator object. Individual module types can provide
617// their own implementation for this decorator, and thus specify custom logic regarding build
618// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800619type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700620 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800621 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700622 linkerFlags(ctx ModuleContext, flags Flags) Flags
623 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800624 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700625
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700626 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700627 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900628 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800629 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700630
631 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900632 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000633
634 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000635 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800636
637 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000638}
639
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500640// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000641type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500642 sharedLibs []string
643 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
644 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700645 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800646}
647
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500648// installer is the interface for an installer helper object. This helper is responsible for
649// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800650type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700651 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700652 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000653 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800654 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700655 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700656 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900657 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000658 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900659 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800660}
661
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800662type xref interface {
663 XrefCcFiles() android.Paths
664}
665
Inseob Kima1888ce2022-10-04 14:42:02 +0900666type overridable interface {
667 overriddenModules() []string
668}
669
Colin Cross6e511a92020-07-27 21:26:48 -0700670type libraryDependencyKind int
671
672const (
673 headerLibraryDependency = iota
674 sharedLibraryDependency
675 staticLibraryDependency
676)
677
678func (k libraryDependencyKind) String() string {
679 switch k {
680 case headerLibraryDependency:
681 return "headerLibraryDependency"
682 case sharedLibraryDependency:
683 return "sharedLibraryDependency"
684 case staticLibraryDependency:
685 return "staticLibraryDependency"
686 default:
687 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
688 }
689}
690
691type libraryDependencyOrder int
692
693const (
694 earlyLibraryDependency = -1
695 normalLibraryDependency = 0
696 lateLibraryDependency = 1
697)
698
699func (o libraryDependencyOrder) String() string {
700 switch o {
701 case earlyLibraryDependency:
702 return "earlyLibraryDependency"
703 case normalLibraryDependency:
704 return "normalLibraryDependency"
705 case lateLibraryDependency:
706 return "lateLibraryDependency"
707 default:
708 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
709 }
710}
711
712// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
713// tags that have a set of predefined tag objects that are reused for each dependency, a
714// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
715// That means that comparing a libraryDependencyTag for equality will only be equal if all
716// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
717// then check individual metadata fields instead.
718type libraryDependencyTag struct {
719 blueprint.BaseDependencyTag
720
721 // These are exported so that fmt.Printf("%#v") can call their String methods.
722 Kind libraryDependencyKind
723 Order libraryDependencyOrder
724
725 wholeStatic bool
726
727 reexportFlags bool
728 explicitlyVersioned bool
729 dataLib bool
730 ndk bool
731
732 staticUnwinder bool
733
734 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900735
Cindy Zhou18417cb2020-12-10 07:12:38 -0800736 // Whether or not this dependency should skip the apex dependency check
737 skipApexAllowedDependenciesCheck bool
738
Jiyong Parke3867542020-12-03 17:28:25 +0900739 // Whether or not this dependency has to be followed for the apex variants
740 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900741 // Whether or not this dependency has to be followed for the non-apex variants
742 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000743
744 // If true, don't automatically export symbols from the static library into a shared library.
745 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700746}
747
748// header returns true if the libraryDependencyTag is tagging a header lib dependency.
749func (d libraryDependencyTag) header() bool {
750 return d.Kind == headerLibraryDependency
751}
752
753// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
754func (d libraryDependencyTag) shared() bool {
755 return d.Kind == sharedLibraryDependency
756}
757
758// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
759func (d libraryDependencyTag) static() bool {
760 return d.Kind == staticLibraryDependency
761}
762
Colin Cross65cb3142021-12-10 23:05:02 +0000763func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
764 if d.shared() {
765 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
766 }
767 return nil
768}
769
770var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
771
Colin Crosse9fe2942020-11-10 18:12:15 -0800772// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
773// binaries or other shared libraries are installed as dependencies.
774func (d libraryDependencyTag) InstallDepNeeded() bool {
775 return d.shared()
776}
777
778var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
779
Yu Liu67a28422024-03-05 00:36:31 +0000780func (d libraryDependencyTag) PropagateAconfigValidation() bool {
781 return d.static()
782}
783
784var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
785
Colin Crosse9fe2942020-11-10 18:12:15 -0800786// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700787// libraryDependencyTag. Each tag object is created globally and reused for multiple
788// dependencies (although since the object contains no references, assigning a tag to a
789// variable and modifying it will not modify the original). Users can compare the tag
790// returned by ctx.OtherModuleDependencyTag against the global original
791type dependencyTag struct {
792 blueprint.BaseDependencyTag
793 name string
794}
795
Colin Crosse9fe2942020-11-10 18:12:15 -0800796// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
797// libraryDependencyTag, but where the dependency needs to be installed when the parent is
798// installed.
799type installDependencyTag struct {
800 blueprint.BaseDependencyTag
801 android.InstallAlwaysNeededDependencyTag
802 name string
803}
804
Colin Crossc99deeb2016-04-11 15:06:20 -0700805var (
Colin Cross6e511a92020-07-27 21:26:48 -0700806 genSourceDepTag = dependencyTag{name: "gen source"}
807 genHeaderDepTag = dependencyTag{name: "gen header"}
808 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
809 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900810 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700811 reuseObjTag = dependencyTag{name: "reuse objects"}
812 staticVariantTag = dependencyTag{name: "static variant"}
813 vndkExtDepTag = dependencyTag{name: "vndk extends"}
814 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700815 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800816 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700817 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700818 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000819 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500820 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400821 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800822 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700823)
824
Roland Levillainf89cd092019-07-29 16:22:59 +0100825func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700826 ccLibDepTag, ok := depTag.(libraryDependencyTag)
827 return ok && ccLibDepTag.shared()
828}
829
830func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
831 ccLibDepTag, ok := depTag.(libraryDependencyTag)
832 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100833}
834
Zach Johnson3df4e632020-11-06 11:56:27 -0800835func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
836 ccLibDepTag, ok := depTag.(libraryDependencyTag)
837 return ok && ccLibDepTag.header()
838}
839
Roland Levillainf89cd092019-07-29 16:22:59 +0100840func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800841 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100842}
843
844func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700845 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100846 return ok && ccDepTag == testPerSrcDepTag
847}
848
Colin Crossca860ac2016-01-04 14:34:37 -0800849// Module contains the properties and members used by all C/C++ module types, and implements
850// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500851// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
852// interface.
853//
854// To define a C/C++ related module, construct a new Module object and point its delegates to
855// type-specific structs. These delegates will be invoked to register module-specific build
856// statements which may be unique to the module type. For example, module.compiler.compile() should
857// be defined so as to register build statements which are responsible for compiling the module.
858//
859// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
860// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
861// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
862// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800863type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700864 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700865
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700866 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700867 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700868
Colin Crossca860ac2016-01-04 14:34:37 -0800869 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000870 hod android.HostOrDeviceSupported
871 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000872 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700873
Paul Duffina0843f62019-12-13 19:50:38 +0000874 // Allowable SdkMemberTypes of this module type.
875 sdkMemberTypes []android.SdkMemberType
876
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500877 // decorator delegates, initialize before calling Init
878 // these may contain module-specific implementations, and effectively allow for custom
879 // type-specific logic. These members may reference different objects or the same object.
880 // Functions of these decorators will be invoked to initialize and register type-specific
881 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800882 generators []Generator
883 compiler compiler
884 linker linker
885 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500886
Spandan Dase12d2522023-09-12 21:42:31 +0000887 features []feature
888 stl *stl
889 sanitize *sanitize
890 coverage *coverage
891 fuzzer *fuzzer
892 sabi *sabi
893 vndkdep *vndkdep
894 lto *lto
895 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000896 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800897
Colin Cross31076b32020-10-23 17:22:06 -0700898 library libraryInterface
899
Colin Cross635c3b02016-05-18 15:37:25 -0700900 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800901
Colin Crossb98c8b02016-07-29 13:44:28 -0700902 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700903
904 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800905
906 // Flags used to compile this module
907 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700908
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800909 // Shared flags among build rules of this module
910 sharedFlags SharedFlags
911
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800912 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700913 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900914
915 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800916 // Kythe (source file indexer) paths for this compilation module
917 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700918 // Object .o file output paths for this compilation module
919 objFiles android.Paths
920 // Tidy .tidy file output paths for this compilation module
921 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900922
923 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700924 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700925
926 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800927
928 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800929 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700930}
931
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200932func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400933 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
934 if b, ok := c.compiler.(*baseCompiler); ok {
935 hasAidl = b.hasSrcExt(".aidl")
936 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
937 hasProto = b.hasSrcExt(".proto")
938 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
939 hasSysprop = b.hasSrcExt(".sysprop")
940 hasWinMsg = b.hasSrcExt(".mc")
941 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
942 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200943 c.AndroidModuleBase().AddJSONData(d)
944 (*d)["Cc"] = map[string]interface{}{
945 "SdkVersion": c.SdkVersion(),
946 "MinSdkVersion": c.MinSdkVersion(),
947 "VndkVersion": c.VndkVersion(),
948 "ProductSpecific": c.ProductSpecific(),
949 "SocSpecific": c.SocSpecific(),
950 "DeviceSpecific": c.DeviceSpecific(),
951 "InProduct": c.InProduct(),
952 "InVendor": c.InVendor(),
953 "InRamdisk": c.InRamdisk(),
954 "InVendorRamdisk": c.InVendorRamdisk(),
955 "InRecovery": c.InRecovery(),
956 "VendorAvailable": c.VendorAvailable(),
957 "ProductAvailable": c.ProductAvailable(),
958 "RamdiskAvailable": c.RamdiskAvailable(),
959 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
960 "RecoveryAvailable": c.RecoveryAvailable(),
961 "OdmAvailable": c.OdmAvailable(),
962 "InstallInData": c.InstallInData(),
963 "InstallInRamdisk": c.InstallInRamdisk(),
964 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
965 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
966 "InstallInRecovery": c.InstallInRecovery(),
967 "InstallInRoot": c.InstallInRoot(),
968 "IsVndk": c.IsVndk(),
969 "IsVndkExt": c.IsVndkExt(),
970 "IsVndkPrivate": c.IsVndkPrivate(),
971 "IsVndkSp": c.IsVndkSp(),
972 "IsLlndk": c.IsLlndk(),
973 "IsLlndkPublic": c.IsLlndkPublic(),
974 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
975 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
976 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
977 "ApexSdkVersion": c.apexSdkVersion,
978 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400979 "AidlSrcs": hasAidl,
980 "LexSrcs": hasLex,
981 "ProtoSrcs": hasProto,
982 "RenderscriptSrcs": hasRenderscript,
983 "SyspropSrcs": hasSysprop,
984 "WinMsgSrcs": hasWinMsg,
985 "YaccSrsc": hasYacc,
986 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200987 }
988}
989
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500990func (c *Module) SetPreventInstall() {
991 c.Properties.PreventInstall = true
992}
993
994func (c *Module) SetHideFromMake() {
995 c.Properties.HideFromMake = true
996}
997
Ivan Lozanod7586b62021-04-01 09:49:36 -0400998func (c *Module) HiddenFromMake() bool {
999 return c.Properties.HideFromMake
1000}
1001
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +08001002func (c *Module) RequiredModuleNames() []string {
1003 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
1004 if c.ImageVariation().Variation == android.CoreVariation {
1005 required = append(required, c.Properties.Target.Platform.Required...)
1006 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
1007 } else if c.InRecovery() {
1008 required = append(required, c.Properties.Target.Recovery.Required...)
1009 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
1010 }
1011 return android.FirstUniqueStrings(required)
1012}
1013
Ivan Lozano52767be2019-10-18 14:49:46 -07001014func (c *Module) Toc() android.OptionalPath {
1015 if c.linker != nil {
1016 if library, ok := c.linker.(libraryInterface); ok {
1017 return library.toc()
1018 }
1019 }
1020 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1021}
1022
1023func (c *Module) ApiLevel() string {
1024 if c.linker != nil {
1025 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001026 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001027 }
1028 }
1029 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1030}
1031
1032func (c *Module) Static() bool {
1033 if c.linker != nil {
1034 if library, ok := c.linker.(libraryInterface); ok {
1035 return library.static()
1036 }
1037 }
1038 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1039}
1040
1041func (c *Module) Shared() bool {
1042 if c.linker != nil {
1043 if library, ok := c.linker.(libraryInterface); ok {
1044 return library.shared()
1045 }
1046 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001047
Ivan Lozano52767be2019-10-18 14:49:46 -07001048 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1049}
1050
1051func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001052 if c.stl != nil {
1053 return c.stl.Properties.SelectedStl
1054 }
1055 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001056}
1057
Ivan Lozano52767be2019-10-18 14:49:46 -07001058func (c *Module) NdkPrebuiltStl() bool {
1059 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1060 return true
1061 }
1062 return false
1063}
1064
1065func (c *Module) StubDecorator() bool {
1066 if _, ok := c.linker.(*stubDecorator); ok {
1067 return true
1068 }
1069 return false
1070}
1071
1072func (c *Module) SdkVersion() string {
1073 return String(c.Properties.Sdk_version)
1074}
1075
Artur Satayev480e25b2020-04-27 18:53:18 +01001076func (c *Module) MinSdkVersion() string {
1077 return String(c.Properties.Min_sdk_version)
1078}
1079
Jiyong Park5df7bd32021-08-25 16:18:46 +09001080func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001081 if linker, ok := c.linker.(*objectLinker); ok {
1082 return linker.isCrt()
1083 }
1084 return false
1085}
1086
Jiyong Park5df7bd32021-08-25 16:18:46 +09001087func (c *Module) SplitPerApiLevel() bool {
1088 return c.canUseSdk() && c.isCrt()
1089}
1090
Colin Crossc511bc52020-04-07 16:50:32 +00001091func (c *Module) AlwaysSdk() bool {
1092 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1093}
1094
Ivan Lozano183a3212019-10-18 14:18:45 -07001095func (c *Module) CcLibrary() bool {
1096 if c.linker != nil {
1097 if _, ok := c.linker.(*libraryDecorator); ok {
1098 return true
1099 }
Colin Crossd48fe732020-09-23 20:37:24 -07001100 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1101 return true
1102 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001103 }
1104 return false
1105}
1106
1107func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001108 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001109 return true
1110 }
1111 return false
1112}
1113
Spandan Dase12d2522023-09-12 21:42:31 +00001114func (c *Module) IsNdkPrebuiltStl() bool {
1115 if c.linker == nil {
1116 return false
1117 }
1118 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1119 return true
1120 }
1121 return false
1122}
1123
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001124func (c *Module) RlibStd() bool {
1125 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1126}
1127
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001128func (c *Module) RustLibraryInterface() bool {
1129 return false
1130}
1131
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001132func (c *Module) IsFuzzModule() bool {
1133 if _, ok := c.compiler.(*fuzzBinary); ok {
1134 return true
1135 }
1136 return false
1137}
1138
1139func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1140 return c.FuzzModule
1141}
1142
1143func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1144 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1145 return fuzzer.fuzzPackagedModule
1146 }
1147 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1148}
1149
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001150func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001151 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1152 return fuzzer.sharedLibraries
1153 }
1154 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1155}
1156
Ivan Lozano2b262972019-11-21 12:30:50 -08001157func (c *Module) NonCcVariants() bool {
1158 return false
1159}
1160
Ivan Lozano183a3212019-10-18 14:18:45 -07001161func (c *Module) SetStatic() {
1162 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001163 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001164 library.setStatic()
1165 return
1166 }
1167 }
1168 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1169}
1170
1171func (c *Module) SetShared() {
1172 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001173 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001174 library.setShared()
1175 return
1176 }
1177 }
1178 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1179}
1180
1181func (c *Module) BuildStaticVariant() bool {
1182 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001183 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001184 return library.buildStatic()
1185 }
1186 }
1187 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1188}
1189
1190func (c *Module) BuildSharedVariant() bool {
1191 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001192 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001193 return library.buildShared()
1194 }
1195 }
1196 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1197}
1198
1199func (c *Module) Module() android.Module {
1200 return c
1201}
1202
Jiyong Parkc20eee32018-09-05 22:36:17 +09001203func (c *Module) OutputFile() android.OptionalPath {
1204 return c.outputFile
1205}
1206
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001207func (c *Module) CoverageFiles() android.Paths {
1208 if c.linker != nil {
1209 if library, ok := c.linker.(libraryInterface); ok {
1210 return library.objs().coverageFiles
1211 }
1212 }
1213 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1214}
1215
Ivan Lozano183a3212019-10-18 14:18:45 -07001216var _ LinkableInterface = (*Module)(nil)
1217
Jiyong Park719b4462019-01-13 00:39:51 +09001218func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001219 if c.linker != nil {
1220 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001221 }
1222 return nil
1223}
1224
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001225func (c *Module) CoverageOutputFile() android.OptionalPath {
1226 if c.linker != nil {
1227 return c.linker.coverageOutputFilePath()
1228 }
1229 return android.OptionalPath{}
1230}
1231
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001232func (c *Module) RelativeInstallPath() string {
1233 if c.installer != nil {
1234 return c.installer.relativeInstallPath()
1235 }
1236 return ""
1237}
1238
Jooyung Han344d5432019-08-23 11:17:39 +09001239func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001240 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001241}
1242
Colin Cross36242852017-06-23 15:06:31 -07001243func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001244 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001245 for _, generator := range c.generators {
1246 c.AddProperties(generator.GeneratorProps()...)
1247 }
Colin Crossca860ac2016-01-04 14:34:37 -08001248 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001249 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001250 }
1251 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001252 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001253 }
1254 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001255 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001256 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001257 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001258 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001259 }
Colin Cross16b23492016-01-06 14:41:07 -08001260 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001261 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001262 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001263 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001264 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001265 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001266 if c.fuzzer != nil {
1267 c.AddProperties(c.fuzzer.props()...)
1268 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001269 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001270 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001271 }
Justin Yun8effde42017-06-23 19:24:43 +09001272 if c.vndkdep != nil {
1273 c.AddProperties(c.vndkdep.props()...)
1274 }
Stephen Craneba090d12017-05-09 15:44:35 -07001275 if c.lto != nil {
1276 c.AddProperties(c.lto.props()...)
1277 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001278 if c.afdo != nil {
1279 c.AddProperties(c.afdo.props()...)
1280 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001281 if c.orderfile != nil {
1282 c.AddProperties(c.orderfile.props()...)
1283 }
Colin Crossca860ac2016-01-04 14:34:37 -08001284 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001285 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001286 }
Colin Crossc472d572015-03-17 15:06:21 -07001287
Colin Cross36242852017-06-23 15:06:31 -07001288 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001289 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001290 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001291
Colin Cross36242852017-06-23 15:06:31 -07001292 return c
Colin Crossc472d572015-03-17 15:06:21 -07001293}
1294
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001295// UseVndk() returns true if this module is built against VNDK.
1296// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001297func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001298 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001299}
1300
Colin Crossc511bc52020-04-07 16:50:32 +00001301func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001302 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001303 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001304}
1305
1306func (c *Module) UseSdk() bool {
1307 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001308 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001309 }
1310 return false
1311}
1312
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001313func (c *Module) isCoverageVariant() bool {
1314 return c.coverage.Properties.IsCoverageVariant
1315}
1316
Colin Cross95f1ca02020-10-29 20:47:22 -07001317func (c *Module) IsNdk(config android.Config) bool {
1318 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001319}
1320
Colin Cross127bb8b2020-12-16 16:46:01 -08001321func (c *Module) IsLlndk() bool {
1322 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001323}
1324
Colin Cross127bb8b2020-12-16 16:46:01 -08001325func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001326 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001327}
1328
Colin Cross1f3f1302021-04-26 18:37:44 -07001329func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001330 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001331 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001332}
1333
Colin Cross5271fea2021-04-27 13:06:04 -07001334func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1335 lib := moduleLibraryInterface(m)
1336 return lib != nil && (lib.hasVendorPublicLibrary())
1337}
1338
1339// IsVendorPublicLibrary returns true for vendor public libraries.
1340func (c *Module) IsVendorPublicLibrary() bool {
1341 return c.VendorProperties.IsVendorPublicLibrary
1342}
1343
Ivan Lozanof1868af2022-04-12 13:08:36 -04001344func (c *Module) IsVndkPrebuiltLibrary() bool {
1345 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1346 return true
1347 }
1348 return false
1349}
1350
1351func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1352 return c.Properties.SdkAndPlatformVariantVisibleToMake
1353}
1354
Ivan Lozanod7586b62021-04-01 09:49:36 -04001355func (c *Module) HasLlndkStubs() bool {
1356 lib := moduleLibraryInterface(c)
1357 return lib != nil && lib.hasLLNDKStubs()
1358}
1359
1360func (c *Module) StubsVersion() string {
1361 if lib, ok := c.linker.(versionedInterface); ok {
1362 return lib.stubsVersion()
1363 }
1364 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1365}
1366
Colin Cross127bb8b2020-12-16 16:46:01 -08001367// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1368// and does not set llndk.vendor_available: false.
1369func (c *Module) isImplementationForLLNDKPublic() bool {
1370 library, _ := c.library.(*libraryDecorator)
1371 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001372 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001373}
1374
Justin Yunfd9e8042020-12-23 18:23:14 +09001375// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001376func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001377 // Check if VNDK-core-private or VNDK-SP-private
1378 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001379 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001380 }
1381
1382 // Check if LLNDK-private
1383 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001384 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001385 }
1386
1387 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001388}
1389
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001390// IsVndk() returns true if this module has a vndk variant.
1391// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1392// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001393func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001394 if vndkdep := c.vndkdep; vndkdep != nil {
1395 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001396 }
1397 return false
1398}
1399
Colin Cross3513fb12024-01-24 14:44:47 -08001400func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001401 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001402 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001403 }
1404 return false
1405}
1406
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001407func (c *Module) isOrderfileCompile() bool {
1408 if orderfile := c.orderfile; orderfile != nil {
1409 return orderfile.Properties.OrderfileLoad
1410 }
1411 return false
1412}
1413
Yi Kongc702ebd2022-08-19 16:02:45 +08001414func (c *Module) isCfi() bool {
1415 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001416 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001417 }
1418 return false
1419}
1420
Yi Konged79fa32023-06-04 17:15:42 +09001421func (c *Module) isFuzzer() bool {
1422 if sanitize := c.sanitize; sanitize != nil {
1423 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1424 }
1425 return false
1426}
1427
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001428func (c *Module) isNDKStubLibrary() bool {
1429 if _, ok := c.compiler.(*stubDecorator); ok {
1430 return true
1431 }
1432 return false
1433}
1434
Ivan Lozanod7586b62021-04-01 09:49:36 -04001435func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001436 if vndkdep := c.vndkdep; vndkdep != nil {
1437 return vndkdep.isVndkSp()
1438 }
1439 return false
1440}
1441
Ivan Lozanof9e21722020-12-02 09:00:51 -05001442func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001443 if vndkdep := c.vndkdep; vndkdep != nil {
1444 return vndkdep.isVndkExt()
1445 }
1446 return false
1447}
1448
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001449func (c *Module) SubName() string {
1450 return c.Properties.SubName
1451}
1452
Ivan Lozano52767be2019-10-18 14:49:46 -07001453func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001454 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001455}
1456
Logan Chienf3511742017-10-31 18:04:35 +08001457func (c *Module) getVndkExtendsModuleName() string {
1458 if vndkdep := c.vndkdep; vndkdep != nil {
1459 return vndkdep.getVndkExtendsModuleName()
1460 }
1461 return ""
1462}
1463
Jiyong Park25fc6a92018-11-18 18:02:45 +09001464func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001465 if lib := c.library; lib != nil {
1466 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001467 }
1468 return false
1469}
1470
1471func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001472 if lib := c.library; lib != nil {
1473 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001474 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001475 return false
1476}
1477
Alan Stokes73feba32022-11-14 12:21:24 +00001478func (c *Module) IsStubsImplementationRequired() bool {
1479 if lib := c.library; lib != nil {
1480 return lib.isStubsImplementationRequired()
1481 }
1482 return false
1483}
1484
Colin Cross0477b422020-10-13 18:43:54 -07001485// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1486// the implementation. If it is an implementation library it returns its own name.
1487func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1488 name := ctx.OtherModuleName(c)
1489 if versioned, ok := c.linker.(versionedInterface); ok {
1490 name = versioned.implementationModuleName(name)
1491 }
1492 return name
1493}
1494
Martin Stjernholm2856c662020-12-02 15:03:42 +00001495// Similar to ImplementationModuleName, but uses the Make variant of the module
1496// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1497// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1498// under the premise that the prebuilt module overrides its source counterpart
1499// if it is exposed to Make).
1500func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1501 name := c.BaseModuleName()
1502 if versioned, ok := c.linker.(versionedInterface); ok {
1503 name = versioned.implementationModuleName(name)
1504 }
1505 return name
1506}
1507
Jiyong Park7d55b612021-06-11 17:22:09 +09001508func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001509 return Bool(c.Properties.Bootstrap)
1510}
1511
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001512func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001513 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1514 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1515 return false
1516 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001517 return c.linker != nil && c.linker.nativeCoverage()
1518}
1519
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001520func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001521 if p, ok := c.linker.(SnapshotInterface); ok {
1522 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001523 }
1524 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001525}
1526
Bill Peckham945441c2020-08-31 16:07:58 -07001527func (c *Module) ExcludeFromVendorSnapshot() bool {
1528 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1529}
1530
Jose Galmesf7294582020-11-13 12:07:36 -08001531func (c *Module) ExcludeFromRecoverySnapshot() bool {
1532 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1533}
1534
Jiyong Parkf1194352019-02-25 11:05:47 +09001535func isBionic(name string) bool {
1536 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001537 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001538 return true
1539 }
1540 return false
1541}
1542
Martin Stjernholm279de572019-09-10 23:18:20 +01001543func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001544 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001545 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001546 }
1547 return isBionic(name)
1548}
1549
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001550func (c *Module) XrefCcFiles() android.Paths {
1551 return c.kytheFiles
1552}
1553
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001554func (c *Module) isCfiAssemblySupportEnabled() bool {
1555 return c.sanitize != nil &&
1556 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1557}
1558
Inseob Kim800d1142021-06-14 12:03:51 +09001559func (c *Module) InstallInRoot() bool {
1560 return c.installer != nil && c.installer.installInRoot()
1561}
1562
Colin Crossca860ac2016-01-04 14:34:37 -08001563type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001564 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001565 moduleContextImpl
1566}
1567
Colin Cross37047f12016-12-13 17:06:13 -08001568type depsContext struct {
1569 android.BottomUpMutatorContext
1570 moduleContextImpl
1571}
1572
Colin Crossca860ac2016-01-04 14:34:37 -08001573type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001574 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001575 moduleContextImpl
1576}
1577
1578type moduleContextImpl struct {
1579 mod *Module
1580 ctx BaseModuleContext
1581}
1582
Colin Crossb98c8b02016-07-29 13:44:28 -07001583func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001584 return ctx.mod.toolchain(ctx.ctx)
1585}
1586
1587func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001588 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001589}
1590
1591func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001592 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001593}
1594
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001595func (ctx *moduleContextImpl) testBinary() bool {
1596 return ctx.mod.testBinary()
1597}
1598
Yi Kong56fc1b62022-09-06 16:24:00 +08001599func (ctx *moduleContextImpl) testLibrary() bool {
1600 return ctx.mod.testLibrary()
1601}
1602
Jiyong Park1d1119f2019-07-29 21:27:18 +09001603func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001604 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001605}
1606
Inseob Kim7f283f42020-06-01 21:53:49 +09001607func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001608 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001609}
1610
Inseob Kim1042d292020-06-01 23:23:05 +09001611func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001612 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001613}
1614
Jooyung Hanccce2f22020-03-07 03:45:53 +09001615func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001616 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001617}
1618
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001619func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001620 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001621}
1622
1623func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001624 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001625 config := ctx.ctx.Config()
1626 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001627 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001628 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001629 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001630 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001631 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001632 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001633 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001634 }
1635 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001636}
1637
Jiyong Parkb35a8192020-08-10 15:59:36 +09001638func (ctx *moduleContextImpl) minSdkVersion() string {
1639 ver := ctx.mod.MinSdkVersion()
1640 if ver == "apex_inherit" && !ctx.isForPlatform() {
1641 ver = ctx.apexSdkVersion().String()
1642 }
1643 if ver == "apex_inherit" || ver == "" {
1644 ver = ctx.sdkVersion()
1645 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001646
1647 if ctx.ctx.Device() {
1648 config := ctx.ctx.Config()
1649 if config.IsVndkDeprecated() && ctx.inVendor() {
1650 // If building for vendor with final API, then use the latest _stable_ API as "current".
1651 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1652 ver = config.PlatformSdkVersion().String()
1653 }
1654 }
1655 }
1656
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001657 // For crt objects, the meaning of min_sdk_version is very different from other types of
1658 // module. For them, min_sdk_version defines the oldest version that the build system will
1659 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1660 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1661 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001662 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1663 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1664 // support such an old version. The version is set to the later version in case when the
1665 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1666 // it's for an APEX.
1667 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1668 if ctx.isForPlatform() {
1669 ver = strconv.Itoa(android.FutureApiLevelInt)
1670 } else { // for apex
1671 ver = ctx.apexSdkVersion().String()
1672 if ver == "" { // in case when min_sdk_version was not set by the APEX
1673 ver = ctx.sdkVersion()
1674 }
1675 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001676 }
1677
Jiyong Parkb35a8192020-08-10 15:59:36 +09001678 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1679 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1680 minSdkVersionInt, err2 := strconv.Atoi(ver)
1681 if err == nil && err2 == nil {
1682 if sdkVersionInt < minSdkVersionInt {
1683 return strconv.Itoa(sdkVersionInt)
1684 }
1685 }
1686 return ver
1687}
1688
1689func (ctx *moduleContextImpl) isSdkVariant() bool {
1690 return ctx.mod.IsSdkVariant()
1691}
1692
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001693func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001694 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001695}
Justin Yun8effde42017-06-23 19:24:43 +09001696
Kiyoung Kimaa394802024-01-08 12:55:45 +09001697func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1698 return ctx.mod.InVendorOrProduct()
1699}
1700
Colin Cross95f1ca02020-10-29 20:47:22 -07001701func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1702 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001703}
1704
Colin Cross127bb8b2020-12-16 16:46:01 -08001705func (ctx *moduleContextImpl) IsLlndk() bool {
1706 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001707}
1708
Colin Cross127bb8b2020-12-16 16:46:01 -08001709func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1710 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001711}
1712
Colin Cross127bb8b2020-12-16 16:46:01 -08001713func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1714 return ctx.mod.isImplementationForLLNDKPublic()
1715}
1716
1717func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1718 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001719}
1720
Logan Chienf3511742017-10-31 18:04:35 +08001721func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001722 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001723}
1724
Colin Cross3513fb12024-01-24 14:44:47 -08001725func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1726 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001727}
1728
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001729func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1730 return ctx.mod.isOrderfileCompile()
1731}
1732
Yi Kongc702ebd2022-08-19 16:02:45 +08001733func (ctx *moduleContextImpl) isCfi() bool {
1734 return ctx.mod.isCfi()
1735}
1736
Yi Konged79fa32023-06-04 17:15:42 +09001737func (ctx *moduleContextImpl) isFuzzer() bool {
1738 return ctx.mod.isFuzzer()
1739}
1740
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001741func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1742 return ctx.mod.isNDKStubLibrary()
1743}
1744
Justin Yun8effde42017-06-23 19:24:43 +09001745func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001746 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001747}
1748
Ivan Lozanof9e21722020-12-02 09:00:51 -05001749func (ctx *moduleContextImpl) IsVndkExt() bool {
1750 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001751}
1752
Colin Cross5271fea2021-04-27 13:06:04 -07001753func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1754 return ctx.mod.IsVendorPublicLibrary()
1755}
1756
Vic Yangefd249e2018-11-12 20:19:56 -08001757func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001758 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001759}
1760
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001761func (ctx *moduleContextImpl) selectedStl() string {
1762 if stl := ctx.mod.stl; stl != nil {
1763 return stl.Properties.SelectedStl
1764 }
1765 return ""
1766}
1767
Ivan Lozanobd721262018-11-27 14:33:03 -08001768func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1769 return ctx.mod.linker.useClangLld(actx)
1770}
1771
Colin Crossce75d2c2016-10-06 16:12:58 -07001772func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001773 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001774}
1775
Logan Chienf3511742017-10-31 18:04:35 +08001776func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1777 return ctx.mod.getVndkExtendsModuleName()
1778}
1779
Logan Chiene274fc92019-12-03 11:18:32 -08001780func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001781 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1782 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001783}
1784
Colin Crosse07f2312020-08-13 11:24:56 -07001785func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001786 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1787 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001788}
1789
Dan Albertc8060532020-07-22 22:32:17 -07001790func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001791 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001792}
1793
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001794func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001795 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001796}
1797
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001798func (ctx *moduleContextImpl) nativeCoverage() bool {
1799 return ctx.mod.nativeCoverage()
1800}
1801
Colin Cross56a83212020-09-15 18:30:11 -07001802func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1803 return ctx.mod.DirectlyInAnyApex()
1804}
1805
Colin Cross95b07f22020-12-16 11:06:50 -08001806func (ctx *moduleContextImpl) isPreventInstall() bool {
1807 return ctx.mod.Properties.PreventInstall
1808}
1809
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001810func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1811 shared := &ctx.mod.sharedFlags
1812 if shared.flagsMap == nil {
1813 shared.numSharedFlags = 0
1814 shared.flagsMap = make(map[string]string)
1815 }
1816 return shared
1817}
1818
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001819func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1820 return ctx.mod.isCfiAssemblySupportEnabled()
1821}
1822
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001823func (ctx *moduleContextImpl) notInPlatform() bool {
1824 return ctx.mod.NotInPlatform()
1825}
1826
Colin Cross635c3b02016-05-18 15:37:25 -07001827func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001828 return &Module{
1829 hod: hod,
1830 multilib: multilib,
1831 }
1832}
1833
Colin Cross635c3b02016-05-18 15:37:25 -07001834func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001835 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001836 module.features = []feature{
1837 &tidyFeature{},
1838 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001839 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001840 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001841 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001842 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001843 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001844 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001845 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001846 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001847 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001848 return module
1849}
1850
Colin Crossce75d2c2016-10-06 16:12:58 -07001851func (c *Module) Prebuilt() *android.Prebuilt {
1852 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1853 return p.prebuilt()
1854 }
1855 return nil
1856}
1857
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001858func (c *Module) IsPrebuilt() bool {
1859 return c.Prebuilt() != nil
1860}
1861
Colin Crossce75d2c2016-10-06 16:12:58 -07001862func (c *Module) Name() string {
1863 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001864 if p, ok := c.linker.(interface {
1865 Name(string) string
1866 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001867 name = p.Name(name)
1868 }
1869 return name
1870}
1871
Alex Light3d673592019-01-18 14:37:31 -08001872func (c *Module) Symlinks() []string {
1873 if p, ok := c.installer.(interface {
1874 symlinkList() []string
1875 }); ok {
1876 return p.symlinkList()
1877 }
1878 return nil
1879}
1880
Roland Levillainf89cd092019-07-29 16:22:59 +01001881func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1882 test, ok := c.linker.(testPerSrc)
1883 return ok && test.isAllTestsVariation()
1884}
1885
Chris Parsons216e10a2020-07-09 17:12:52 -04001886func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001887 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001888 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001889 }); ok {
1890 return p.dataPaths()
1891 }
1892 return nil
1893}
1894
Ivan Lozanof1868af2022-04-12 13:08:36 -04001895func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001896 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1897 // "current", it will append the VNDK version to the name suffix.
1898 var vndkVersion string
1899 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001900 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001901 if c.ProductSpecific() {
1902 // If the module is product specific with 'product_specific: true',
1903 // do not add a name suffix because it is a base module.
1904 return ""
1905 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001906 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001907 } else {
1908 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001909 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001910 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001911 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001912 // add version suffix only if the module is using different vndk version than the
1913 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001914 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001915 }
1916 return nameSuffix
1917}
1918
Ivan Lozanof1868af2022-04-12 13:08:36 -04001919func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1920 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001921
1922 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001923 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001924 }
1925
Colin Cross127bb8b2020-12-16 16:46:01 -08001926 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001927 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001928 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1929 // added for product variant only when we have vendor and product variants with core
1930 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001931 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001932 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001933 subName += vendorPublicLibrarySuffix
1934 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001935 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1936 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001937 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001938 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001939 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001940 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001941 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001942 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001943 subName += RecoverySuffix
1944 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1945 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001946 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001947 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001948 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001949 } else if c.IsStubs() && c.IsSdkVariant() {
1950 // Public API surface (NDK)
1951 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1952 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001953 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001954
1955 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001956}
1957
Sam Delmerico75dbca22023-04-20 13:13:25 +00001958func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1959 ctx := &moduleContext{
1960 ModuleContext: actx,
1961 moduleContextImpl: moduleContextImpl{
1962 mod: c,
1963 },
1964 }
1965 ctx.ctx = ctx
1966 return ctx
1967}
1968
Spandan Das20fce2d2023-04-12 17:21:39 +00001969// TODO (b/277651159): Remove this allowlist
1970var (
1971 skipStubLibraryMultipleApexViolation = map[string]bool{
1972 "libclang_rt.asan": true,
1973 "libclang_rt.hwasan": true,
1974 // runtime apex
1975 "libc": true,
1976 "libc_hwasan": true,
1977 "libdl_android": true,
1978 "libm": true,
1979 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001980 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001981 // art apex
1982 "libandroidio": true,
1983 "libdexfile": true,
1984 "libnativebridge": true,
1985 "libnativehelper": true,
1986 "libnativeloader": true,
1987 "libsigchain": true,
1988 }
1989)
1990
1991// Returns true if a stub library could be installed in multiple apexes
1992func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1993 // If this is not an apex variant, no check necessary
1994 if !c.InAnyApex() {
1995 return false
1996 }
1997 // If this is not a stub library, no check necessary
1998 if !c.HasStubsVariants() {
1999 return false
2000 }
2001 // Skip the allowlist
2002 // Use BaseModuleName so that this matches prebuilts.
2003 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
2004 return false
2005 }
2006
2007 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
2008 // Stub libraries should not have more than one apex_available
2009 if len(aaWithoutTestApexes) > 1 {
2010 return true
2011 }
2012 // Stub libraries should not use the wildcard
2013 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2014 return true
2015 }
2016 // Default: no violation
2017 return false
2018}
2019
LaMont Jonesafe7baf2024-01-09 22:47:39 +00002020func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2021 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
2022}
2023
Chris Parsons8d6e4332021-02-22 16:13:50 -05002024func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05002025 // Handle the case of a test module split by `test_per_src` mutator.
2026 //
2027 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2028 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2029 // module and return early, as this module does not produce an output file per se.
2030 if c.IsTestPerSrcAllTestsVariation() {
2031 c.outputFile = android.OptionalPath{}
2032 return
2033 }
2034
Ivan Lozanof1868af2022-04-12 13:08:36 -04002035 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002036 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002037 if !apexInfo.IsForPlatform() {
2038 c.hideApexVariantFromMake = true
2039 }
2040
Chris Parsonseefc9e62021-04-02 17:36:47 -04002041 c.makeLinkType = GetMakeLinkType(actx, c)
2042
Sam Delmerico75dbca22023-04-20 13:13:25 +00002043 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002044
Colin Crossf18e1102017-11-16 14:33:08 -08002045 deps := c.depsToPaths(ctx)
2046 if ctx.Failed() {
2047 return
2048 }
2049
Joe Onorato37f900c2023-07-18 16:58:16 -07002050 for _, generator := range c.generators {
2051 gen := generator.GeneratorSources(ctx)
2052 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2053 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2054 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2055 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2056 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2057 if len(deps.Objs.objFiles) == 0 {
2058 // If we are reusuing object files (which happens when we're a shared library and we're
2059 // reusing our static variant's object files), then skip adding the actual source files,
2060 // because we already have the object for it.
2061 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2062 }
2063 }
2064
2065 if ctx.Failed() {
2066 return
2067 }
2068
Spandan Das20fce2d2023-04-12 17:21:39 +00002069 if c.stubLibraryMultipleApexViolation(actx) {
2070 actx.PropertyErrorf("apex_available",
2071 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2072 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002073 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2074 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002075 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2076 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002077 }
2078
Colin Crossca860ac2016-01-04 14:34:37 -08002079 flags := Flags{
2080 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002081 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002082 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002083 for _, generator := range c.generators {
2084 flags = generator.GeneratorFlags(ctx, flags, deps)
2085 }
Colin Crossca860ac2016-01-04 14:34:37 -08002086 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002087 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002088 }
2089 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002090 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002091 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002092 if c.stl != nil {
2093 flags = c.stl.flags(ctx, flags)
2094 }
Colin Cross16b23492016-01-06 14:41:07 -08002095 if c.sanitize != nil {
2096 flags = c.sanitize.flags(ctx, flags)
2097 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002098 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002099 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002100 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002101 if c.fuzzer != nil {
2102 flags = c.fuzzer.flags(ctx, flags)
2103 }
Stephen Craneba090d12017-05-09 15:44:35 -07002104 if c.lto != nil {
2105 flags = c.lto.flags(ctx, flags)
2106 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002107 if c.afdo != nil {
2108 flags = c.afdo.flags(ctx, flags)
2109 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002110 if c.orderfile != nil {
2111 flags = c.orderfile.flags(ctx, flags)
2112 }
Colin Crossca860ac2016-01-04 14:34:37 -08002113 for _, feature := range c.features {
2114 flags = feature.flags(ctx, flags)
2115 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002116 if ctx.Failed() {
2117 return
2118 }
2119
Colin Cross4af21ed2019-11-04 09:37:55 -08002120 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2121 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2122 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002123
Colin Cross4af21ed2019-11-04 09:37:55 -08002124 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002125
2126 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002127 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002128 }
2129 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002130 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002131 }
2132
Colin Cross3e5e7782022-06-17 22:17:05 +00002133 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2134
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002135 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002136 // We need access to all the flags seen by a source file.
2137 if c.sabi != nil {
2138 flags = c.sabi.flags(ctx, flags)
2139 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002140
Colin Cross4af21ed2019-11-04 09:37:55 -08002141 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002142
Joe Onorato37f900c2023-07-18 16:58:16 -07002143 for _, generator := range c.generators {
2144 generator.GeneratorBuildActions(ctx, flags, deps)
2145 }
2146
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002147 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002148 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002149 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002150 if ctx.Failed() {
2151 return
2152 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002153 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002154 c.objFiles = objs.objFiles
2155 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002156 }
2157
Colin Crossca860ac2016-01-04 14:34:37 -08002158 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002159 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002160 if ctx.Failed() {
2161 return
2162 }
Colin Cross635c3b02016-05-18 15:37:25 -07002163 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002164
Chris Parsons94a0bba2021-06-04 15:03:47 -04002165 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002166
Jose Galmes6f843bc2020-12-11 13:36:29 -08002167 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2168 // RECOVERY_SNAPSHOT_VERSION is current.
2169 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002170 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002171 i.collectHeadersForSnapshot(ctx)
2172 }
2173 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002174 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002175 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002176 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002177 }
Colin Cross40213022023-12-13 15:19:49 -08002178 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002179
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002180 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002181
Chris Parsons94a0bba2021-06-04 15:03:47 -04002182 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002183
2184 if c.linker != nil {
2185 moduleInfoJSON := ctx.ModuleInfoJSON()
2186 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2187 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2188 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2189 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2190 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2191
2192 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2193 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2194 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2195 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2196
2197 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2198 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2199 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2200 moduleInfoJSON.SubName += ".cfi"
2201 }
2202 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2203 moduleInfoJSON.SubName += ".hwasan"
2204 }
2205 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2206 moduleInfoJSON.SubName += ".scs"
2207 }
2208 }
2209 moduleInfoJSON.SubName += c.Properties.SubName
2210
2211 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2212 moduleInfoJSON.Uninstallable = true
2213 }
2214
2215 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002216}
2217
2218func (c *Module) maybeUnhideFromMake() {
2219 // If a lib is directly included in any of the APEXes or is not available to the
2220 // platform (which is often the case when the stub is provided as a prebuilt),
2221 // unhide the stubs variant having the latest version gets visible to make. In
2222 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2223 // force anything in the make world to link against the stubs library. (unless it
2224 // is explicitly referenced via .bootstrap suffix or the module is marked with
2225 // 'bootstrap: true').
2226 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002227 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002228 c.IsStubs() && !c.InVendorRamdisk() {
2229 c.Properties.HideFromMake = false // unhide
2230 // Note: this is still non-installable
2231 }
2232}
2233
Colin Cross8ff10582023-12-07 13:10:56 -08002234// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2235// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002236func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002237 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002238 // If the module has been specifically configure to not be installed then
2239 // hide from make as otherwise it will break when running inside make
2240 // as the output path to install will not be specified. Not all uninstallable
2241 // modules can be hidden from make as some are needed for resolving make side
2242 // dependencies.
2243 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002244 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002245 c.SkipInstall()
2246 }
2247
2248 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2249 // to allow using the outputs in a genrule.
2250 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002251 c.installer.install(ctx, c.outputFile.Path())
2252 if ctx.Failed() {
2253 return
Colin Crossca860ac2016-01-04 14:34:37 -08002254 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002255 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002256}
2257
Colin Cross0ea8ba82019-06-06 14:33:29 -07002258func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002259 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002260 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002261 }
Colin Crossca860ac2016-01-04 14:34:37 -08002262 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002263}
2264
Colin Crossca860ac2016-01-04 14:34:37 -08002265func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002266 for _, generator := range c.generators {
2267 generator.GeneratorInit(ctx)
2268 }
Colin Crossca860ac2016-01-04 14:34:37 -08002269 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002270 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002271 }
Colin Crossca860ac2016-01-04 14:34:37 -08002272 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002273 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002274 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002275 if c.stl != nil {
2276 c.stl.begin(ctx)
2277 }
Colin Cross16b23492016-01-06 14:41:07 -08002278 if c.sanitize != nil {
2279 c.sanitize.begin(ctx)
2280 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002281 if c.coverage != nil {
2282 c.coverage.begin(ctx)
2283 }
Yi Kong9723e332023-12-04 14:52:53 +09002284 if c.afdo != nil {
2285 c.afdo.begin(ctx)
2286 }
Stephen Craneba090d12017-05-09 15:44:35 -07002287 if c.lto != nil {
2288 c.lto.begin(ctx)
2289 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002290 if c.orderfile != nil {
2291 c.orderfile.begin(ctx)
2292 }
Dan Albert92fe7402020-07-15 13:33:30 -07002293 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002294 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002295 if err != nil {
2296 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002297 c.Properties.Sdk_version = nil
2298 } else {
2299 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002300 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002301 }
Colin Crossca860ac2016-01-04 14:34:37 -08002302}
2303
Colin Cross37047f12016-12-13 17:06:13 -08002304func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002305 deps := Deps{}
2306
Joe Onorato37f900c2023-07-18 16:58:16 -07002307 for _, generator := range c.generators {
2308 deps = generator.GeneratorDeps(ctx, deps)
2309 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002310 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002311 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002312 }
2313 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002314 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002315 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002316 if c.stl != nil {
2317 deps = c.stl.deps(ctx, deps)
2318 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002319 if c.coverage != nil {
2320 deps = c.coverage.deps(ctx, deps)
2321 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002322
Colin Crossb6715442017-10-24 11:13:31 -07002323 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2324 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2325 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2326 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2327 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2328 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002329 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002330 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002331
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002332 for _, lib := range deps.ReexportSharedLibHeaders {
2333 if !inList(lib, deps.SharedLibs) {
2334 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2335 }
2336 }
2337
2338 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002339 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2340 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 -07002341 }
2342 }
2343
Colin Cross5950f382016-12-13 12:50:57 -08002344 for _, lib := range deps.ReexportHeaderLibHeaders {
2345 if !inList(lib, deps.HeaderLibs) {
2346 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2347 }
2348 }
2349
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002350 for _, gen := range deps.ReexportGeneratedHeaders {
2351 if !inList(gen, deps.GeneratedHeaders) {
2352 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2353 }
2354 }
2355
Colin Crossc99deeb2016-04-11 15:06:20 -07002356 return deps
2357}
2358
Dan Albert7e9d2952016-08-04 13:02:36 -07002359func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002360 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002361 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002362 moduleContextImpl: moduleContextImpl{
2363 mod: c,
2364 },
2365 }
2366 ctx.ctx = ctx
2367
Colin Crossca860ac2016-01-04 14:34:37 -08002368 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002369}
2370
Jiyong Park7ed9de32018-10-15 22:25:07 +09002371// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002372func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002373 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2374 version := name[sharp+1:]
2375 libname := name[:sharp]
2376 return libname, version
2377 }
2378 return name, ""
2379}
2380
Dan Albert92fe7402020-07-15 13:33:30 -07002381func GetCrtVariations(ctx android.BottomUpMutatorContext,
2382 m LinkableInterface) []blueprint.Variation {
2383 if ctx.Os() != android.Android {
2384 return nil
2385 }
2386 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002387 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2388 minSdkVersion := m.MinSdkVersion()
2389 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2390 minSdkVersion = m.SdkVersion()
2391 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002392 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2393 if err != nil {
2394 ctx.PropertyErrorf("min_sdk_version", err.Error())
2395 }
Colin Cross363ec762023-01-13 13:45:14 -08002396
2397 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002398 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002399 if apiLevel.LessThan(minApiForArch) {
2400 apiLevel = minApiForArch
2401 }
2402
Dan Albert92fe7402020-07-15 13:33:30 -07002403 return []blueprint.Variation{
2404 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002405 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002406 }
2407 }
2408 return []blueprint.Variation{
2409 {Mutator: "sdk", Variation: ""},
2410 }
2411}
2412
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002413func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2414 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002415
2416 variations = append([]blueprint.Variation(nil), variations...)
2417
Liz Kammer23942242022-04-08 15:41:00 -04002418 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002419 // Version is explicitly specified. i.e. libFoo#30
2420 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002421 if tag, ok := depTag.(libraryDependencyTag); ok {
2422 tag.explicitlyVersioned = true
2423 } else {
2424 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2425 }
Colin Crosse7257d22020-09-24 09:56:18 -07002426 }
Colin Crosse7257d22020-09-24 09:56:18 -07002427
Colin Cross0de8a1e2020-09-18 14:15:30 -07002428 if far {
2429 ctx.AddFarVariationDependencies(variations, depTag, name)
2430 } else {
2431 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002432 }
2433}
2434
Kiyoung Kim487689e2022-07-26 09:48:22 +09002435func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2436 apiImportInfo := multitree.ApiImportInfo{}
2437
2438 if c.Device() {
2439 var apiImportModule []blueprint.Module
2440 if actx.OtherModuleExists("api_imports") {
2441 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2442 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002443 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002444 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002445 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002446 }
2447 }
2448 }
2449
2450 return apiImportInfo
2451}
2452
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002453func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002454 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002455 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002456 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002457 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2458 // between the modules in the snapshot and the snapshot itself.
2459 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002460 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002461 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002462 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002463 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2464 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002465 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002466 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002467 *snapshotInfo = &snapshot
2468 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002469 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002470 }
2471 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002472 if *snapshotInfo == nil {
2473 *snapshotInfo = &SnapshotInfo{}
2474 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002475 return **snapshotInfo
2476}
2477
Kiyoung Kim487689e2022-07-26 09:48:22 +09002478func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2479 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002480 return snapshot
2481 }
2482
2483 return lib
2484}
2485
2486// RewriteLibs takes a list of names of shared libraries and scans it for three types
2487// of names:
2488//
2489// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002490//
2491// For each of these, it adds the name of the prebuilt module (which will be in
2492// prebuilts/ndk) to the list of nonvariant libs.
2493//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002494// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002495//
2496// For each of these, it adds the name of the ndk_library module to the list of
2497// variant libs.
2498//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002499// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002500//
2501// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002502//
2503// The caller can then know to add the variantLibs dependencies differently from the
2504// nonvariantLibs
2505func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2506 variantLibs = []string{}
2507
2508 nonvariantLibs = []string{}
2509 for _, entry := range list {
2510 // strip #version suffix out
2511 name, _ := StubsLibNameAndVersion(entry)
2512 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002513 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002514 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2515 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2516 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002517 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002518 } else {
2519 // put name#version back
2520 nonvariantLibs = append(nonvariantLibs, entry)
2521 }
2522 }
2523 return nonvariantLibs, variantLibs
2524}
2525
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002526func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2527 nonVariantLibs := []string{}
2528 variantLibs := []string{}
2529
2530 for _, lib := range libs {
2531 replaceLibName := GetReplaceModuleName(lib, replaceList)
2532 if replaceLibName == lib {
2533 // Do not handle any libs which are not in API imports
2534 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2535 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2536 variantLibs = append(variantLibs, replaceLibName)
2537 } else {
2538 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2539 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002540 }
2541
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002542 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002543}
2544
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002545func (c *Module) shouldUseApiSurface() bool {
2546 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2547 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2548 // LLNDK Variant
2549 return true
2550 }
2551
2552 if c.Properties.IsSdkVariant {
2553 // NDK Variant
2554 return true
2555 }
2556
2557 if c.isImportedApiLibrary() {
2558 // API Library should depend on API headers
2559 return true
2560 }
2561 }
2562
2563 return false
2564}
2565
Colin Cross1e676be2016-10-12 14:38:15 -07002566func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002567 if !c.Enabled() {
2568 return
2569 }
2570
Colin Cross37047f12016-12-13 17:06:13 -08002571 ctx := &depsContext{
2572 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002573 moduleContextImpl: moduleContextImpl{
2574 mod: c,
2575 },
2576 }
2577 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002578
Colin Crossc99deeb2016-04-11 15:06:20 -07002579 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002580 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002581
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002582 apiNdkLibs := []string{}
2583 apiLateNdkLibs := []string{}
2584
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002585 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002586 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2587 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2588 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2589 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2590 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002591 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002592
Yo Chiang219968c2020-09-22 18:45:04 +08002593 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2594
Colin Crosse0edaf92021-01-11 17:31:17 -08002595 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002596
Dan Albert914449f2016-06-17 16:45:24 -07002597 variantNdkLibs := []string{}
2598 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002599 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002600 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2601 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2602 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002603
2604 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002605 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002606 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002607 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002608
Colin Cross32ec36c2016-12-15 07:39:51 -08002609 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002610 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002611 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002612 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002613 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002614
Kiyoung Kim51279d32022-08-24 14:10:46 +09002615 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002616 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002617 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2618 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002619 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002620
Spandan Das73bcafc2022-08-18 23:26:00 +00002621 if c.isNDKStubLibrary() {
2622 // ndk_headers do not have any variations
2623 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002624 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002625 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002626 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002627 } else {
2628 actx.AddVariationDependencies(nil, depTag, lib)
2629 }
2630 }
2631
Dan Albertf1d14c72020-07-30 14:32:55 -07002632 if c.isNDKStubLibrary() {
2633 // NDK stubs depend on their implementation because the ABI dumps are
2634 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002635
Spandan Das8b08aea2023-03-14 19:29:34 +00002636 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2637 c.ImageVariation(),
2638 blueprint.Variation{Mutator: "link", Variation: "shared"},
2639 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002640 }
2641
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002642 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2643 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2644 c.Target().NativeBridge == android.NativeBridgeDisabled {
2645 actx.AddVariationDependencies(
2646 []blueprint.Variation{{Mutator: "image", Variation: VendorVariation}},
2647 llndkHeaderLibTag,
2648 deps.LlndkHeaderLibs...)
2649 }
2650
Jiyong Park5d1598f2019-02-25 22:14:17 +09002651 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002652 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002653
Kiyoung Kim487689e2022-07-26 09:48:22 +09002654 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002655
Jiyong Park5d1598f2019-02-25 22:14:17 +09002656 actx.AddVariationDependencies([]blueprint.Variation{
2657 {Mutator: "link", Variation: "static"},
2658 }, depTag, lib)
2659 }
2660
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002661 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002662 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002663 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002664 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002665 }
Jiyong Parke3867542020-12-03 17:28:25 +09002666 if inList(lib, deps.ExcludeLibsForApex) {
2667 depTag.excludeInApex = true
2668 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002669
Kiyoung Kim487689e2022-07-26 09:48:22 +09002670 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002671
Dan Willemsen59339a22018-07-22 21:18:45 -07002672 actx.AddVariationDependencies([]blueprint.Variation{
2673 {Mutator: "link", Variation: "static"},
2674 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002675 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002676
Jooyung Han75568392020-03-20 04:29:24 +09002677 // staticUnwinderDep is treated as staticDep for Q apexes
2678 // so that native libraries/binaries are linked with static unwinder
2679 // because Q libc doesn't have unwinder APIs
2680 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002681 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002682 actx.AddVariationDependencies([]blueprint.Variation{
2683 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002684 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002685 }
2686
Jiyong Park7ed9de32018-10-15 22:25:07 +09002687 // shared lib names without the #version suffix
2688 var sharedLibNames []string
2689
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002690 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002691 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002692 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002693 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002694 }
Jiyong Parke3867542020-12-03 17:28:25 +09002695 if inList(lib, deps.ExcludeLibsForApex) {
2696 depTag.excludeInApex = true
2697 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002698 if inList(lib, deps.ExcludeLibsForNonApex) {
2699 depTag.excludeInNonApex = true
2700 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002701
Jiyong Park73c54ee2019-10-22 20:31:18 +09002702 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002703 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2704 name = apiLibraryName
2705 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002706 sharedLibNames = append(sharedLibNames, name)
2707
Colin Crosse7257d22020-09-24 09:56:18 -07002708 variations := []blueprint.Variation{
2709 {Mutator: "link", Variation: "shared"},
2710 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002711
2712 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2713 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2714 }
2715
2716 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2717 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2718 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002719 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002720
Colin Crossfe9acfe2021-06-14 16:13:03 -07002721 for _, lib := range deps.LateStaticLibs {
2722 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2723 actx.AddVariationDependencies([]blueprint.Variation{
2724 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002725 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002726 }
2727
Colin Cross3e5e7782022-06-17 22:17:05 +00002728 for _, lib := range deps.UnexportedStaticLibs {
2729 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2730 actx.AddVariationDependencies([]blueprint.Variation{
2731 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002732 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002733 }
2734
Jiyong Park7ed9de32018-10-15 22:25:07 +09002735 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002736 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002737 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2738 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2739 // linking against both the stubs lib and the non-stubs lib at the same time.
2740 continue
2741 }
Colin Cross6e511a92020-07-27 21:26:48 -07002742 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002743 variations := []blueprint.Variation{
2744 {Mutator: "link", Variation: "shared"},
2745 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002746 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002747 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002748
Dan Willemsen59339a22018-07-22 21:18:45 -07002749 actx.AddVariationDependencies([]blueprint.Variation{
2750 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002751 }, dataLibDepTag, deps.DataLibs...)
2752
Colin Crossc8caa062021-09-24 16:50:14 -07002753 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2754
Chris Parsons79d66a52020-06-05 17:26:16 -04002755 actx.AddVariationDependencies([]blueprint.Variation{
2756 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002757 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002758
Colin Cross68861832016-07-08 10:41:41 -07002759 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002760
2761 for _, gen := range deps.GeneratedHeaders {
2762 depTag := genHeaderDepTag
2763 if inList(gen, deps.ReexportGeneratedHeaders) {
2764 depTag = genHeaderExportDepTag
2765 }
2766 actx.AddDependency(c, depTag, gen)
2767 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002768
Dan Albert92fe7402020-07-15 13:33:30 -07002769 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002770 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002771 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002772 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002773 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002774 }
Colin Crossc465efd2021-06-11 18:00:04 -07002775 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002776 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002777 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002778 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002779 if deps.DynamicLinker != "" {
2780 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002781 }
Dan Albert914449f2016-06-17 16:45:24 -07002782
2783 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002784
2785 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002786 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002787 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002788 {Mutator: "link", Variation: "shared"},
2789 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002790 actx.AddVariationDependencies([]blueprint.Variation{
2791 {Mutator: "version", Variation: version},
2792 {Mutator: "link", Variation: "shared"},
2793 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002794
2795 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002796 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002797 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002798 {Mutator: "link", Variation: "shared"},
2799 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002800 actx.AddVariationDependencies([]blueprint.Variation{
2801 {Mutator: "version", Variation: version},
2802 {Mutator: "link", Variation: "shared"},
2803 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002804
2805 if vndkdep := c.vndkdep; vndkdep != nil {
2806 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002807 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002808 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002809 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002810 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002811 }
2812 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002813
Vinh Tran367d89d2023-04-28 11:21:25 -04002814 if len(deps.AidlLibs) > 0 {
2815 actx.AddDependency(
2816 c,
2817 aidlLibraryTag,
2818 deps.AidlLibs...,
2819 )
2820 }
2821
Kiyoung Kimee58c932022-10-25 22:59:41 +09002822 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002823}
Colin Cross21b9a242015-03-24 14:15:58 -07002824
Colin Crosse40b4ea2018-10-02 22:25:58 -07002825func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002826 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2827 c.beginMutator(ctx)
2828 }
2829}
2830
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002831// Whether a module can link to another module, taking into
2832// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002833func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002834 tag blueprint.DependencyTag) {
2835
2836 switch t := tag.(type) {
2837 case dependencyTag:
2838 if t != vndkExtDepTag {
2839 return
2840 }
2841 case libraryDependencyTag:
2842 default:
2843 return
2844 }
2845
Ivan Lozanof9e21722020-12-02 09:00:51 -05002846 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002847 // Host code is not restricted
2848 return
2849 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002850
2851 // VNDK is cc.Module supported only for now.
2852 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002853 // Though allowed dependency is limited by the image mutator,
2854 // each vendor and product module needs to check link-type
2855 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002856 if ccTo, ok := to.(*Module); ok {
2857 if ccFrom.vndkdep != nil {
2858 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2859 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002860 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002861 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002862 }
2863 return
2864 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002865 // TODO(b/244244438) : Remove this once all variants are implemented
2866 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2867 return
2868 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002869 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002870 // Platform code can link to anything
2871 return
2872 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002873 if from.InRamdisk() {
2874 // Ramdisk code is not NDK
2875 return
2876 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002877 if from.InVendorRamdisk() {
2878 // Vendor ramdisk code is not NDK
2879 return
2880 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002881 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002882 // Recovery code is not NDK
2883 return
2884 }
Colin Cross31076b32020-10-23 17:22:06 -07002885 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002886 if c.NdkPrebuiltStl() {
2887 // These are allowed, but they don't set sdk_version
2888 return
2889 }
2890 if c.StubDecorator() {
2891 // These aren't real libraries, but are the stub shared libraries that are included in
2892 // the NDK.
2893 return
2894 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002895 if c.isImportedApiLibrary() {
2896 // Imported library from the API surface is a stub library built against interface definition.
2897 return
2898 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002899 }
Logan Chien834b9a62019-01-14 15:39:03 +08002900
Ivan Lozano52767be2019-10-18 14:49:46 -07002901 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002902 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2903 // to link to libc++ (non-NDK and without sdk_version).
2904 return
2905 }
2906
Ivan Lozano52767be2019-10-18 14:49:46 -07002907 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002908 // NDK code linking to platform code is never okay.
2909 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002910 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002911 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002912 }
2913
2914 // At this point we know we have two NDK libraries, but we need to
2915 // check that we're not linking against anything built against a higher
2916 // API level, as it is only valid to link against older or equivalent
2917 // APIs.
2918
Inseob Kim01a28722018-04-11 09:48:45 +09002919 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002920 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002921 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002922 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002923 // Current can't be linked against by anything else.
2924 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002925 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002926 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002927 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002928 if err != nil {
2929 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002930 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002931 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002932 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002933 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002934 if err != nil {
2935 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002936 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002937 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002938 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002939
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002940 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002941 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002942 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002943 }
2944 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002945 }
Dan Albert202fe492017-12-15 13:56:59 -08002946
2947 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002948 fromStl := from.SelectedStl()
2949 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002950 if fromStl == "" || toStl == "" {
2951 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002952 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002953 // We can be permissive with the system "STL" since it is only the C++
2954 // ABI layer, but in the future we should make sure that everyone is
2955 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002956 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002957 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002958 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2959 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002960 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002961}
2962
Jooyung Han479ca172020-10-19 18:51:07 +09002963func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2964 if c, ok := ctx.Module().(*Module); ok {
2965 ctx.VisitDirectDeps(func(dep android.Module) {
2966 depTag := ctx.OtherModuleDependencyTag(dep)
2967 ccDep, ok := dep.(LinkableInterface)
2968 if ok {
2969 checkLinkType(ctx, c, ccDep, depTag)
2970 }
2971 })
2972 }
2973}
2974
Jiyong Park5fb8c102018-04-09 12:03:06 +09002975// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002976// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2977// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002978// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002979func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2980 check := func(child, parent android.Module) bool {
2981 to, ok := child.(*Module)
2982 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002983 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002984 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002985
Jooyung Hana70f0672019-01-18 15:20:43 +09002986 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2987 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002988 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002989
Jiyong Park0474e1f2021-01-14 14:26:06 +09002990 // These dependencies are not excercised at runtime. Tracking these will give us
2991 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002992 depTag := ctx.OtherModuleDependencyTag(child)
2993 if IsHeaderDepTag(depTag) {
2994 return false
2995 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002996 if depTag == staticVariantTag {
2997 return false
2998 }
2999 if depTag == stubImplDepTag {
3000 return false
3001 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003002 if depTag == android.RequiredDepTag {
3003 return false
3004 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003005
Justin Yun63e9ec72020-10-29 16:49:43 +09003006 // Even if target lib has no vendor variant, keep checking dependency
3007 // graph in case it depends on vendor_available or product_available
3008 // but not double_loadable transtively.
3009 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003010 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003011 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003012
Jiyong Park0474e1f2021-01-14 14:26:06 +09003013 // The happy path. Keep tracking dependencies until we hit a non double-loadable
3014 // one.
3015 if Bool(to.VendorProperties.Double_loadable) {
3016 return true
3017 }
3018
Ivan Lozanod7586b62021-04-01 09:49:36 -04003019 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003020 return false
3021 }
3022
Jooyung Hana70f0672019-01-18 15:20:43 +09003023 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3024 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003025 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003026 return false
3027 }
3028 if module, ok := ctx.Module().(*Module); ok {
3029 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003030 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003031 ctx.WalkDeps(check)
3032 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003033 }
3034 }
3035}
3036
Yu Liue4312402023-01-18 09:15:31 -08003037func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3038 // For the dependency from platform to apex, use the latest stubs
3039 apexSdkVersion := android.FutureApiLevel
3040 if !apexInfo.IsForPlatform() {
3041 apexSdkVersion = apexInfo.MinSdkVersion
3042 }
3043
3044 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3045 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3046 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3047 // (b/144430859)
3048 apexSdkVersion = android.FutureApiLevel
3049 }
3050
3051 return apexSdkVersion
3052}
3053
Colin Crossc99deeb2016-04-11 15:06:20 -07003054// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003055func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003056 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003057
Colin Cross0de8a1e2020-09-18 14:15:30 -07003058 var directStaticDeps []StaticLibraryInfo
3059 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003060
Colin Cross0de8a1e2020-09-18 14:15:30 -07003061 reexportExporter := func(exporter FlagExporterInfo) {
3062 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3063 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3064 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3065 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3066 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003067 }
3068
Colin Crossff694a82023-12-13 15:54:49 -08003069 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003070 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003071
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003072 skipModuleList := map[string]bool{}
3073
3074 var apiImportInfo multitree.ApiImportInfo
3075 hasApiImportInfo := false
3076
3077 ctx.VisitDirectDeps(func(dep android.Module) {
3078 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003079 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003080 hasApiImportInfo = true
3081 }
3082 })
3083
3084 if hasApiImportInfo {
3085 targetStubModuleList := map[string]string{}
3086 targetOrigModuleList := map[string]string{}
3087
3088 // Search for dependency which both original module and API imported library with APEX stub exists
3089 ctx.VisitDirectDeps(func(dep android.Module) {
3090 depName := ctx.OtherModuleName(dep)
3091 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3092 targetStubModuleList[apiLibrary] = depName
3093 }
3094 })
3095 ctx.VisitDirectDeps(func(dep android.Module) {
3096 depName := ctx.OtherModuleName(dep)
3097 if origLibrary, ok := targetStubModuleList[depName]; ok {
3098 targetOrigModuleList[origLibrary] = depName
3099 }
3100 })
3101
3102 // Decide which library should be used between original and API imported library
3103 ctx.VisitDirectDeps(func(dep android.Module) {
3104 depName := ctx.OtherModuleName(dep)
3105 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003106 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003107 skipModuleList[depName] = true
3108 } else {
3109 skipModuleList[apiLibrary] = true
3110 }
3111 }
3112 })
3113 }
3114
Colin Crossd11fcda2017-10-23 17:59:01 -07003115 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003116 depName := ctx.OtherModuleName(dep)
3117 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003118
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003119 if _, ok := skipModuleList[depName]; ok {
3120 // skip this module because original module or API imported module matching with this should be used instead.
3121 return
3122 }
3123
Dan Willemsen47450072021-10-19 20:24:49 -07003124 if depTag == android.DarwinUniversalVariantTag {
3125 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3126 return
3127 }
3128
Vinh Tran367d89d2023-04-28 11:21:25 -04003129 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003130 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003131 depPaths.AidlLibraryInfos = append(
3132 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003133 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003134 )
3135 }
3136 }
3137
Ivan Lozano52767be2019-10-18 14:49:46 -07003138 ccDep, ok := dep.(LinkableInterface)
3139 if !ok {
3140
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003141 // handling for a few module types that aren't cc Module but that are also supported
3142 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003143 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003144 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003145 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3146 genRule.GeneratedSourceFiles()...)
3147 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003148 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003149 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003150 // Support exported headers from a generated_sources dependency
3151 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003152 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003153 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003154 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003155 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003156 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003157 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003158 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003159 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003160 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3161 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003162 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003163 // 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 +09003164 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003165
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003166 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003167 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003168 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003169 }
Colin Crosscef792e2021-06-11 18:01:26 -07003170 case CrtBeginDepTag:
3171 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3172 case CrtEndDepTag:
3173 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003174 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003175 return
3176 }
3177
Colin Crossfe17f6f2019-03-28 19:30:56 -07003178 if depTag == android.ProtoPluginDepTag {
3179 return
3180 }
3181
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003182 if depTag == android.RequiredDepTag {
3183 return
3184 }
3185
Colin Crossd11fcda2017-10-23 17:59:01 -07003186 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003187 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3188 return
3189 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003190 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003191 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3192 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003193 return
3194 }
3195
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003196 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003197 // Skip reused objects for stub libraries, they use their own stub object file instead.
3198 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3199 // version mutator, so the stubs variant is created from the shared variant that
3200 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003201 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003202 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003203 objs := staticAnalogue.ReuseObjects
3204 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003205 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003206 reexportExporter(depExporterInfo)
3207 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003208 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003209 }
3210
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003211 if depTag == llndkHeaderLibTag {
3212 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3213 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3214 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3215 }
3216
Colin Cross6e511a92020-07-27 21:26:48 -07003217 linkFile := ccDep.OutputFile()
3218
3219 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3220 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003221 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003222 return
3223 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003224
Jiyong Parke3867542020-12-03 17:28:25 +09003225 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3226 return
3227 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003228 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3229 return
3230 }
Jiyong Parke3867542020-12-03 17:28:25 +09003231
Colin Cross313aa542023-12-13 13:47:44 -08003232 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003233
Colin Cross6e511a92020-07-27 21:26:48 -07003234 var ptr *android.Paths
3235 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003236
Colin Cross6e511a92020-07-27 21:26:48 -07003237 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003238
Colin Cross6e511a92020-07-27 21:26:48 -07003239 switch {
3240 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003241 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003242 if !ctx.Config().AllowMissingDependencies() {
3243 ctx.ModuleErrorf("module %q is not a header library", depName)
3244 } else {
3245 ctx.AddMissingDependencies([]string{depName})
3246 }
3247 return
3248 }
Colin Cross6e511a92020-07-27 21:26:48 -07003249 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003250 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003251 if !ctx.Config().AllowMissingDependencies() {
3252 ctx.ModuleErrorf("module %q is not a shared library", depName)
3253 } else {
3254 ctx.AddMissingDependencies([]string{depName})
3255 }
3256 return
3257 }
Jiyong Parke3867542020-12-03 17:28:25 +09003258
Jiyong Park7d55b612021-06-11 17:22:09 +09003259 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3260 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003261
Jiyong Park1ad8e162020-12-01 23:40:09 +09003262 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3263 // linkFile, depFile, and ptr.
3264 if c.IsStubs() {
3265 break
3266 }
3267
Colin Cross0de8a1e2020-09-18 14:15:30 -07003268 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3269 depFile = sharedLibraryInfo.TableOfContents
3270
Colin Cross6e511a92020-07-27 21:26:48 -07003271 ptr = &depPaths.SharedLibs
3272 switch libDepTag.Order {
3273 case earlyLibraryDependency:
3274 ptr = &depPaths.EarlySharedLibs
3275 depPtr = &depPaths.EarlySharedLibsDeps
3276 case normalLibraryDependency:
3277 ptr = &depPaths.SharedLibs
3278 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003279 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003280 case lateLibraryDependency:
3281 ptr = &depPaths.LateSharedLibs
3282 depPtr = &depPaths.LateSharedLibsDeps
3283 default:
3284 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003285 }
Colin Cross6e511a92020-07-27 21:26:48 -07003286 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003287 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3288 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003289 if !ctx.Config().AllowMissingDependencies() {
3290 ctx.ModuleErrorf("module %q is not a static library", depName)
3291 } else {
3292 ctx.AddMissingDependencies([]string{depName})
3293 }
3294 return
3295 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003296
3297 // Stubs lib doesn't link to the static lib dependencies. Don't set
3298 // linkFile, depFile, and ptr.
3299 if c.IsStubs() {
3300 break
3301 }
3302
Colin Cross0de8a1e2020-09-18 14:15:30 -07003303 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003304 if libDepTag.wholeStatic {
3305 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003306 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3307 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003308 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003309 // This case normally catches prebuilt static
3310 // libraries, but it can also occur when
3311 // AllowMissingDependencies is on and the
3312 // dependencies has no sources of its own
3313 // but has a whole_static_libs dependency
3314 // on a missing library. We want to depend
3315 // on the .a file so that there is something
3316 // in the dependency tree that contains the
3317 // error rule for the missing transitive
3318 // dependency.
3319 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003320 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003321 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3322 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003323 } else {
3324 switch libDepTag.Order {
3325 case earlyLibraryDependency:
3326 panic(fmt.Errorf("early static libs not suppported"))
3327 case normalLibraryDependency:
3328 // static dependencies will be handled separately so they can be ordered
3329 // using transitive dependencies.
3330 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003331 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003332 case lateLibraryDependency:
3333 ptr = &depPaths.LateStaticLibs
3334 default:
3335 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003336 }
3337 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003338 if libDepTag.unexportedSymbols {
3339 depPaths.LdFlags = append(depPaths.LdFlags,
3340 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3341 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003342 }
3343
Colin Cross6e511a92020-07-27 21:26:48 -07003344 if libDepTag.static() && !libDepTag.wholeStatic {
3345 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3346 ctx.ModuleErrorf("module %q not a static library", depName)
3347 return
3348 }
Logan Chien43d34c32017-12-20 01:17:32 +08003349
Colin Cross6e511a92020-07-27 21:26:48 -07003350 // When combining coverage files for shared libraries and executables, coverage files
3351 // in static libraries act as if they were whole static libraries. The same goes for
3352 // source based Abi dump files.
3353 if c, ok := ccDep.(*Module); ok {
3354 staticLib := c.linker.(libraryInterface)
3355 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3356 staticLib.objs().coverageFiles...)
3357 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3358 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003359 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003360 // Handle non-CC modules here
3361 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003362 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003363 }
3364 }
3365
Colin Cross6e511a92020-07-27 21:26:48 -07003366 if ptr != nil {
3367 if !linkFile.Valid() {
3368 if !ctx.Config().AllowMissingDependencies() {
3369 ctx.ModuleErrorf("module %q missing output file", depName)
3370 } else {
3371 ctx.AddMissingDependencies([]string{depName})
3372 }
3373 return
3374 }
3375 *ptr = append(*ptr, linkFile.Path())
3376 }
3377
3378 if depPtr != nil {
3379 dep := depFile
3380 if !dep.Valid() {
3381 dep = linkFile
3382 }
3383 *depPtr = append(*depPtr, dep.Path())
3384 }
3385
Colin Cross0de8a1e2020-09-18 14:15:30 -07003386 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3387 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3388 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3389 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3390
3391 if libDepTag.reexportFlags {
3392 reexportExporter(depExporterInfo)
3393 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3394 // Re-exported shared library headers must be included as well since they can help us with type information
3395 // about template instantiations (instantiated from their headers).
3396 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3397 // scripts.
3398 c.sabi.Properties.ReexportedIncludes = append(
3399 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3400 }
3401
Spandan Das3faa7922024-02-26 19:42:32 +00003402 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003403 switch {
3404 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003405 c.Properties.AndroidMkHeaderLibs = append(
3406 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003407 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003408 if lib := moduleLibraryInterface(dep); lib != nil {
3409 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003410 // Add the dependency to the APEX(es) providing the library so that
3411 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003412 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003413 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003414 c.Properties.ApexesProvidingSharedLibs = append(
3415 c.Properties.ApexesProvidingSharedLibs, an)
3416 }
3417 }
3418 }
3419
3420 // Note: the order of libs in this list is not important because
3421 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003422 c.Properties.AndroidMkSharedLibs = append(
3423 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003424 // Record BaseLibName for snapshots.
3425 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003426 case libDepTag.static():
3427 if libDepTag.wholeStatic {
3428 c.Properties.AndroidMkWholeStaticLibs = append(
3429 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3430 } else {
3431 c.Properties.AndroidMkStaticLibs = append(
3432 c.Properties.AndroidMkStaticLibs, makeLibName)
3433 }
Justin Yun5e035862021-06-29 20:50:37 +09003434 // Record BaseLibName for snapshots.
3435 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003436 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003437 } else if !c.IsStubs() {
3438 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3439
Colin Cross6e511a92020-07-27 21:26:48 -07003440 switch depTag {
3441 case runtimeDepTag:
3442 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003443 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003444 // Record BaseLibName for snapshots.
3445 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003446 case objDepTag:
3447 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3448 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003449 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003450 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003451 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003452 case dynamicLinkerDepTag:
3453 depPaths.DynamicLinker = linkFile
3454 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003455 }
Colin Crossca860ac2016-01-04 14:34:37 -08003456 })
3457
Jeff Gaston294356f2017-09-27 17:05:30 -07003458 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003459 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3460 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3461 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003462
Colin Crossdd84e052017-05-17 13:44:16 -07003463 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003464 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003465 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3466 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003467 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003468 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3469 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003470 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003471 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003472 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003473
3474 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003475 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003476 }
Colin Crossdd84e052017-05-17 13:44:16 -07003477
Colin Crossca860ac2016-01-04 14:34:37 -08003478 return depPaths
3479}
3480
Spandan Das604f3762023-03-16 22:51:40 +00003481func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003482 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003483 thisModule, ok := ctx.Module().(android.ApexModule)
3484 if !ok {
3485 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3486 }
3487
Kiyoung Kimaa394802024-01-08 12:55:45 +09003488 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003489 bootstrap := false
3490 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3491 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3492 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003493 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003494 bootstrap = linkable.Bootstrap()
3495 }
3496
Colin Crossff694a82023-12-13 15:54:49 -08003497 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003498
3499 useStubs := false
3500
Kiyoung Kimaa394802024-01-08 12:55:45 +09003501 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003502 if !apexInfo.IsForPlatform() {
3503 // For platform libraries, use current version of LLNDK
3504 // If this is for use_vendor apex we will apply the same rules
3505 // of apex sdk enforcement below to choose right version.
3506 useStubs = true
3507 }
3508 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3509 // If not building for APEX or the containing APEX allows the use of
3510 // platform APIs, use stubs only when it is from an APEX (and not from
3511 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3512 // bootstrap modules, always link to non-stub variant
3513 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3514
3515 isApexImportedApiLibrary := false
3516
3517 if cc, ok := dep.(*Module); ok {
3518 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3519 if apiLibrary.hasApexStubs() {
3520 isApexImportedApiLibrary = true
3521 }
3522 }
3523 }
3524
3525 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3526
3527 if useStubs {
3528 // Another exception: if this module is a test for an APEX, then
3529 // it is linked with the non-stub variant of a module in the APEX
3530 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003531 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003532 for _, apexContents := range testFor.ApexContents {
3533 if apexContents.DirectlyInApex(depName) {
3534 useStubs = false
3535 break
3536 }
3537 }
3538 }
3539 if useStubs {
3540 // Yet another exception: If this module and the dependency are
3541 // available to the same APEXes then skip stubs between their
3542 // platform variants. This complements the test_for case above,
3543 // which avoids the stubs on a direct APEX library dependency, by
3544 // avoiding stubs for indirect test dependencies as well.
3545 //
3546 // TODO(b/183882457): This doesn't work if the two libraries have
3547 // only partially overlapping apex_available. For that test_for
3548 // modules would need to be split into APEX variants and resolved
3549 // separately for each APEX they have access to.
3550 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3551 useStubs = false
3552 }
3553 }
3554 } else {
3555 // If building for APEX, use stubs when the parent is in any APEX that
3556 // the child is not in.
3557 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3558 }
3559
3560 return useStubs
3561}
3562
3563// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3564// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3565// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3566// has different level of updatability. For example, if a library foo in an APEX depends on a
3567// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3568// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3569// same APEX as foo, the non-stub variant of bar is used.
3570func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3571 depTag := ctx.OtherModuleDependencyTag(dep)
3572 libDepTag, ok := depTag.(libraryDependencyTag)
3573 if !ok || !libDepTag.shared() {
3574 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3575 }
3576
Colin Cross313aa542023-12-13 13:47:44 -08003577 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3578 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3579 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003580
3581 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003582 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003583 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003584 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3585 toUse := stubs[len(stubs)-1]
3586 sharedLibraryInfo = toUse.SharedLibraryInfo
3587 depExporterInfo = toUse.FlagExporterInfo
3588 }
3589 }
3590 return sharedLibraryInfo, depExporterInfo
3591}
3592
Colin Cross0de8a1e2020-09-18 14:15:30 -07003593// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3594// to match the topological order of the dependency tree, including any static analogues of
3595// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3596// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003597func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3598 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003599 var staticPaths android.Paths
3600 for _, staticDep := range staticDeps {
3601 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3602 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3603 }
3604 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003605 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3606 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003607 }
3608 }
3609 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3610
3611 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3612
3613 // reorder the dependencies based on transitive dependencies
3614 staticPaths = android.FirstUniquePaths(staticPaths)
3615 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3616
3617 if len(orderedStaticPaths) != len(staticPaths) {
3618 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3619 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3620 }
3621
3622 return orderedStaticPaths, transitiveStaticLibs
3623}
3624
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003625// BaseLibName trims known prefixes and suffixes
3626func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003627 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3628 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003629 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003630 return libName
3631}
3632
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003633func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003634 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003635 ccDepModule, _ := ccDep.(*Module)
3636 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003637 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003638
Justin Yuncbca3732021-02-03 19:24:13 +09003639 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003640 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003641 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003642 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003643
Ivan Lozanod1dec542021-05-26 15:33:11 -04003644 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003645 }
3646 }
3647
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003648 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3649 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003650 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3651 // core module instead.
3652 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003653 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003654 // The vendor and product modules in Make will have been renamed to not conflict with the
3655 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003656 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003657 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003658 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003659 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003660 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003661 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003662 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003663 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003664 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003665 } else {
3666 return libName
3667 }
3668}
3669
Colin Crossca860ac2016-01-04 14:34:37 -08003670func (c *Module) InstallInData() bool {
3671 if c.installer == nil {
3672 return false
3673 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003674 return c.installer.inData()
3675}
3676
3677func (c *Module) InstallInSanitizerDir() bool {
3678 if c.installer == nil {
3679 return false
3680 }
3681 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003682 return true
3683 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003684 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003685}
3686
Yifan Hong1b3348d2020-01-21 15:53:22 -08003687func (c *Module) InstallInRamdisk() bool {
3688 return c.InRamdisk()
3689}
3690
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003691func (c *Module) InstallInVendorRamdisk() bool {
3692 return c.InVendorRamdisk()
3693}
3694
Jiyong Parkf9332f12018-02-01 00:54:12 +09003695func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003696 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003697}
3698
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003699func (c *Module) MakeUninstallable() {
3700 if c.installer == nil {
3701 c.ModuleBase.MakeUninstallable()
3702 return
3703 }
3704 c.installer.makeUninstallable(c)
3705}
3706
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003707func (c *Module) HostToolPath() android.OptionalPath {
3708 if c.installer == nil {
3709 return android.OptionalPath{}
3710 }
3711 return c.installer.hostToolPath()
3712}
3713
Nan Zhangd4e641b2017-07-12 12:55:28 -07003714func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3715 return c.outputFile
3716}
3717
Colin Cross41955e82019-05-29 14:40:35 -07003718func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3719 switch tag {
3720 case "":
3721 if c.outputFile.Valid() {
3722 return android.Paths{c.outputFile.Path()}, nil
3723 }
3724 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003725 case "unstripped":
3726 if c.linker != nil {
3727 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3728 }
3729 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003730 case "stripped_all":
3731 if c.linker != nil {
3732 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3733 }
3734 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003735 default:
3736 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003737 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003738}
3739
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003740func (c *Module) static() bool {
3741 if static, ok := c.linker.(interface {
3742 static() bool
3743 }); ok {
3744 return static.static()
3745 }
3746 return false
3747}
3748
Jiyong Park379de2f2018-12-19 02:47:14 +09003749func (c *Module) staticBinary() bool {
3750 if static, ok := c.linker.(interface {
3751 staticBinary() bool
3752 }); ok {
3753 return static.staticBinary()
3754 }
3755 return false
3756}
3757
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003758func (c *Module) testBinary() bool {
3759 if test, ok := c.linker.(interface {
3760 testBinary() bool
3761 }); ok {
3762 return test.testBinary()
3763 }
3764 return false
3765}
3766
Jingwen Chen537242c2022-08-24 11:53:27 +00003767func (c *Module) testLibrary() bool {
3768 if test, ok := c.linker.(interface {
3769 testLibrary() bool
3770 }); ok {
3771 return test.testLibrary()
3772 }
3773 return false
3774}
3775
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003776func (c *Module) benchmarkBinary() bool {
3777 if b, ok := c.linker.(interface {
3778 benchmarkBinary() bool
3779 }); ok {
3780 return b.benchmarkBinary()
3781 }
3782 return false
3783}
3784
3785func (c *Module) fuzzBinary() bool {
3786 if f, ok := c.linker.(interface {
3787 fuzzBinary() bool
3788 }); ok {
3789 return f.fuzzBinary()
3790 }
3791 return false
3792}
3793
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003794// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3795func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003796 if h, ok := c.linker.(interface {
3797 header() bool
3798 }); ok {
3799 return h.header()
3800 }
3801 return false
3802}
3803
Ivan Lozanod7586b62021-04-01 09:49:36 -04003804func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003805 if b, ok := c.linker.(interface {
3806 binary() bool
3807 }); ok {
3808 return b.binary()
3809 }
3810 return false
3811}
3812
Justin Yun5e035862021-06-29 20:50:37 +09003813func (c *Module) StaticExecutable() bool {
3814 if b, ok := c.linker.(*binaryDecorator); ok {
3815 return b.static()
3816 }
3817 return false
3818}
3819
Ivan Lozanod7586b62021-04-01 09:49:36 -04003820func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003821 if o, ok := c.linker.(interface {
3822 object() bool
3823 }); ok {
3824 return o.object()
3825 }
3826 return false
3827}
3828
Ivan Lozanof9e21722020-12-02 09:00:51 -05003829func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003830 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003831 if c.IsLlndk() {
3832 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003833 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003834 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003835 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003836 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003837 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003838 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003839 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003840 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003841 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003842 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003843 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003844 return "native:product"
3845 }
Jooyung Han38002912019-05-16 04:01:54 +09003846 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003847 } else if c.InRamdisk() {
3848 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003849 } else if c.InVendorRamdisk() {
3850 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003851 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003852 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003853 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003854 return "native:ndk:none:none"
3855 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3856 //family, link := getNdkStlFamilyAndLinkType(c)
3857 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003858 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003859 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003860 } else {
3861 return "native:platform"
3862 }
3863}
3864
Jiyong Park9d452992018-10-03 00:38:19 +09003865// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003866// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003867func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003868 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003869 // Stub libs and prebuilt libs in a versioned SDK are not
3870 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003871 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003872 } else if _, ok := c.linker.(testPerSrc); ok {
3873 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003874 }
3875 return false
3876}
3877
Jiyong Parka90ca002019-10-07 15:47:24 +09003878func (c *Module) AvailableFor(what string) bool {
3879 if linker, ok := c.linker.(interface {
3880 availableFor(string) bool
3881 }); ok {
3882 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3883 } else {
3884 return c.ApexModuleBase.AvailableFor(what)
3885 }
3886}
3887
Jiyong Park62304bb2020-04-13 16:19:48 +09003888func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003889 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003890}
3891
Paul Duffin0cb37b92020-03-04 14:52:46 +00003892func (c *Module) EverInstallable() bool {
3893 return c.installer != nil &&
3894 // Check to see whether the module is actually ever installable.
3895 c.installer.everInstallable()
3896}
3897
Ivan Lozanod7586b62021-04-01 09:49:36 -04003898func (c *Module) PreventInstall() bool {
3899 return c.Properties.PreventInstall
3900}
3901
3902func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003903 if c.library != nil {
3904 if i := c.library.installable(); i != nil {
3905 return i
3906 }
3907 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003908 return c.Properties.Installable
3909}
3910
3911func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003912 ret := c.EverInstallable() &&
3913 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003914 proptools.BoolDefault(c.Installable(), true) &&
3915 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003916
3917 // The platform variant doesn't need further condition. Apex variants however might not
3918 // be installable because it will likely to be included in the APEX and won't appear
3919 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003920 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003921 return ret
3922 }
3923
3924 // Special case for modules that are configured to be installed to /data, which includes
3925 // test modules. For these modules, both APEX and non-APEX variants are considered as
3926 // installable. This is because even the APEX variants won't be included in the APEX, but
3927 // will anyway be installed to /data/*.
3928 // See b/146995717
3929 if c.InstallInData() {
3930 return ret
3931 }
3932
3933 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003934}
3935
Logan Chien41eabe62019-04-10 13:33:58 +08003936func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3937 if c.linker != nil {
3938 if library, ok := c.linker.(*libraryDecorator); ok {
3939 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3940 }
3941 }
3942}
3943
Jiyong Park45bf82e2020-12-15 22:29:02 +09003944var _ android.ApexModule = (*Module)(nil)
3945
3946// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003947func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003948 depTag := ctx.OtherModuleDependencyTag(dep)
3949 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3950
3951 if cc, ok := dep.(*Module); ok {
3952 if cc.HasStubsVariants() {
3953 if isLibDepTag && libDepTag.shared() {
3954 // dynamic dep to a stubs lib crosses APEX boundary
3955 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003956 }
Colin Cross6e511a92020-07-27 21:26:48 -07003957 if IsRuntimeDepTag(depTag) {
3958 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003959 return false
3960 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003961 }
Zhijun Heec285872021-04-24 10:47:08 -07003962 if cc.IsLlndk() {
3963 return false
3964 }
Colin Crossaac32222020-07-29 12:51:56 -07003965 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003966 // shared_lib dependency from a static lib is considered as crossing
3967 // the APEX boundary because the dependency doesn't actually is
3968 // linked; the dependency is used only during the compilation phase.
3969 return false
3970 }
Jiyong Parke3867542020-12-03 17:28:25 +09003971
3972 if isLibDepTag && libDepTag.excludeInApex {
3973 return false
3974 }
Colin Cross6e511a92020-07-27 21:26:48 -07003975 }
Colin Crossc1b36442021-05-06 13:42:48 -07003976 if depTag == stubImplDepTag {
3977 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003978 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003979 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003980 if depTag == staticVariantTag {
3981 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3982 // actually mean that the static lib (and its dependencies) are copied into the
3983 // APEX.
3984 return false
3985 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003986 return true
3987}
3988
Jiyong Park45bf82e2020-12-15 22:29:02 +09003989// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003990func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3991 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003992 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3993 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3994 return nil
3995 }
Jooyung Han749dc692020-04-15 11:03:39 +09003996 // We don't check for prebuilt modules
3997 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3998 return nil
3999 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09004000
Jooyung Han749dc692020-04-15 11:03:39 +09004001 minSdkVersion := c.MinSdkVersion()
4002 if minSdkVersion == "apex_inherit" {
4003 return nil
4004 }
4005 if minSdkVersion == "" {
4006 // JNI libs within APK-in-APEX fall into here
4007 // Those are okay to set sdk_version instead
4008 // We don't have to check if this is a SDK variant because
4009 // non-SDK variant resets sdk_version, which works too.
4010 minSdkVersion = c.SdkVersion()
4011 }
Dan Albertc8060532020-07-22 22:32:17 -07004012 if minSdkVersion == "" {
4013 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
4014 }
4015 // Not using nativeApiLevelFromUser because the context here is not
4016 // necessarily a native context.
4017 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09004018 if err != nil {
4019 return err
4020 }
Dan Albertc8060532020-07-22 22:32:17 -07004021
Colin Cross8ca61c12022-10-06 21:00:14 -07004022 // A dependency only needs to support a min_sdk_version at least
4023 // as high as the api level that the architecture was introduced in.
4024 // This allows introducing new architectures in the platform that
4025 // need to be included in apexes that normally require an older
4026 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08004027 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07004028 if sdkVersion.LessThan(minApiForArch) {
4029 sdkVersion = minApiForArch
4030 }
4031
Dan Albertc8060532020-07-22 22:32:17 -07004032 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004033 return fmt.Errorf("newer SDK(%v)", ver)
4034 }
4035 return nil
4036}
4037
Paul Duffinb5769c12021-05-12 16:16:51 +01004038// Implements android.ApexModule
4039func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4040 // stub libraries and native bridge libraries are always available to platform
4041 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4042}
4043
Jooyung Han91f92032022-02-04 12:36:33 +09004044// Overrides android.ApexModuleBase.UniqueApexVariations
4045func (c *Module) UniqueApexVariations() bool {
4046 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4047 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4048 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004049 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004050 return c.UseVndk() && c.IsVndk()
4051}
4052
Inseob Kima1888ce2022-10-04 14:42:02 +09004053func (c *Module) overriddenModules() []string {
4054 if o, ok := c.linker.(overridable); ok {
4055 return o.overriddenModules()
4056 }
4057 return nil
4058}
4059
Rob Seymour925aa092021-08-10 20:42:03 +00004060var _ snapshot.RelativeInstallPath = (*Module)(nil)
4061
Liz Kammer35ca77e2021-12-22 15:31:40 -05004062type moduleType int
4063
4064const (
4065 unknownType moduleType = iota
4066 binary
4067 object
4068 fullLibrary
4069 staticLibrary
4070 sharedLibrary
4071 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004072 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004073 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004074 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004075)
4076
4077func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004078 if c.testBinary() {
4079 // testBinary is also a binary, so this comes before the c.Binary()
4080 // conditional. A testBinary has additional implicit dependencies and
4081 // other test-only semantics.
4082 return testBin
4083 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004084 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004085 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004086 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004087 } else if c.testLibrary() {
4088 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4089 // will let them add implicit compile deps on gtest, for example.
4090 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004091 // For now, treat them as regular libraries.
4092 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004093 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004094 static := false
4095 shared := false
4096 if library, ok := c.linker.(*libraryDecorator); ok {
4097 static = library.MutatedProperties.BuildStatic
4098 shared = library.MutatedProperties.BuildShared
4099 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4100 static = library.MutatedProperties.BuildStatic
4101 shared = library.MutatedProperties.BuildShared
4102 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004103 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004104 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004105 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004106 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004107 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004108 return staticLibrary
4109 }
4110 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004111 } else if c.isNDKStubLibrary() {
4112 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004113 } else if c.IsNdkPrebuiltStl() {
4114 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004115 }
4116 return unknownType
4117}
4118
Colin Crosscfad1192015-11-02 16:43:11 -08004119// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004120type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004121 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004122 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004123 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004124
4125 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4126 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004127}
4128
Patrice Arrudac249c712019-03-19 17:00:29 -07004129// cc_defaults provides a set of properties that can be inherited by other cc
4130// modules. A module can use the properties from a cc_defaults using
4131// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4132// merged (when possible) by prepending the default module's values to the
4133// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004134func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004135 return DefaultsFactory()
4136}
4137
Colin Cross36242852017-06-23 15:06:31 -07004138func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004139 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004140
Colin Cross36242852017-06-23 15:06:31 -07004141 module.AddProperties(props...)
4142 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004143 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004144 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004145 &BaseCompilerProperties{},
4146 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004147 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004148 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004149 &StaticProperties{},
4150 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004151 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004152 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004153 &TestLinkerProperties{},
4154 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004155 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004156 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004157 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004158 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004159 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004160 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004161 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004162 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004163 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004164 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004165 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004166 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004167 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004168 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004169 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004170 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4171 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004172 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004173 )
Colin Crosscfad1192015-11-02 16:43:11 -08004174
Jooyung Hancc372c52019-09-25 15:18:44 +09004175 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004176
4177 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004178}
4179
Jiyong Park2286afd2020-06-16 21:58:53 +09004180func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004181 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004182}
4183
Kiyoung Kim51279d32022-08-24 14:10:46 +09004184func (c *Module) isImportedApiLibrary() bool {
4185 _, ok := c.linker.(*apiLibraryDecorator)
4186 return ok
4187}
4188
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004189func kytheExtractAllFactory() android.Singleton {
4190 return &kytheExtractAllSingleton{}
4191}
4192
4193type kytheExtractAllSingleton struct {
4194}
4195
4196func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4197 var xrefTargets android.Paths
4198 ctx.VisitAllModules(func(module android.Module) {
4199 if ccModule, ok := module.(xref); ok {
4200 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4201 }
4202 })
4203 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4204 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004205 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004206 }
4207}
4208
Jihoon Kangf78a8902022-09-01 22:47:07 +00004209func (c *Module) Partition() string {
4210 if p, ok := c.installer.(interface {
4211 getPartition() string
4212 }); ok {
4213 return p.getPartition()
4214 }
4215 return ""
4216}
4217
Spandan Das2b6dfb52024-01-19 00:22:22 +00004218type sourceModuleName interface {
4219 sourceModuleName() string
4220}
4221
4222func (c *Module) BaseModuleName() string {
4223 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4224 // if the prebuilt module sets a source_module_name in Android.bp, use that
4225 return smn.sourceModuleName()
4226 }
4227 return c.ModuleBase.BaseModuleName()
4228}
4229
Colin Cross06a931b2015-10-28 17:23:31 -07004230var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004231var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004232var BoolPtr = proptools.BoolPtr
4233var String = proptools.String
4234var StringPtr = proptools.StringPtr