blob: eb6e974e01183e383537bdb0d54a7ad205af3943 [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"
Colin Cross3f40fa42015-01-30 17:27:36 -080038)
39
Colin Cross463a90e2015-06-17 14:20:06 -070040func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000041 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070042
Inseob Kim3b244062023-07-11 13:31:36 +090043 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +000044 pctx.Import("android/soong/cc/config")
45}
46
47func RegisterCCBuildComponents(ctx android.RegistrationContext) {
48 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
49
50 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000051 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090052 ctx.BottomUp("vndk", VndkMutator).Parallel()
Kiyoung Kim973cb6f2024-04-29 14:14:53 +090053 ctx.BottomUp("llndk", llndkMutator).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
Inseob Kim37e0bb02024-04-29 15:54:44 +0900323 Logtags []string `android:"path"`
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
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000356 // Allows this module to be included in CMake release snapshots to be built outside of Android
357 // build system and source tree.
358 Cmake_snapshot_supported *bool
359
Jooyung Han097087b2019-10-22 19:32:18 +0900360 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
361 // see soong/cc/config/vndk.go
362 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900363
Colin Cross1bc94122021-10-28 13:25:54 -0700364 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000365
366 // Set by factories of module types that can only be referenced from variants compiled against
367 // the SDK.
368 AlwaysSdk bool `blueprint:"mutated"`
369
370 // Variant is an SDK variant created by sdkMutator
371 IsSdkVariant bool `blueprint:"mutated"`
372 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
373 // variant to have a ".sdk" suffix.
374 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700375
Jiyong Park46a512f2020-12-04 18:02:13 +0900376 // List of APEXes that this module has private access to for testing purpose. The module
377 // can depend on libraries that are not exported by the APEXes and use private symbols
378 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000379 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800380
381 Target struct {
382 Platform struct {
383 // List of modules required by the core variant.
384 Required []string `android:"arch_variant"`
385
386 // List of modules not required by the core variant.
387 Exclude_required []string `android:"arch_variant"`
388 } `android:"arch_variant"`
389
390 Recovery struct {
391 // List of modules required by the recovery variant.
392 Required []string `android:"arch_variant"`
393
394 // List of modules not required by the recovery variant.
395 Exclude_required []string `android:"arch_variant"`
396 } `android:"arch_variant"`
397 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700398}
399
400type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900401 // whether this module should be allowed to be directly depended by other
402 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900403 // If set to true, two variants will be built separately, one like
404 // normal, and the other limited to the set of libraries and headers
405 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700406 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900407 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700408 // so it shouldn't have any unversioned runtime dependencies, or
409 // make assumptions about the system that may not be true in the
410 // future.
411 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900412 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900413 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900414 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900415 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900416 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700417 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
418 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900419
Justin Yunebcf0c52021-01-08 18:00:19 +0900420 // This is the same as the "vendor_available" except that the install path
421 // of the vendor variant is /odm or /vendor/odm.
422 // By replacing "vendor_available: true" with "odm_available: true", the
423 // module will install its vendor variant to the /odm partition or /vendor/odm.
424 // As the modules with "odm_available: true" still create the vendor variants,
425 // they can link to the other vendor modules as the vendor_available modules do.
426 // Also, the vendor modules can link to odm_available modules.
427 //
428 // It may not be used for VNDK modules.
429 Odm_available *bool
430
Justin Yun63e9ec72020-10-29 16:49:43 +0900431 // whether this module should be allowed to be directly depended by other
432 // modules with `product_specific: true` or `product_available: true`.
433 // If set to true, an additional product variant will be built separately
434 // that is limited to the set of libraries and headers that are exposed to
435 // /product modules.
436 //
437 // The product variant may be used with a different (newer) /system,
438 // so it shouldn't have any unversioned runtime dependencies, or
439 // make assumptions about the system that may not be true in the
440 // future.
441 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900442 // If set to false, this module becomes inaccessible from /product modules.
443 //
444 // Different from the 'vendor_available' property, the modules with
445 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
446 // library without 'product_available' may not be depended on by any other
447 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900448 //
449 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
450 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
451 Product_available *bool
452
Jiyong Park5fb8c102018-04-09 12:03:06 +0900453 // whether this module is capable of being loaded with other instance
454 // (possibly an older version) of the same module in the same process.
455 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
456 // can be double loaded in a vendor process if the library is also a
457 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
458 // explicitly marked as `double_loadable: true` by the owner, or the dependency
459 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
460 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800461
462 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
463 IsLLNDK bool `blueprint:"mutated"`
464
Colin Cross78212242021-01-06 14:51:30 -0800465 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
466 // set and the module is not listed in VndkMustUseVendorVariantList.
467 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
468
469 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
470 IsVNDKCore bool `blueprint:"mutated"`
471
472 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
473 IsVNDKSP bool `blueprint:"mutated"`
474
475 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
476 // module sets the llndk.private property.
477 IsVNDKPrivate bool `blueprint:"mutated"`
478
479 // IsVNDKProduct is set if a VNDK module sets the product_available property.
480 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700481
482 // IsVendorPublicLibrary is set for the core and product variants of a library that has
483 // vendor_public_library stubs.
484 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800485}
486
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500487// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
488// to understanding details about the type of the current module.
489// For example, one might call these functions to determine whether the current module is a static
490// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800491type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800492 static() bool
493 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700494 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800495 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900496 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900497 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900498 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700499 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900500 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700501 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800502 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900503 minSdkVersion() string
504 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700505 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700506 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800507 IsLlndk() bool
508 IsLlndkPublic() bool
509 isImplementationForLLNDKPublic() bool
510 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900511 isVndk() bool
512 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500513 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700514 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900515 inProduct() bool
516 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800517 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700518 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900519 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900520 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700521 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700522 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800523 getVndkExtendsModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800524 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000525 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800526 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900527 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800528 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800529 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800530 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700531 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700532 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900533 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800534 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700535 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700536 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800537 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800538 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800539 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800540 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800541}
542
543type SharedFlags struct {
544 numSharedFlags int
545 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800546}
547
548type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700549 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800550 ModuleContextIntf
551}
552
553type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700554 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800555 ModuleContextIntf
556}
557
Colin Cross37047f12016-12-13 17:06:13 -0800558type DepsContext interface {
559 android.BottomUpMutatorContext
560 ModuleContextIntf
561}
562
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500563// feature represents additional (optional) steps to building cc-related modules, such as invocation
564// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800565type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800566 flags(ctx ModuleContext, flags Flags) Flags
567 props() []interface{}
568}
569
Joe Onorato37f900c2023-07-18 16:58:16 -0700570// Information returned from Generator about the source code it's generating
571type GeneratedSource struct {
572 IncludeDirs android.Paths
573 Sources android.Paths
574 Headers android.Paths
575 ReexportedDirs android.Paths
576}
577
578// generator allows injection of generated code
579type Generator interface {
580 GeneratorProps() []interface{}
581 GeneratorInit(ctx BaseModuleContext)
582 GeneratorDeps(ctx DepsContext, deps Deps) Deps
583 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
584 GeneratorSources(ctx ModuleContext) GeneratedSource
585 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
586}
587
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500588// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500589// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800590type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700591 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800592 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800593 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700594 compilerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000595 baseCompilerProps() BaseCompilerProperties
Colin Cross42742b82016-08-01 13:20:05 -0700596
Colin Cross76fada02016-07-27 10:31:13 -0700597 appendCflags([]string)
598 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700599 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800600}
601
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500602// linker is the interface for a linker decorator object. Individual module types can provide
603// their own implementation for this decorator, and thus specify custom logic regarding build
604// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800605type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700606 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800607 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700608 linkerFlags(ctx ModuleContext, flags Flags) Flags
609 linkerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000610 baseLinkerProps() BaseLinkerProperties
Ivan Lozanobd721262018-11-27 14:33:03 -0800611 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700612
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700613 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700614 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900615 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800616 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700617
618 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900619 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000620
621 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000622 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800623
624 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000625}
626
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500627// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000628type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500629 sharedLibs []string
630 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
631 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700632 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800633}
634
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500635// installer is the interface for an installer helper object. This helper is responsible for
636// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800637type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700638 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700639 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000640 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800641 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700642 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700643 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900644 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000645 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900646 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800647}
648
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800649type xref interface {
650 XrefCcFiles() android.Paths
651}
652
Inseob Kima1888ce2022-10-04 14:42:02 +0900653type overridable interface {
654 overriddenModules() []string
655}
656
Colin Cross6e511a92020-07-27 21:26:48 -0700657type libraryDependencyKind int
658
659const (
660 headerLibraryDependency = iota
661 sharedLibraryDependency
662 staticLibraryDependency
663)
664
665func (k libraryDependencyKind) String() string {
666 switch k {
667 case headerLibraryDependency:
668 return "headerLibraryDependency"
669 case sharedLibraryDependency:
670 return "sharedLibraryDependency"
671 case staticLibraryDependency:
672 return "staticLibraryDependency"
673 default:
674 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
675 }
676}
677
678type libraryDependencyOrder int
679
680const (
681 earlyLibraryDependency = -1
682 normalLibraryDependency = 0
683 lateLibraryDependency = 1
684)
685
686func (o libraryDependencyOrder) String() string {
687 switch o {
688 case earlyLibraryDependency:
689 return "earlyLibraryDependency"
690 case normalLibraryDependency:
691 return "normalLibraryDependency"
692 case lateLibraryDependency:
693 return "lateLibraryDependency"
694 default:
695 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
696 }
697}
698
699// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
700// tags that have a set of predefined tag objects that are reused for each dependency, a
701// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
702// That means that comparing a libraryDependencyTag for equality will only be equal if all
703// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
704// then check individual metadata fields instead.
705type libraryDependencyTag struct {
706 blueprint.BaseDependencyTag
707
708 // These are exported so that fmt.Printf("%#v") can call their String methods.
709 Kind libraryDependencyKind
710 Order libraryDependencyOrder
711
712 wholeStatic bool
713
714 reexportFlags bool
715 explicitlyVersioned bool
716 dataLib bool
717 ndk bool
718
719 staticUnwinder bool
720
721 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900722
Cindy Zhou18417cb2020-12-10 07:12:38 -0800723 // Whether or not this dependency should skip the apex dependency check
724 skipApexAllowedDependenciesCheck bool
725
Jiyong Parke3867542020-12-03 17:28:25 +0900726 // Whether or not this dependency has to be followed for the apex variants
727 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900728 // Whether or not this dependency has to be followed for the non-apex variants
729 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000730
731 // If true, don't automatically export symbols from the static library into a shared library.
732 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700733}
734
735// header returns true if the libraryDependencyTag is tagging a header lib dependency.
736func (d libraryDependencyTag) header() bool {
737 return d.Kind == headerLibraryDependency
738}
739
740// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
741func (d libraryDependencyTag) shared() bool {
742 return d.Kind == sharedLibraryDependency
743}
744
745// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
746func (d libraryDependencyTag) static() bool {
747 return d.Kind == staticLibraryDependency
748}
749
Colin Cross65cb3142021-12-10 23:05:02 +0000750func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
751 if d.shared() {
752 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
753 }
754 return nil
755}
756
757var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
758
Colin Crosse9fe2942020-11-10 18:12:15 -0800759// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
760// binaries or other shared libraries are installed as dependencies.
761func (d libraryDependencyTag) InstallDepNeeded() bool {
762 return d.shared()
763}
764
765var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
766
Yu Liu67a28422024-03-05 00:36:31 +0000767func (d libraryDependencyTag) PropagateAconfigValidation() bool {
768 return d.static()
769}
770
771var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
772
Colin Crosse9fe2942020-11-10 18:12:15 -0800773// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700774// libraryDependencyTag. Each tag object is created globally and reused for multiple
775// dependencies (although since the object contains no references, assigning a tag to a
776// variable and modifying it will not modify the original). Users can compare the tag
777// returned by ctx.OtherModuleDependencyTag against the global original
778type dependencyTag struct {
779 blueprint.BaseDependencyTag
780 name string
781}
782
Colin Crosse9fe2942020-11-10 18:12:15 -0800783// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
784// libraryDependencyTag, but where the dependency needs to be installed when the parent is
785// installed.
786type installDependencyTag struct {
787 blueprint.BaseDependencyTag
788 android.InstallAlwaysNeededDependencyTag
789 name string
790}
791
Colin Crossc99deeb2016-04-11 15:06:20 -0700792var (
Colin Cross6e511a92020-07-27 21:26:48 -0700793 genSourceDepTag = dependencyTag{name: "gen source"}
794 genHeaderDepTag = dependencyTag{name: "gen header"}
795 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
796 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900797 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700798 reuseObjTag = dependencyTag{name: "reuse objects"}
799 staticVariantTag = dependencyTag{name: "static variant"}
800 vndkExtDepTag = dependencyTag{name: "vndk extends"}
801 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700802 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800803 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700804 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700805 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000806 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500807 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400808 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800809 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700810)
811
Roland Levillainf89cd092019-07-29 16:22:59 +0100812func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700813 ccLibDepTag, ok := depTag.(libraryDependencyTag)
814 return ok && ccLibDepTag.shared()
815}
816
817func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
818 ccLibDepTag, ok := depTag.(libraryDependencyTag)
819 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100820}
821
Zach Johnson3df4e632020-11-06 11:56:27 -0800822func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
823 ccLibDepTag, ok := depTag.(libraryDependencyTag)
824 return ok && ccLibDepTag.header()
825}
826
Roland Levillainf89cd092019-07-29 16:22:59 +0100827func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800828 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100829}
830
831func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700832 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100833 return ok && ccDepTag == testPerSrcDepTag
834}
835
Colin Crossca860ac2016-01-04 14:34:37 -0800836// Module contains the properties and members used by all C/C++ module types, and implements
837// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500838// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
839// interface.
840//
841// To define a C/C++ related module, construct a new Module object and point its delegates to
842// type-specific structs. These delegates will be invoked to register module-specific build
843// statements which may be unique to the module type. For example, module.compiler.compile() should
844// be defined so as to register build statements which are responsible for compiling the module.
845//
846// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
847// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
848// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
849// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800850type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700851 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700852
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700853 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700854 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -0700855 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -0700856
Colin Crossca860ac2016-01-04 14:34:37 -0800857 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000858 hod android.HostOrDeviceSupported
859 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000860 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700861
Paul Duffina0843f62019-12-13 19:50:38 +0000862 // Allowable SdkMemberTypes of this module type.
863 sdkMemberTypes []android.SdkMemberType
864
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500865 // decorator delegates, initialize before calling Init
866 // these may contain module-specific implementations, and effectively allow for custom
867 // type-specific logic. These members may reference different objects or the same object.
868 // Functions of these decorators will be invoked to initialize and register type-specific
869 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800870 generators []Generator
871 compiler compiler
872 linker linker
873 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500874
Spandan Dase12d2522023-09-12 21:42:31 +0000875 features []feature
876 stl *stl
877 sanitize *sanitize
878 coverage *coverage
879 fuzzer *fuzzer
880 sabi *sabi
881 vndkdep *vndkdep
882 lto *lto
883 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000884 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800885
Colin Cross31076b32020-10-23 17:22:06 -0700886 library libraryInterface
887
Colin Cross635c3b02016-05-18 15:37:25 -0700888 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800889
Colin Crossb98c8b02016-07-29 13:44:28 -0700890 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700891
892 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800893
894 // Flags used to compile this module
895 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700896
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800897 // Shared flags among build rules of this module
898 sharedFlags SharedFlags
899
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800900 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700901 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900902
903 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800904 // Kythe (source file indexer) paths for this compilation module
905 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700906 // Object .o file output paths for this compilation module
907 objFiles android.Paths
908 // Tidy .tidy file output paths for this compilation module
909 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900910
911 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700912 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700913
914 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800915
Inseob Kim37e0bb02024-04-29 15:54:44 +0900916 logtagsPaths android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700917}
918
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200919func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400920 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
921 if b, ok := c.compiler.(*baseCompiler); ok {
922 hasAidl = b.hasSrcExt(".aidl")
923 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
924 hasProto = b.hasSrcExt(".proto")
925 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
926 hasSysprop = b.hasSrcExt(".sysprop")
927 hasWinMsg = b.hasSrcExt(".mc")
928 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
929 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200930 c.AndroidModuleBase().AddJSONData(d)
931 (*d)["Cc"] = map[string]interface{}{
932 "SdkVersion": c.SdkVersion(),
933 "MinSdkVersion": c.MinSdkVersion(),
934 "VndkVersion": c.VndkVersion(),
935 "ProductSpecific": c.ProductSpecific(),
936 "SocSpecific": c.SocSpecific(),
937 "DeviceSpecific": c.DeviceSpecific(),
938 "InProduct": c.InProduct(),
939 "InVendor": c.InVendor(),
940 "InRamdisk": c.InRamdisk(),
941 "InVendorRamdisk": c.InVendorRamdisk(),
942 "InRecovery": c.InRecovery(),
943 "VendorAvailable": c.VendorAvailable(),
944 "ProductAvailable": c.ProductAvailable(),
945 "RamdiskAvailable": c.RamdiskAvailable(),
946 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
947 "RecoveryAvailable": c.RecoveryAvailable(),
948 "OdmAvailable": c.OdmAvailable(),
949 "InstallInData": c.InstallInData(),
950 "InstallInRamdisk": c.InstallInRamdisk(),
951 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
952 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
953 "InstallInRecovery": c.InstallInRecovery(),
954 "InstallInRoot": c.InstallInRoot(),
955 "IsVndk": c.IsVndk(),
956 "IsVndkExt": c.IsVndkExt(),
957 "IsVndkPrivate": c.IsVndkPrivate(),
958 "IsVndkSp": c.IsVndkSp(),
959 "IsLlndk": c.IsLlndk(),
960 "IsLlndkPublic": c.IsLlndkPublic(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200961 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
962 "ApexSdkVersion": c.apexSdkVersion,
963 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400964 "AidlSrcs": hasAidl,
965 "LexSrcs": hasLex,
966 "ProtoSrcs": hasProto,
967 "RenderscriptSrcs": hasRenderscript,
968 "SyspropSrcs": hasSysprop,
969 "WinMsgSrcs": hasWinMsg,
970 "YaccSrsc": hasYacc,
971 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200972 }
973}
974
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500975func (c *Module) SetPreventInstall() {
976 c.Properties.PreventInstall = true
977}
978
979func (c *Module) SetHideFromMake() {
980 c.Properties.HideFromMake = true
981}
982
Ivan Lozanod7586b62021-04-01 09:49:36 -0400983func (c *Module) HiddenFromMake() bool {
984 return c.Properties.HideFromMake
985}
986
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800987func (c *Module) RequiredModuleNames() []string {
988 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
989 if c.ImageVariation().Variation == android.CoreVariation {
990 required = append(required, c.Properties.Target.Platform.Required...)
991 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
992 } else if c.InRecovery() {
993 required = append(required, c.Properties.Target.Recovery.Required...)
994 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
995 }
996 return android.FirstUniqueStrings(required)
997}
998
Ivan Lozano52767be2019-10-18 14:49:46 -0700999func (c *Module) Toc() android.OptionalPath {
1000 if c.linker != nil {
1001 if library, ok := c.linker.(libraryInterface); ok {
1002 return library.toc()
1003 }
1004 }
1005 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1006}
1007
1008func (c *Module) ApiLevel() string {
1009 if c.linker != nil {
1010 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001011 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001012 }
1013 }
1014 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1015}
1016
1017func (c *Module) Static() bool {
1018 if c.linker != nil {
1019 if library, ok := c.linker.(libraryInterface); ok {
1020 return library.static()
1021 }
1022 }
1023 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1024}
1025
1026func (c *Module) Shared() bool {
1027 if c.linker != nil {
1028 if library, ok := c.linker.(libraryInterface); ok {
1029 return library.shared()
1030 }
1031 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001032
Ivan Lozano52767be2019-10-18 14:49:46 -07001033 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1034}
1035
1036func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001037 if c.stl != nil {
1038 return c.stl.Properties.SelectedStl
1039 }
1040 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001041}
1042
Ivan Lozano52767be2019-10-18 14:49:46 -07001043func (c *Module) NdkPrebuiltStl() bool {
1044 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1045 return true
1046 }
1047 return false
1048}
1049
1050func (c *Module) StubDecorator() bool {
1051 if _, ok := c.linker.(*stubDecorator); ok {
1052 return true
1053 }
1054 return false
1055}
1056
1057func (c *Module) SdkVersion() string {
1058 return String(c.Properties.Sdk_version)
1059}
1060
Artur Satayev480e25b2020-04-27 18:53:18 +01001061func (c *Module) MinSdkVersion() string {
1062 return String(c.Properties.Min_sdk_version)
1063}
1064
Jiyong Park5df7bd32021-08-25 16:18:46 +09001065func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001066 if linker, ok := c.linker.(*objectLinker); ok {
1067 return linker.isCrt()
1068 }
1069 return false
1070}
1071
Jiyong Park5df7bd32021-08-25 16:18:46 +09001072func (c *Module) SplitPerApiLevel() bool {
1073 return c.canUseSdk() && c.isCrt()
1074}
1075
Colin Crossc511bc52020-04-07 16:50:32 +00001076func (c *Module) AlwaysSdk() bool {
1077 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1078}
1079
Ivan Lozano183a3212019-10-18 14:18:45 -07001080func (c *Module) CcLibrary() bool {
1081 if c.linker != nil {
1082 if _, ok := c.linker.(*libraryDecorator); ok {
1083 return true
1084 }
Colin Crossd48fe732020-09-23 20:37:24 -07001085 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1086 return true
1087 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001088 }
1089 return false
1090}
1091
1092func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001093 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001094 return true
1095 }
1096 return false
1097}
1098
Spandan Dase12d2522023-09-12 21:42:31 +00001099func (c *Module) IsNdkPrebuiltStl() bool {
1100 if c.linker == nil {
1101 return false
1102 }
1103 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1104 return true
1105 }
1106 return false
1107}
1108
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001109func (c *Module) RlibStd() bool {
1110 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1111}
1112
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001113func (c *Module) RustLibraryInterface() bool {
1114 return false
1115}
1116
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001117func (c *Module) IsFuzzModule() bool {
1118 if _, ok := c.compiler.(*fuzzBinary); ok {
1119 return true
1120 }
1121 return false
1122}
1123
1124func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1125 return c.FuzzModule
1126}
1127
1128func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1129 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1130 return fuzzer.fuzzPackagedModule
1131 }
1132 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1133}
1134
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001135func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001136 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1137 return fuzzer.sharedLibraries
1138 }
1139 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1140}
1141
Ivan Lozano2b262972019-11-21 12:30:50 -08001142func (c *Module) NonCcVariants() bool {
1143 return false
1144}
1145
Ivan Lozano183a3212019-10-18 14:18:45 -07001146func (c *Module) SetStatic() {
1147 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001148 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001149 library.setStatic()
1150 return
1151 }
1152 }
1153 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1154}
1155
1156func (c *Module) SetShared() {
1157 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001158 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001159 library.setShared()
1160 return
1161 }
1162 }
1163 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1164}
1165
1166func (c *Module) BuildStaticVariant() bool {
1167 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001168 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001169 return library.buildStatic()
1170 }
1171 }
1172 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1173}
1174
1175func (c *Module) BuildSharedVariant() bool {
1176 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001177 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001178 return library.buildShared()
1179 }
1180 }
1181 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1182}
1183
1184func (c *Module) Module() android.Module {
1185 return c
1186}
1187
Jiyong Parkc20eee32018-09-05 22:36:17 +09001188func (c *Module) OutputFile() android.OptionalPath {
1189 return c.outputFile
1190}
1191
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001192func (c *Module) CoverageFiles() android.Paths {
1193 if c.linker != nil {
1194 if library, ok := c.linker.(libraryInterface); ok {
1195 return library.objs().coverageFiles
1196 }
1197 }
1198 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1199}
1200
Ivan Lozano183a3212019-10-18 14:18:45 -07001201var _ LinkableInterface = (*Module)(nil)
1202
Jiyong Park719b4462019-01-13 00:39:51 +09001203func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001204 if c.linker != nil {
1205 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001206 }
1207 return nil
1208}
1209
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001210func (c *Module) CoverageOutputFile() android.OptionalPath {
1211 if c.linker != nil {
1212 return c.linker.coverageOutputFilePath()
1213 }
1214 return android.OptionalPath{}
1215}
1216
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001217func (c *Module) RelativeInstallPath() string {
1218 if c.installer != nil {
1219 return c.installer.relativeInstallPath()
1220 }
1221 return ""
1222}
1223
Jooyung Han344d5432019-08-23 11:17:39 +09001224func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001225 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001226}
1227
Colin Cross36242852017-06-23 15:06:31 -07001228func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001229 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001230 for _, generator := range c.generators {
1231 c.AddProperties(generator.GeneratorProps()...)
1232 }
Colin Crossca860ac2016-01-04 14:34:37 -08001233 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001234 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001235 }
1236 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001237 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001238 }
1239 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001240 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001241 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001242 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001243 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001244 }
Colin Cross16b23492016-01-06 14:41:07 -08001245 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001246 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001247 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001248 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001249 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001250 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001251 if c.fuzzer != nil {
1252 c.AddProperties(c.fuzzer.props()...)
1253 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001254 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001255 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001256 }
Justin Yun8effde42017-06-23 19:24:43 +09001257 if c.vndkdep != nil {
1258 c.AddProperties(c.vndkdep.props()...)
1259 }
Stephen Craneba090d12017-05-09 15:44:35 -07001260 if c.lto != nil {
1261 c.AddProperties(c.lto.props()...)
1262 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001263 if c.afdo != nil {
1264 c.AddProperties(c.afdo.props()...)
1265 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001266 if c.orderfile != nil {
1267 c.AddProperties(c.orderfile.props()...)
1268 }
Colin Crossca860ac2016-01-04 14:34:37 -08001269 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001270 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001271 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001272 // Allow test-only on libraries that are not cc_test_library
1273 if c.library != nil && !c.testLibrary() {
1274 c.AddProperties(&c.sourceProperties)
1275 }
Colin Crossc472d572015-03-17 15:06:21 -07001276
Colin Cross36242852017-06-23 15:06:31 -07001277 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001278 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001279 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001280
Colin Cross36242852017-06-23 15:06:31 -07001281 return c
Colin Crossc472d572015-03-17 15:06:21 -07001282}
1283
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001284// UseVndk() returns true if this module is built against VNDK.
1285// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001286func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001287 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001288}
1289
Colin Crossc511bc52020-04-07 16:50:32 +00001290func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001291 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001292 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001293}
1294
1295func (c *Module) UseSdk() bool {
1296 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001297 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001298 }
1299 return false
1300}
1301
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001302func (c *Module) isCoverageVariant() bool {
1303 return c.coverage.Properties.IsCoverageVariant
1304}
1305
Colin Cross95f1ca02020-10-29 20:47:22 -07001306func (c *Module) IsNdk(config android.Config) bool {
1307 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001308}
1309
Colin Cross127bb8b2020-12-16 16:46:01 -08001310func (c *Module) IsLlndk() bool {
1311 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001312}
1313
Colin Cross127bb8b2020-12-16 16:46:01 -08001314func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001315 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001316}
1317
Colin Cross1f3f1302021-04-26 18:37:44 -07001318func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001319 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001320 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001321}
1322
Colin Cross5271fea2021-04-27 13:06:04 -07001323func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1324 lib := moduleLibraryInterface(m)
1325 return lib != nil && (lib.hasVendorPublicLibrary())
1326}
1327
1328// IsVendorPublicLibrary returns true for vendor public libraries.
1329func (c *Module) IsVendorPublicLibrary() bool {
1330 return c.VendorProperties.IsVendorPublicLibrary
1331}
1332
Ivan Lozanof1868af2022-04-12 13:08:36 -04001333func (c *Module) IsVndkPrebuiltLibrary() bool {
1334 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1335 return true
1336 }
1337 return false
1338}
1339
1340func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1341 return c.Properties.SdkAndPlatformVariantVisibleToMake
1342}
1343
Ivan Lozanod7586b62021-04-01 09:49:36 -04001344func (c *Module) HasLlndkStubs() bool {
1345 lib := moduleLibraryInterface(c)
1346 return lib != nil && lib.hasLLNDKStubs()
1347}
1348
1349func (c *Module) StubsVersion() string {
1350 if lib, ok := c.linker.(versionedInterface); ok {
1351 return lib.stubsVersion()
1352 }
1353 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1354}
1355
Colin Cross127bb8b2020-12-16 16:46:01 -08001356// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1357// and does not set llndk.vendor_available: false.
1358func (c *Module) isImplementationForLLNDKPublic() bool {
1359 library, _ := c.library.(*libraryDecorator)
1360 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001361 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001362}
1363
Justin Yunfd9e8042020-12-23 18:23:14 +09001364// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001365func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001366 // Check if VNDK-core-private or VNDK-SP-private
1367 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001368 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001369 }
1370
1371 // Check if LLNDK-private
1372 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001373 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001374 }
1375
1376 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001377}
1378
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001379// IsVndk() returns true if this module has a vndk variant.
1380// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1381// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001382func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001383 if vndkdep := c.vndkdep; vndkdep != nil {
1384 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001385 }
1386 return false
1387}
1388
Colin Cross3513fb12024-01-24 14:44:47 -08001389func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001390 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001391 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001392 }
1393 return false
1394}
1395
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001396func (c *Module) isOrderfileCompile() bool {
1397 if orderfile := c.orderfile; orderfile != nil {
1398 return orderfile.Properties.OrderfileLoad
1399 }
1400 return false
1401}
1402
Yi Kongc702ebd2022-08-19 16:02:45 +08001403func (c *Module) isCfi() bool {
1404 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001405 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001406 }
1407 return false
1408}
1409
Yi Konged79fa32023-06-04 17:15:42 +09001410func (c *Module) isFuzzer() bool {
1411 if sanitize := c.sanitize; sanitize != nil {
1412 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1413 }
1414 return false
1415}
1416
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001417func (c *Module) isNDKStubLibrary() bool {
1418 if _, ok := c.compiler.(*stubDecorator); ok {
1419 return true
1420 }
1421 return false
1422}
1423
Ivan Lozanod7586b62021-04-01 09:49:36 -04001424func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001425 if vndkdep := c.vndkdep; vndkdep != nil {
1426 return vndkdep.isVndkSp()
1427 }
1428 return false
1429}
1430
Ivan Lozanof9e21722020-12-02 09:00:51 -05001431func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001432 if vndkdep := c.vndkdep; vndkdep != nil {
1433 return vndkdep.isVndkExt()
1434 }
1435 return false
1436}
1437
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001438func (c *Module) SubName() string {
1439 return c.Properties.SubName
1440}
1441
Ivan Lozano52767be2019-10-18 14:49:46 -07001442func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001443 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001444}
1445
Logan Chienf3511742017-10-31 18:04:35 +08001446func (c *Module) getVndkExtendsModuleName() string {
1447 if vndkdep := c.vndkdep; vndkdep != nil {
1448 return vndkdep.getVndkExtendsModuleName()
1449 }
1450 return ""
1451}
1452
Jiyong Park25fc6a92018-11-18 18:02:45 +09001453func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001454 if lib := c.library; lib != nil {
1455 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001456 }
1457 return false
1458}
1459
1460func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001461 if lib := c.library; lib != nil {
1462 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001463 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001464 return false
1465}
1466
Alan Stokes73feba32022-11-14 12:21:24 +00001467func (c *Module) IsStubsImplementationRequired() bool {
1468 if lib := c.library; lib != nil {
1469 return lib.isStubsImplementationRequired()
1470 }
1471 return false
1472}
1473
Colin Cross0477b422020-10-13 18:43:54 -07001474// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1475// the implementation. If it is an implementation library it returns its own name.
1476func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1477 name := ctx.OtherModuleName(c)
1478 if versioned, ok := c.linker.(versionedInterface); ok {
1479 name = versioned.implementationModuleName(name)
1480 }
1481 return name
1482}
1483
Martin Stjernholm2856c662020-12-02 15:03:42 +00001484// Similar to ImplementationModuleName, but uses the Make variant of the module
1485// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1486// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1487// under the premise that the prebuilt module overrides its source counterpart
1488// if it is exposed to Make).
1489func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1490 name := c.BaseModuleName()
1491 if versioned, ok := c.linker.(versionedInterface); ok {
1492 name = versioned.implementationModuleName(name)
1493 }
1494 return name
1495}
1496
Jiyong Park7d55b612021-06-11 17:22:09 +09001497func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001498 return Bool(c.Properties.Bootstrap)
1499}
1500
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001501func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001502 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1503 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1504 return false
1505 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001506 return c.linker != nil && c.linker.nativeCoverage()
1507}
1508
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001509func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001510 if p, ok := c.linker.(SnapshotInterface); ok {
1511 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001512 }
1513 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001514}
1515
Jiyong Parkf1194352019-02-25 11:05:47 +09001516func isBionic(name string) bool {
1517 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001518 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001519 return true
1520 }
1521 return false
1522}
1523
Martin Stjernholm279de572019-09-10 23:18:20 +01001524func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001525 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001526 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001527 }
1528 return isBionic(name)
1529}
1530
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001531func (c *Module) XrefCcFiles() android.Paths {
1532 return c.kytheFiles
1533}
1534
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001535func (c *Module) isCfiAssemblySupportEnabled() bool {
1536 return c.sanitize != nil &&
1537 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1538}
1539
Inseob Kim800d1142021-06-14 12:03:51 +09001540func (c *Module) InstallInRoot() bool {
1541 return c.installer != nil && c.installer.installInRoot()
1542}
1543
Colin Crossca860ac2016-01-04 14:34:37 -08001544type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001545 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001546 moduleContextImpl
1547}
1548
Colin Cross37047f12016-12-13 17:06:13 -08001549type depsContext struct {
1550 android.BottomUpMutatorContext
1551 moduleContextImpl
1552}
1553
Colin Crossca860ac2016-01-04 14:34:37 -08001554type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001555 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001556 moduleContextImpl
1557}
1558
1559type moduleContextImpl struct {
1560 mod *Module
1561 ctx BaseModuleContext
1562}
1563
Colin Crossb98c8b02016-07-29 13:44:28 -07001564func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001565 return ctx.mod.toolchain(ctx.ctx)
1566}
1567
1568func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001569 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001570}
1571
1572func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001573 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001574}
1575
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001576func (ctx *moduleContextImpl) testBinary() bool {
1577 return ctx.mod.testBinary()
1578}
1579
Yi Kong56fc1b62022-09-06 16:24:00 +08001580func (ctx *moduleContextImpl) testLibrary() bool {
1581 return ctx.mod.testLibrary()
1582}
1583
Jiyong Park1d1119f2019-07-29 21:27:18 +09001584func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001585 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001586}
1587
Inseob Kim7f283f42020-06-01 21:53:49 +09001588func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001589 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001590}
1591
Inseob Kim1042d292020-06-01 23:23:05 +09001592func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001593 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001594}
1595
Jooyung Hanccce2f22020-03-07 03:45:53 +09001596func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001597 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001598}
1599
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001600func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001601 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001602}
1603
1604func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001605 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001606 config := ctx.ctx.Config()
1607 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001608 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001609 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001610 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001611 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001612 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001613 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001614 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001615 }
1616 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001617}
1618
Jiyong Parkb35a8192020-08-10 15:59:36 +09001619func (ctx *moduleContextImpl) minSdkVersion() string {
1620 ver := ctx.mod.MinSdkVersion()
1621 if ver == "apex_inherit" && !ctx.isForPlatform() {
1622 ver = ctx.apexSdkVersion().String()
1623 }
1624 if ver == "apex_inherit" || ver == "" {
1625 ver = ctx.sdkVersion()
1626 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001627
1628 if ctx.ctx.Device() {
1629 config := ctx.ctx.Config()
1630 if config.IsVndkDeprecated() && ctx.inVendor() {
1631 // If building for vendor with final API, then use the latest _stable_ API as "current".
1632 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1633 ver = config.PlatformSdkVersion().String()
1634 }
1635 }
1636 }
1637
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001638 // For crt objects, the meaning of min_sdk_version is very different from other types of
1639 // module. For them, min_sdk_version defines the oldest version that the build system will
1640 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1641 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1642 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001643 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1644 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1645 // support such an old version. The version is set to the later version in case when the
1646 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1647 // it's for an APEX.
1648 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1649 if ctx.isForPlatform() {
1650 ver = strconv.Itoa(android.FutureApiLevelInt)
1651 } else { // for apex
1652 ver = ctx.apexSdkVersion().String()
1653 if ver == "" { // in case when min_sdk_version was not set by the APEX
1654 ver = ctx.sdkVersion()
1655 }
1656 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001657 }
1658
Jiyong Parkb35a8192020-08-10 15:59:36 +09001659 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1660 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1661 minSdkVersionInt, err2 := strconv.Atoi(ver)
1662 if err == nil && err2 == nil {
1663 if sdkVersionInt < minSdkVersionInt {
1664 return strconv.Itoa(sdkVersionInt)
1665 }
1666 }
1667 return ver
1668}
1669
1670func (ctx *moduleContextImpl) isSdkVariant() bool {
1671 return ctx.mod.IsSdkVariant()
1672}
1673
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001674func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001675 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001676}
Justin Yun8effde42017-06-23 19:24:43 +09001677
Kiyoung Kimaa394802024-01-08 12:55:45 +09001678func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1679 return ctx.mod.InVendorOrProduct()
1680}
1681
Colin Cross95f1ca02020-10-29 20:47:22 -07001682func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1683 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001684}
1685
Colin Cross127bb8b2020-12-16 16:46:01 -08001686func (ctx *moduleContextImpl) IsLlndk() bool {
1687 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001688}
1689
Colin Cross127bb8b2020-12-16 16:46:01 -08001690func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1691 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001692}
1693
Colin Cross127bb8b2020-12-16 16:46:01 -08001694func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1695 return ctx.mod.isImplementationForLLNDKPublic()
1696}
1697
1698func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1699 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001700}
1701
Logan Chienf3511742017-10-31 18:04:35 +08001702func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001703 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001704}
1705
Colin Cross3513fb12024-01-24 14:44:47 -08001706func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1707 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001708}
1709
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001710func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1711 return ctx.mod.isOrderfileCompile()
1712}
1713
Yi Kongc702ebd2022-08-19 16:02:45 +08001714func (ctx *moduleContextImpl) isCfi() bool {
1715 return ctx.mod.isCfi()
1716}
1717
Yi Konged79fa32023-06-04 17:15:42 +09001718func (ctx *moduleContextImpl) isFuzzer() bool {
1719 return ctx.mod.isFuzzer()
1720}
1721
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001722func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1723 return ctx.mod.isNDKStubLibrary()
1724}
1725
Justin Yun8effde42017-06-23 19:24:43 +09001726func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001727 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001728}
1729
Ivan Lozanof9e21722020-12-02 09:00:51 -05001730func (ctx *moduleContextImpl) IsVndkExt() bool {
1731 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001732}
1733
Colin Cross5271fea2021-04-27 13:06:04 -07001734func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1735 return ctx.mod.IsVendorPublicLibrary()
1736}
1737
Vic Yangefd249e2018-11-12 20:19:56 -08001738func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001739 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001740}
1741
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001742func (ctx *moduleContextImpl) selectedStl() string {
1743 if stl := ctx.mod.stl; stl != nil {
1744 return stl.Properties.SelectedStl
1745 }
1746 return ""
1747}
1748
Ivan Lozanobd721262018-11-27 14:33:03 -08001749func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1750 return ctx.mod.linker.useClangLld(actx)
1751}
1752
Colin Crossce75d2c2016-10-06 16:12:58 -07001753func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001754 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001755}
1756
Logan Chienf3511742017-10-31 18:04:35 +08001757func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1758 return ctx.mod.getVndkExtendsModuleName()
1759}
1760
Logan Chiene274fc92019-12-03 11:18:32 -08001761func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001762 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1763 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001764}
1765
Colin Crosse07f2312020-08-13 11:24:56 -07001766func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001767 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1768 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001769}
1770
Dan Albertc8060532020-07-22 22:32:17 -07001771func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001772 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001773}
1774
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001775func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001776 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001777}
1778
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001779func (ctx *moduleContextImpl) nativeCoverage() bool {
1780 return ctx.mod.nativeCoverage()
1781}
1782
Colin Cross56a83212020-09-15 18:30:11 -07001783func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1784 return ctx.mod.DirectlyInAnyApex()
1785}
1786
Colin Cross95b07f22020-12-16 11:06:50 -08001787func (ctx *moduleContextImpl) isPreventInstall() bool {
1788 return ctx.mod.Properties.PreventInstall
1789}
1790
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001791func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1792 shared := &ctx.mod.sharedFlags
1793 if shared.flagsMap == nil {
1794 shared.numSharedFlags = 0
1795 shared.flagsMap = make(map[string]string)
1796 }
1797 return shared
1798}
1799
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001800func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1801 return ctx.mod.isCfiAssemblySupportEnabled()
1802}
1803
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001804func (ctx *moduleContextImpl) notInPlatform() bool {
1805 return ctx.mod.NotInPlatform()
1806}
1807
Colin Cross635c3b02016-05-18 15:37:25 -07001808func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001809 return &Module{
1810 hod: hod,
1811 multilib: multilib,
1812 }
1813}
1814
Colin Cross635c3b02016-05-18 15:37:25 -07001815func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001816 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001817 module.features = []feature{
1818 &tidyFeature{},
1819 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001820 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001821 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001822 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001823 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001824 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001825 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001826 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001827 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001828 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001829 return module
1830}
1831
Colin Crossce75d2c2016-10-06 16:12:58 -07001832func (c *Module) Prebuilt() *android.Prebuilt {
1833 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1834 return p.prebuilt()
1835 }
1836 return nil
1837}
1838
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001839func (c *Module) IsPrebuilt() bool {
1840 return c.Prebuilt() != nil
1841}
1842
Colin Crossce75d2c2016-10-06 16:12:58 -07001843func (c *Module) Name() string {
1844 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001845 if p, ok := c.linker.(interface {
1846 Name(string) string
1847 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001848 name = p.Name(name)
1849 }
1850 return name
1851}
1852
Alex Light3d673592019-01-18 14:37:31 -08001853func (c *Module) Symlinks() []string {
1854 if p, ok := c.installer.(interface {
1855 symlinkList() []string
1856 }); ok {
1857 return p.symlinkList()
1858 }
1859 return nil
1860}
1861
Roland Levillainf89cd092019-07-29 16:22:59 +01001862func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1863 test, ok := c.linker.(testPerSrc)
1864 return ok && test.isAllTestsVariation()
1865}
1866
Chris Parsons216e10a2020-07-09 17:12:52 -04001867func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001868 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001869 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001870 }); ok {
1871 return p.dataPaths()
1872 }
1873 return nil
1874}
1875
Ivan Lozanof1868af2022-04-12 13:08:36 -04001876func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001877 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1878 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001879 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001880 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001881 if c.ProductSpecific() {
1882 // If the module is product specific with 'product_specific: true',
1883 // do not add a name suffix because it is a base module.
1884 return ""
1885 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001886 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001887 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001888 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001889 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001890 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001891 // add version suffix only if the module is using different vndk version than the
1892 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001893 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001894 }
1895 return nameSuffix
1896}
1897
Ivan Lozanof1868af2022-04-12 13:08:36 -04001898func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1899 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001900
1901 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001902 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001903 }
1904
Colin Cross127bb8b2020-12-16 16:46:01 -08001905 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001906 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001907 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1908 // added for product variant only when we have vendor and product variants with core
1909 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001910 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001911 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001912 subName += vendorPublicLibrarySuffix
1913 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001914 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1915 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001916 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001917 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001918 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001919 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001920 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001921 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001922 subName += RecoverySuffix
1923 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1924 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001925 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001926 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001927 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001928 } else if c.IsStubs() && c.IsSdkVariant() {
1929 // Public API surface (NDK)
1930 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1931 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001932 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001933
1934 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001935}
1936
Sam Delmerico75dbca22023-04-20 13:13:25 +00001937func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1938 ctx := &moduleContext{
1939 ModuleContext: actx,
1940 moduleContextImpl: moduleContextImpl{
1941 mod: c,
1942 },
1943 }
1944 ctx.ctx = ctx
1945 return ctx
1946}
1947
Spandan Das20fce2d2023-04-12 17:21:39 +00001948// TODO (b/277651159): Remove this allowlist
1949var (
1950 skipStubLibraryMultipleApexViolation = map[string]bool{
1951 "libclang_rt.asan": true,
1952 "libclang_rt.hwasan": true,
1953 // runtime apex
1954 "libc": true,
1955 "libc_hwasan": true,
1956 "libdl_android": true,
1957 "libm": true,
1958 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001959 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001960 // art apex
1961 "libandroidio": true,
1962 "libdexfile": true,
1963 "libnativebridge": true,
1964 "libnativehelper": true,
1965 "libnativeloader": true,
1966 "libsigchain": true,
1967 }
1968)
1969
1970// Returns true if a stub library could be installed in multiple apexes
1971func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1972 // If this is not an apex variant, no check necessary
1973 if !c.InAnyApex() {
1974 return false
1975 }
1976 // If this is not a stub library, no check necessary
1977 if !c.HasStubsVariants() {
1978 return false
1979 }
1980 // Skip the allowlist
1981 // Use BaseModuleName so that this matches prebuilts.
1982 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1983 return false
1984 }
1985
1986 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1987 // Stub libraries should not have more than one apex_available
1988 if len(aaWithoutTestApexes) > 1 {
1989 return true
1990 }
1991 // Stub libraries should not use the wildcard
1992 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
1993 return true
1994 }
1995 // Default: no violation
1996 return false
1997}
1998
Chris Parsons8d6e4332021-02-22 16:13:50 -05001999func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002000 ctx := moduleContextFromAndroidModuleContext(actx, c)
2001
Inseob Kim37e0bb02024-04-29 15:54:44 +09002002 c.logtagsPaths = android.PathsForModuleSrc(actx, c.Properties.Logtags)
2003 android.SetProvider(ctx, android.LogtagsProviderKey, &android.LogtagsInfo{
2004 Logtags: c.logtagsPaths,
2005 })
2006
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002007 // If Test_only is set on a module in bp file, respect the setting, otherwise
2008 // see if is a known test module type.
2009 testOnly := c.testModule || c.testLibrary()
2010 if c.sourceProperties.Test_only != nil {
2011 testOnly = Bool(c.sourceProperties.Test_only)
2012 }
2013 // Keep before any early returns.
2014 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
2015 TestOnly: testOnly,
2016 TopLevelTarget: c.testModule,
2017 })
2018
Chris Parsons8d6e4332021-02-22 16:13:50 -05002019 // Handle the case of a test module split by `test_per_src` mutator.
2020 //
2021 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2022 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2023 // module and return early, as this module does not produce an output file per se.
2024 if c.IsTestPerSrcAllTestsVariation() {
2025 c.outputFile = android.OptionalPath{}
2026 return
2027 }
2028
Ivan Lozanof1868af2022-04-12 13:08:36 -04002029 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002030 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002031 if !apexInfo.IsForPlatform() {
2032 c.hideApexVariantFromMake = true
2033 }
2034
Chris Parsonseefc9e62021-04-02 17:36:47 -04002035 c.makeLinkType = GetMakeLinkType(actx, c)
2036
Colin Crossf18e1102017-11-16 14:33:08 -08002037 deps := c.depsToPaths(ctx)
2038 if ctx.Failed() {
2039 return
2040 }
2041
Joe Onorato37f900c2023-07-18 16:58:16 -07002042 for _, generator := range c.generators {
2043 gen := generator.GeneratorSources(ctx)
2044 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2045 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2046 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2047 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2048 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2049 if len(deps.Objs.objFiles) == 0 {
2050 // If we are reusuing object files (which happens when we're a shared library and we're
2051 // reusing our static variant's object files), then skip adding the actual source files,
2052 // because we already have the object for it.
2053 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2054 }
2055 }
2056
2057 if ctx.Failed() {
2058 return
2059 }
2060
Spandan Das20fce2d2023-04-12 17:21:39 +00002061 if c.stubLibraryMultipleApexViolation(actx) {
2062 actx.PropertyErrorf("apex_available",
2063 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2064 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002065 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2066 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002067 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2068 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002069 }
2070
Colin Crossca860ac2016-01-04 14:34:37 -08002071 flags := Flags{
2072 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002073 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002074 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002075 for _, generator := range c.generators {
2076 flags = generator.GeneratorFlags(ctx, flags, deps)
2077 }
Colin Crossca860ac2016-01-04 14:34:37 -08002078 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002079 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002080 }
2081 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002082 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002083 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002084 if c.stl != nil {
2085 flags = c.stl.flags(ctx, flags)
2086 }
Colin Cross16b23492016-01-06 14:41:07 -08002087 if c.sanitize != nil {
2088 flags = c.sanitize.flags(ctx, flags)
2089 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002090 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002091 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002092 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002093 if c.fuzzer != nil {
2094 flags = c.fuzzer.flags(ctx, flags)
2095 }
Stephen Craneba090d12017-05-09 15:44:35 -07002096 if c.lto != nil {
2097 flags = c.lto.flags(ctx, flags)
2098 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002099 if c.afdo != nil {
2100 flags = c.afdo.flags(ctx, flags)
2101 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002102 if c.orderfile != nil {
2103 flags = c.orderfile.flags(ctx, flags)
2104 }
Colin Crossca860ac2016-01-04 14:34:37 -08002105 for _, feature := range c.features {
2106 flags = feature.flags(ctx, flags)
2107 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002108 if ctx.Failed() {
2109 return
2110 }
2111
Colin Cross4af21ed2019-11-04 09:37:55 -08002112 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2113 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2114 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002115
Colin Cross4af21ed2019-11-04 09:37:55 -08002116 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002117
2118 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002119 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002120 }
2121 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002122 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002123 }
2124
Colin Cross3e5e7782022-06-17 22:17:05 +00002125 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2126
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002127 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002128 // We need access to all the flags seen by a source file.
2129 if c.sabi != nil {
2130 flags = c.sabi.flags(ctx, flags)
2131 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002132
Colin Cross4af21ed2019-11-04 09:37:55 -08002133 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002134
Joe Onorato37f900c2023-07-18 16:58:16 -07002135 for _, generator := range c.generators {
2136 generator.GeneratorBuildActions(ctx, flags, deps)
2137 }
2138
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002139 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002140 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002141 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002142 if ctx.Failed() {
2143 return
2144 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002145 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002146 c.objFiles = objs.objFiles
2147 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002148 }
2149
Colin Crossca860ac2016-01-04 14:34:37 -08002150 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002151 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002152 if ctx.Failed() {
2153 return
2154 }
Colin Cross635c3b02016-05-18 15:37:25 -07002155 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002156
Chris Parsons94a0bba2021-06-04 15:03:47 -04002157 c.maybeUnhideFromMake()
Colin Crossce75d2c2016-10-06 16:12:58 -07002158 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002159 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002160 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002161 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002162
Colin Cross40213022023-12-13 15:19:49 -08002163 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002164
Hao Chen1c8ea5b2023-10-20 23:03:45 +00002165 if Bool(c.Properties.Cmake_snapshot_supported) {
2166 android.SetProvider(ctx, cmakeSnapshotSourcesProvider, android.GlobFiles(ctx, ctx.ModuleDir()+"/**/*", nil))
2167 }
2168
Chris Parsons94a0bba2021-06-04 15:03:47 -04002169 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002170
2171 if c.linker != nil {
2172 moduleInfoJSON := ctx.ModuleInfoJSON()
2173 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2174 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2175 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2176 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2177 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2178
2179 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2180 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2181 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2182 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2183
2184 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2185 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2186 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2187 moduleInfoJSON.SubName += ".cfi"
2188 }
2189 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2190 moduleInfoJSON.SubName += ".hwasan"
2191 }
2192 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2193 moduleInfoJSON.SubName += ".scs"
2194 }
2195 }
2196 moduleInfoJSON.SubName += c.Properties.SubName
2197
2198 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2199 moduleInfoJSON.Uninstallable = true
2200 }
2201
2202 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002203}
2204
2205func (c *Module) maybeUnhideFromMake() {
2206 // If a lib is directly included in any of the APEXes or is not available to the
2207 // platform (which is often the case when the stub is provided as a prebuilt),
2208 // unhide the stubs variant having the latest version gets visible to make. In
2209 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2210 // force anything in the make world to link against the stubs library. (unless it
2211 // is explicitly referenced via .bootstrap suffix or the module is marked with
2212 // 'bootstrap: true').
2213 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002214 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002215 c.IsStubs() && !c.InVendorRamdisk() {
2216 c.Properties.HideFromMake = false // unhide
2217 // Note: this is still non-installable
2218 }
2219}
2220
Colin Cross8ff10582023-12-07 13:10:56 -08002221// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2222// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002223func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002224 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002225 // If the module has been specifically configure to not be installed then
2226 // hide from make as otherwise it will break when running inside make
2227 // as the output path to install will not be specified. Not all uninstallable
2228 // modules can be hidden from make as some are needed for resolving make side
2229 // dependencies.
2230 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002231 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002232 c.SkipInstall()
2233 }
2234
2235 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2236 // to allow using the outputs in a genrule.
2237 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002238 c.installer.install(ctx, c.outputFile.Path())
2239 if ctx.Failed() {
2240 return
Colin Crossca860ac2016-01-04 14:34:37 -08002241 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002242 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002243}
2244
Colin Cross0ea8ba82019-06-06 14:33:29 -07002245func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002246 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002247 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002248 }
Colin Crossca860ac2016-01-04 14:34:37 -08002249 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002250}
2251
Colin Crossca860ac2016-01-04 14:34:37 -08002252func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002253 for _, generator := range c.generators {
2254 generator.GeneratorInit(ctx)
2255 }
Colin Crossca860ac2016-01-04 14:34:37 -08002256 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002257 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002258 }
Colin Crossca860ac2016-01-04 14:34:37 -08002259 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002260 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002261 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002262 if c.stl != nil {
2263 c.stl.begin(ctx)
2264 }
Colin Cross16b23492016-01-06 14:41:07 -08002265 if c.sanitize != nil {
2266 c.sanitize.begin(ctx)
2267 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002268 if c.coverage != nil {
2269 c.coverage.begin(ctx)
2270 }
Yi Kong9723e332023-12-04 14:52:53 +09002271 if c.afdo != nil {
2272 c.afdo.begin(ctx)
2273 }
Stephen Craneba090d12017-05-09 15:44:35 -07002274 if c.lto != nil {
2275 c.lto.begin(ctx)
2276 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002277 if c.orderfile != nil {
2278 c.orderfile.begin(ctx)
2279 }
Dan Albert92fe7402020-07-15 13:33:30 -07002280 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002281 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002282 if err != nil {
2283 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002284 c.Properties.Sdk_version = nil
2285 } else {
2286 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002287 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002288 }
Colin Crossca860ac2016-01-04 14:34:37 -08002289}
2290
Colin Cross37047f12016-12-13 17:06:13 -08002291func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002292 deps := Deps{}
2293
Joe Onorato37f900c2023-07-18 16:58:16 -07002294 for _, generator := range c.generators {
2295 deps = generator.GeneratorDeps(ctx, deps)
2296 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002297 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002298 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002299 }
2300 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002301 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002302 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002303 if c.stl != nil {
2304 deps = c.stl.deps(ctx, deps)
2305 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002306 if c.coverage != nil {
2307 deps = c.coverage.deps(ctx, deps)
2308 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002309
Colin Crossb6715442017-10-24 11:13:31 -07002310 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2311 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2312 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2313 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2314 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2315 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002316 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002317 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002318
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002319 for _, lib := range deps.ReexportSharedLibHeaders {
2320 if !inList(lib, deps.SharedLibs) {
2321 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2322 }
2323 }
2324
2325 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002326 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2327 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 -07002328 }
2329 }
2330
Colin Cross5950f382016-12-13 12:50:57 -08002331 for _, lib := range deps.ReexportHeaderLibHeaders {
2332 if !inList(lib, deps.HeaderLibs) {
2333 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2334 }
2335 }
2336
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002337 for _, gen := range deps.ReexportGeneratedHeaders {
2338 if !inList(gen, deps.GeneratedHeaders) {
2339 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2340 }
2341 }
2342
Colin Crossc99deeb2016-04-11 15:06:20 -07002343 return deps
2344}
2345
Dan Albert7e9d2952016-08-04 13:02:36 -07002346func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002347 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002348 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002349 moduleContextImpl: moduleContextImpl{
2350 mod: c,
2351 },
2352 }
2353 ctx.ctx = ctx
2354
Colin Crossca860ac2016-01-04 14:34:37 -08002355 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002356}
2357
Jiyong Park7ed9de32018-10-15 22:25:07 +09002358// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002359func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002360 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2361 version := name[sharp+1:]
2362 libname := name[:sharp]
2363 return libname, version
2364 }
2365 return name, ""
2366}
2367
Dan Albert92fe7402020-07-15 13:33:30 -07002368func GetCrtVariations(ctx android.BottomUpMutatorContext,
2369 m LinkableInterface) []blueprint.Variation {
2370 if ctx.Os() != android.Android {
2371 return nil
2372 }
2373 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002374 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2375 minSdkVersion := m.MinSdkVersion()
2376 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2377 minSdkVersion = m.SdkVersion()
2378 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002379 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2380 if err != nil {
2381 ctx.PropertyErrorf("min_sdk_version", err.Error())
2382 }
Colin Cross363ec762023-01-13 13:45:14 -08002383
2384 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002385 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002386 if apiLevel.LessThan(minApiForArch) {
2387 apiLevel = minApiForArch
2388 }
2389
Dan Albert92fe7402020-07-15 13:33:30 -07002390 return []blueprint.Variation{
2391 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002392 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002393 }
2394 }
2395 return []blueprint.Variation{
2396 {Mutator: "sdk", Variation: ""},
2397 }
2398}
2399
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002400func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2401 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002402
2403 variations = append([]blueprint.Variation(nil), variations...)
2404
Liz Kammer23942242022-04-08 15:41:00 -04002405 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002406 // Version is explicitly specified. i.e. libFoo#30
2407 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002408 if tag, ok := depTag.(libraryDependencyTag); ok {
2409 tag.explicitlyVersioned = true
2410 } else {
2411 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2412 }
Colin Crosse7257d22020-09-24 09:56:18 -07002413 }
Colin Crosse7257d22020-09-24 09:56:18 -07002414
Colin Cross0de8a1e2020-09-18 14:15:30 -07002415 if far {
2416 ctx.AddFarVariationDependencies(variations, depTag, name)
2417 } else {
2418 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002419 }
2420}
2421
Kiyoung Kim487689e2022-07-26 09:48:22 +09002422func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2423 apiImportInfo := multitree.ApiImportInfo{}
2424
2425 if c.Device() {
2426 var apiImportModule []blueprint.Module
2427 if actx.OtherModuleExists("api_imports") {
2428 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2429 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002430 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002431 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002432 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002433 }
2434 }
2435 }
2436
2437 return apiImportInfo
2438}
2439
Kiyoung Kim487689e2022-07-26 09:48:22 +09002440func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2441 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002442 return snapshot
2443 }
2444
2445 return lib
2446}
2447
Kiyoung Kim37693d02024-04-04 09:56:15 +09002448// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002449// of names:
2450//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002451// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002452//
2453// For each of these, it adds the name of the ndk_library module to the list of
2454// variant libs.
2455//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002456// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002457//
2458// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002459//
2460// The caller can then know to add the variantLibs dependencies differently from the
2461// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002462func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002463 variantLibs = []string{}
2464
2465 nonvariantLibs = []string{}
2466 for _, entry := range list {
2467 // strip #version suffix out
2468 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002469 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002470 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002471 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002472 nonvariantLibs = append(nonvariantLibs, entry)
2473 }
2474 }
2475 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002476
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002477}
2478
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002479func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2480 nonVariantLibs := []string{}
2481 variantLibs := []string{}
2482
2483 for _, lib := range libs {
2484 replaceLibName := GetReplaceModuleName(lib, replaceList)
2485 if replaceLibName == lib {
2486 // Do not handle any libs which are not in API imports
2487 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2488 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2489 variantLibs = append(variantLibs, replaceLibName)
2490 } else {
2491 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2492 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002493 }
2494
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002495 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002496}
2497
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002498func (c *Module) shouldUseApiSurface() bool {
2499 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2500 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2501 // LLNDK Variant
2502 return true
2503 }
2504
2505 if c.Properties.IsSdkVariant {
2506 // NDK Variant
2507 return true
2508 }
2509
2510 if c.isImportedApiLibrary() {
2511 // API Library should depend on API headers
2512 return true
2513 }
2514 }
2515
2516 return false
2517}
2518
Colin Cross1e676be2016-10-12 14:38:15 -07002519func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002520 if !c.Enabled(actx) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002521 return
2522 }
2523
Colin Cross37047f12016-12-13 17:06:13 -08002524 ctx := &depsContext{
2525 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002526 moduleContextImpl: moduleContextImpl{
2527 mod: c,
2528 },
2529 }
2530 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002531
Colin Crossc99deeb2016-04-11 15:06:20 -07002532 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002533 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002534
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002535 apiNdkLibs := []string{}
2536 apiLateNdkLibs := []string{}
2537
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002538 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002539 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2540 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2541 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2542 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2543 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002544 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002545
Yo Chiang219968c2020-09-22 18:45:04 +08002546 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2547
Dan Albert914449f2016-06-17 16:45:24 -07002548 variantNdkLibs := []string{}
2549 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002550 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002551 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2552 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2553 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002554 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002555
Colin Cross32ec36c2016-12-15 07:39:51 -08002556 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002557 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002558 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002559 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002560 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002561
Kiyoung Kim51279d32022-08-24 14:10:46 +09002562 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002563 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002564 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2565 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002566
Spandan Das73bcafc2022-08-18 23:26:00 +00002567 if c.isNDKStubLibrary() {
2568 // ndk_headers do not have any variations
2569 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002570 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002571 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002572 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002573 } else {
2574 actx.AddVariationDependencies(nil, depTag, lib)
2575 }
2576 }
2577
Dan Albertf1d14c72020-07-30 14:32:55 -07002578 if c.isNDKStubLibrary() {
2579 // NDK stubs depend on their implementation because the ABI dumps are
2580 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002581
Spandan Das8b08aea2023-03-14 19:29:34 +00002582 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2583 c.ImageVariation(),
2584 blueprint.Variation{Mutator: "link", Variation: "shared"},
2585 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002586 }
2587
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002588 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2589 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2590 c.Target().NativeBridge == android.NativeBridgeDisabled {
2591 actx.AddVariationDependencies(
2592 []blueprint.Variation{{Mutator: "image", Variation: VendorVariation}},
2593 llndkHeaderLibTag,
2594 deps.LlndkHeaderLibs...)
2595 }
2596
Jiyong Park5d1598f2019-02-25 22:14:17 +09002597 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002598 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002599
Jiyong Park5d1598f2019-02-25 22:14:17 +09002600 actx.AddVariationDependencies([]blueprint.Variation{
2601 {Mutator: "link", Variation: "static"},
2602 }, depTag, lib)
2603 }
2604
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002605 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002606 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002607 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002608 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002609 }
Jiyong Parke3867542020-12-03 17:28:25 +09002610 if inList(lib, deps.ExcludeLibsForApex) {
2611 depTag.excludeInApex = true
2612 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002613
Dan Willemsen59339a22018-07-22 21:18:45 -07002614 actx.AddVariationDependencies([]blueprint.Variation{
2615 {Mutator: "link", Variation: "static"},
2616 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002617 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002618
Jooyung Han75568392020-03-20 04:29:24 +09002619 // staticUnwinderDep is treated as staticDep for Q apexes
2620 // so that native libraries/binaries are linked with static unwinder
2621 // because Q libc doesn't have unwinder APIs
2622 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002623 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002624 actx.AddVariationDependencies([]blueprint.Variation{
2625 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002626 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002627 }
2628
Jiyong Park7ed9de32018-10-15 22:25:07 +09002629 // shared lib names without the #version suffix
2630 var sharedLibNames []string
2631
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002632 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002633 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002634 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002635 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002636 }
Jiyong Parke3867542020-12-03 17:28:25 +09002637 if inList(lib, deps.ExcludeLibsForApex) {
2638 depTag.excludeInApex = true
2639 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002640 if inList(lib, deps.ExcludeLibsForNonApex) {
2641 depTag.excludeInNonApex = true
2642 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002643
Jiyong Park73c54ee2019-10-22 20:31:18 +09002644 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002645 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2646 name = apiLibraryName
2647 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002648 sharedLibNames = append(sharedLibNames, name)
2649
Colin Crosse7257d22020-09-24 09:56:18 -07002650 variations := []blueprint.Variation{
2651 {Mutator: "link", Variation: "shared"},
2652 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002653
2654 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2655 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2656 }
2657
2658 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2659 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2660 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002661 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002662
Colin Crossfe9acfe2021-06-14 16:13:03 -07002663 for _, lib := range deps.LateStaticLibs {
2664 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2665 actx.AddVariationDependencies([]blueprint.Variation{
2666 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002667 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002668 }
2669
Colin Cross3e5e7782022-06-17 22:17:05 +00002670 for _, lib := range deps.UnexportedStaticLibs {
2671 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2672 actx.AddVariationDependencies([]blueprint.Variation{
2673 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002674 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00002675 }
2676
Jiyong Park7ed9de32018-10-15 22:25:07 +09002677 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002678 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002679 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2680 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2681 // linking against both the stubs lib and the non-stubs lib at the same time.
2682 continue
2683 }
Colin Cross6e511a92020-07-27 21:26:48 -07002684 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002685 variations := []blueprint.Variation{
2686 {Mutator: "link", Variation: "shared"},
2687 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002688 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002689 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002690
Dan Willemsen59339a22018-07-22 21:18:45 -07002691 actx.AddVariationDependencies([]blueprint.Variation{
2692 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002693 }, dataLibDepTag, deps.DataLibs...)
2694
Colin Crossc8caa062021-09-24 16:50:14 -07002695 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2696
Chris Parsons79d66a52020-06-05 17:26:16 -04002697 actx.AddVariationDependencies([]blueprint.Variation{
2698 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002699 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002700
Colin Cross68861832016-07-08 10:41:41 -07002701 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002702
2703 for _, gen := range deps.GeneratedHeaders {
2704 depTag := genHeaderDepTag
2705 if inList(gen, deps.ReexportGeneratedHeaders) {
2706 depTag = genHeaderExportDepTag
2707 }
2708 actx.AddDependency(c, depTag, gen)
2709 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002710
Dan Albert92fe7402020-07-15 13:33:30 -07002711 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002712 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002713 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002714 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002715 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08002716 }
Colin Crossc465efd2021-06-11 18:00:04 -07002717 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002718 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002719 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07002720 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002721 if deps.DynamicLinker != "" {
2722 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002723 }
Dan Albert914449f2016-06-17 16:45:24 -07002724
2725 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002726
2727 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002728 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002729 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002730 {Mutator: "link", Variation: "shared"},
2731 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002732 actx.AddVariationDependencies([]blueprint.Variation{
2733 {Mutator: "version", Variation: version},
2734 {Mutator: "link", Variation: "shared"},
2735 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002736
2737 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002738 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002739 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002740 {Mutator: "link", Variation: "shared"},
2741 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002742 actx.AddVariationDependencies([]blueprint.Variation{
2743 {Mutator: "version", Variation: version},
2744 {Mutator: "link", Variation: "shared"},
2745 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002746
2747 if vndkdep := c.vndkdep; vndkdep != nil {
2748 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002749 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002750 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002751 {Mutator: "link", Variation: "shared"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002752 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002753 }
2754 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002755
Vinh Tran367d89d2023-04-28 11:21:25 -04002756 if len(deps.AidlLibs) > 0 {
2757 actx.AddDependency(
2758 c,
2759 aidlLibraryTag,
2760 deps.AidlLibs...,
2761 )
2762 }
2763
Kiyoung Kimee58c932022-10-25 22:59:41 +09002764 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002765}
Colin Cross21b9a242015-03-24 14:15:58 -07002766
Colin Crosse40b4ea2018-10-02 22:25:58 -07002767func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002768 if c, ok := ctx.Module().(*Module); ok && c.Enabled(ctx) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002769 c.beginMutator(ctx)
2770 }
2771}
2772
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002773// Whether a module can link to another module, taking into
2774// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002775func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002776 tag blueprint.DependencyTag) {
2777
2778 switch t := tag.(type) {
2779 case dependencyTag:
2780 if t != vndkExtDepTag {
2781 return
2782 }
2783 case libraryDependencyTag:
2784 default:
2785 return
2786 }
2787
Ivan Lozanof9e21722020-12-02 09:00:51 -05002788 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002789 // Host code is not restricted
2790 return
2791 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002792
2793 // VNDK is cc.Module supported only for now.
2794 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002795 // Though allowed dependency is limited by the image mutator,
2796 // each vendor and product module needs to check link-type
2797 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002798 if ccTo, ok := to.(*Module); ok {
2799 if ccFrom.vndkdep != nil {
2800 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2801 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002802 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002803 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002804 }
2805 return
2806 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002807 // TODO(b/244244438) : Remove this once all variants are implemented
2808 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2809 return
2810 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002811 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002812 // Platform code can link to anything
2813 return
2814 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002815 if from.InRamdisk() {
2816 // Ramdisk code is not NDK
2817 return
2818 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002819 if from.InVendorRamdisk() {
2820 // Vendor ramdisk code is not NDK
2821 return
2822 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002823 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002824 // Recovery code is not NDK
2825 return
2826 }
Colin Cross31076b32020-10-23 17:22:06 -07002827 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002828 if c.NdkPrebuiltStl() {
2829 // These are allowed, but they don't set sdk_version
2830 return
2831 }
2832 if c.StubDecorator() {
2833 // These aren't real libraries, but are the stub shared libraries that are included in
2834 // the NDK.
2835 return
2836 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002837 if c.isImportedApiLibrary() {
2838 // Imported library from the API surface is a stub library built against interface definition.
2839 return
2840 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002841 }
Logan Chien834b9a62019-01-14 15:39:03 +08002842
Ivan Lozano52767be2019-10-18 14:49:46 -07002843 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002844 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2845 // to link to libc++ (non-NDK and without sdk_version).
2846 return
2847 }
2848
Ivan Lozano52767be2019-10-18 14:49:46 -07002849 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002850 // NDK code linking to platform code is never okay.
2851 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002852 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002853 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002854 }
2855
2856 // At this point we know we have two NDK libraries, but we need to
2857 // check that we're not linking against anything built against a higher
2858 // API level, as it is only valid to link against older or equivalent
2859 // APIs.
2860
Inseob Kim01a28722018-04-11 09:48:45 +09002861 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002862 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002863 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002864 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002865 // Current can't be linked against by anything else.
2866 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002867 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002868 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002869 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002870 if err != nil {
2871 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002872 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002873 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002874 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002875 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002876 if err != nil {
2877 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002878 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002879 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002880 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002881
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002882 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002883 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002884 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002885 }
2886 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002887 }
Dan Albert202fe492017-12-15 13:56:59 -08002888
2889 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002890 fromStl := from.SelectedStl()
2891 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002892 if fromStl == "" || toStl == "" {
2893 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002894 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002895 // We can be permissive with the system "STL" since it is only the C++
2896 // ABI layer, but in the future we should make sure that everyone is
2897 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002898 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002899 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002900 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2901 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002902 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002903}
2904
Jooyung Han479ca172020-10-19 18:51:07 +09002905func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2906 if c, ok := ctx.Module().(*Module); ok {
2907 ctx.VisitDirectDeps(func(dep android.Module) {
2908 depTag := ctx.OtherModuleDependencyTag(dep)
2909 ccDep, ok := dep.(LinkableInterface)
2910 if ok {
2911 checkLinkType(ctx, c, ccDep, depTag)
2912 }
2913 })
2914 }
2915}
2916
Jiyong Park5fb8c102018-04-09 12:03:06 +09002917// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002918// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2919// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002920// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002921func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2922 check := func(child, parent android.Module) bool {
2923 to, ok := child.(*Module)
2924 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002925 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002926 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002927
Jooyung Hana70f0672019-01-18 15:20:43 +09002928 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2929 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002930 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002931
Jiyong Park0474e1f2021-01-14 14:26:06 +09002932 // These dependencies are not excercised at runtime. Tracking these will give us
2933 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002934 depTag := ctx.OtherModuleDependencyTag(child)
2935 if IsHeaderDepTag(depTag) {
2936 return false
2937 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002938 if depTag == staticVariantTag {
2939 return false
2940 }
2941 if depTag == stubImplDepTag {
2942 return false
2943 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09002944 if depTag == android.RequiredDepTag {
2945 return false
2946 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002947
Justin Yun63e9ec72020-10-29 16:49:43 +09002948 // Even if target lib has no vendor variant, keep checking dependency
2949 // graph in case it depends on vendor_available or product_available
2950 // but not double_loadable transtively.
2951 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002952 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002953 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002954
Jiyong Park0474e1f2021-01-14 14:26:06 +09002955 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2956 // one.
2957 if Bool(to.VendorProperties.Double_loadable) {
2958 return true
2959 }
2960
Ivan Lozanod7586b62021-04-01 09:49:36 -04002961 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002962 return false
2963 }
2964
Jooyung Hana70f0672019-01-18 15:20:43 +09002965 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2966 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002967 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002968 return false
2969 }
2970 if module, ok := ctx.Module().(*Module); ok {
2971 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002972 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002973 ctx.WalkDeps(check)
2974 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002975 }
2976 }
2977}
2978
Yu Liue4312402023-01-18 09:15:31 -08002979func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
2980 // For the dependency from platform to apex, use the latest stubs
2981 apexSdkVersion := android.FutureApiLevel
2982 if !apexInfo.IsForPlatform() {
2983 apexSdkVersion = apexInfo.MinSdkVersion
2984 }
2985
2986 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2987 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2988 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2989 // (b/144430859)
2990 apexSdkVersion = android.FutureApiLevel
2991 }
2992
2993 return apexSdkVersion
2994}
2995
Colin Crossc99deeb2016-04-11 15:06:20 -07002996// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002997func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002998 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002999
Colin Cross0de8a1e2020-09-18 14:15:30 -07003000 var directStaticDeps []StaticLibraryInfo
3001 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003002
Colin Cross0de8a1e2020-09-18 14:15:30 -07003003 reexportExporter := func(exporter FlagExporterInfo) {
3004 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3005 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3006 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3007 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3008 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003009 }
3010
Colin Crossff694a82023-12-13 15:54:49 -08003011 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003012 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003013
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003014 skipModuleList := map[string]bool{}
3015
3016 var apiImportInfo multitree.ApiImportInfo
3017 hasApiImportInfo := false
3018
3019 ctx.VisitDirectDeps(func(dep android.Module) {
3020 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003021 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003022 hasApiImportInfo = true
3023 }
3024 })
3025
3026 if hasApiImportInfo {
3027 targetStubModuleList := map[string]string{}
3028 targetOrigModuleList := map[string]string{}
3029
3030 // Search for dependency which both original module and API imported library with APEX stub exists
3031 ctx.VisitDirectDeps(func(dep android.Module) {
3032 depName := ctx.OtherModuleName(dep)
3033 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3034 targetStubModuleList[apiLibrary] = depName
3035 }
3036 })
3037 ctx.VisitDirectDeps(func(dep android.Module) {
3038 depName := ctx.OtherModuleName(dep)
3039 if origLibrary, ok := targetStubModuleList[depName]; ok {
3040 targetOrigModuleList[origLibrary] = depName
3041 }
3042 })
3043
3044 // Decide which library should be used between original and API imported library
3045 ctx.VisitDirectDeps(func(dep android.Module) {
3046 depName := ctx.OtherModuleName(dep)
3047 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003048 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003049 skipModuleList[depName] = true
3050 } else {
3051 skipModuleList[apiLibrary] = true
3052 }
3053 }
3054 })
3055 }
3056
Colin Crossd11fcda2017-10-23 17:59:01 -07003057 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003058 depName := ctx.OtherModuleName(dep)
3059 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003060
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003061 if _, ok := skipModuleList[depName]; ok {
3062 // skip this module because original module or API imported module matching with this should be used instead.
3063 return
3064 }
3065
Dan Willemsen47450072021-10-19 20:24:49 -07003066 if depTag == android.DarwinUniversalVariantTag {
3067 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3068 return
3069 }
3070
Vinh Tran367d89d2023-04-28 11:21:25 -04003071 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003072 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003073 depPaths.AidlLibraryInfos = append(
3074 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003075 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003076 )
3077 }
3078 }
3079
Ivan Lozano52767be2019-10-18 14:49:46 -07003080 ccDep, ok := dep.(LinkableInterface)
3081 if !ok {
3082
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003083 // handling for a few module types that aren't cc Module but that are also supported
3084 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003085 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003086 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003087 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3088 genRule.GeneratedSourceFiles()...)
3089 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003090 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003091 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003092 // Support exported headers from a generated_sources dependency
3093 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003094 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003095 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003096 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003097 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003098 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003099 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003100 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003101 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003102 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3103 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003104 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003105 // 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 +09003106 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003107
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003108 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003109 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003110 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003111 }
Colin Crosscef792e2021-06-11 18:01:26 -07003112 case CrtBeginDepTag:
3113 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3114 case CrtEndDepTag:
3115 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003116 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003117 return
3118 }
3119
Colin Crossfe17f6f2019-03-28 19:30:56 -07003120 if depTag == android.ProtoPluginDepTag {
3121 return
3122 }
3123
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003124 if depTag == android.RequiredDepTag {
3125 return
3126 }
3127
Colin Crossd11fcda2017-10-23 17:59:01 -07003128 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003129 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3130 return
3131 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003132 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003133 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3134 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003135 return
3136 }
3137
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003138 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003139 // Skip reused objects for stub libraries, they use their own stub object file instead.
3140 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3141 // version mutator, so the stubs variant is created from the shared variant that
3142 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003143 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003144 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003145 objs := staticAnalogue.ReuseObjects
3146 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003147 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003148 reexportExporter(depExporterInfo)
3149 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003150 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003151 }
3152
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003153 if depTag == llndkHeaderLibTag {
3154 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3155 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3156 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3157 }
3158
Colin Cross6e511a92020-07-27 21:26:48 -07003159 linkFile := ccDep.OutputFile()
3160
3161 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3162 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003163 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003164 return
3165 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003166
Jiyong Parke3867542020-12-03 17:28:25 +09003167 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3168 return
3169 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003170 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3171 return
3172 }
Jiyong Parke3867542020-12-03 17:28:25 +09003173
Colin Cross313aa542023-12-13 13:47:44 -08003174 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003175
Colin Cross6e511a92020-07-27 21:26:48 -07003176 var ptr *android.Paths
3177 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003178
Colin Cross6e511a92020-07-27 21:26:48 -07003179 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003180
Colin Cross6e511a92020-07-27 21:26:48 -07003181 switch {
3182 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003183 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003184 if !ctx.Config().AllowMissingDependencies() {
3185 ctx.ModuleErrorf("module %q is not a header library", depName)
3186 } else {
3187 ctx.AddMissingDependencies([]string{depName})
3188 }
3189 return
3190 }
Colin Cross6e511a92020-07-27 21:26:48 -07003191 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003192 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003193 if !ctx.Config().AllowMissingDependencies() {
3194 ctx.ModuleErrorf("module %q is not a shared library", depName)
3195 } else {
3196 ctx.AddMissingDependencies([]string{depName})
3197 }
3198 return
3199 }
Jiyong Parke3867542020-12-03 17:28:25 +09003200
Jiyong Park7d55b612021-06-11 17:22:09 +09003201 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3202 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003203
Jiyong Park1ad8e162020-12-01 23:40:09 +09003204 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3205 // linkFile, depFile, and ptr.
3206 if c.IsStubs() {
3207 break
3208 }
3209
Colin Cross0de8a1e2020-09-18 14:15:30 -07003210 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3211 depFile = sharedLibraryInfo.TableOfContents
3212
Colin Cross6e511a92020-07-27 21:26:48 -07003213 ptr = &depPaths.SharedLibs
3214 switch libDepTag.Order {
3215 case earlyLibraryDependency:
3216 ptr = &depPaths.EarlySharedLibs
3217 depPtr = &depPaths.EarlySharedLibsDeps
3218 case normalLibraryDependency:
3219 ptr = &depPaths.SharedLibs
3220 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003221 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003222 case lateLibraryDependency:
3223 ptr = &depPaths.LateSharedLibs
3224 depPtr = &depPaths.LateSharedLibsDeps
3225 default:
3226 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003227 }
Colin Cross6e511a92020-07-27 21:26:48 -07003228 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003229 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3230 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003231 if !ctx.Config().AllowMissingDependencies() {
3232 ctx.ModuleErrorf("module %q is not a static library", depName)
3233 } else {
3234 ctx.AddMissingDependencies([]string{depName})
3235 }
3236 return
3237 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003238
3239 // Stubs lib doesn't link to the static lib dependencies. Don't set
3240 // linkFile, depFile, and ptr.
3241 if c.IsStubs() {
3242 break
3243 }
3244
Colin Cross0de8a1e2020-09-18 14:15:30 -07003245 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003246 if libDepTag.wholeStatic {
3247 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003248 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3249 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003250 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003251 // This case normally catches prebuilt static
3252 // libraries, but it can also occur when
3253 // AllowMissingDependencies is on and the
3254 // dependencies has no sources of its own
3255 // but has a whole_static_libs dependency
3256 // on a missing library. We want to depend
3257 // on the .a file so that there is something
3258 // in the dependency tree that contains the
3259 // error rule for the missing transitive
3260 // dependency.
3261 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003262 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003263 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3264 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003265 } else {
3266 switch libDepTag.Order {
3267 case earlyLibraryDependency:
3268 panic(fmt.Errorf("early static libs not suppported"))
3269 case normalLibraryDependency:
3270 // static dependencies will be handled separately so they can be ordered
3271 // using transitive dependencies.
3272 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003273 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003274 case lateLibraryDependency:
3275 ptr = &depPaths.LateStaticLibs
3276 default:
3277 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003278 }
3279 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003280 if libDepTag.unexportedSymbols {
3281 depPaths.LdFlags = append(depPaths.LdFlags,
3282 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3283 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003284 }
3285
Colin Cross6e511a92020-07-27 21:26:48 -07003286 if libDepTag.static() && !libDepTag.wholeStatic {
3287 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3288 ctx.ModuleErrorf("module %q not a static library", depName)
3289 return
3290 }
Logan Chien43d34c32017-12-20 01:17:32 +08003291
Colin Cross6e511a92020-07-27 21:26:48 -07003292 // When combining coverage files for shared libraries and executables, coverage files
3293 // in static libraries act as if they were whole static libraries. The same goes for
3294 // source based Abi dump files.
3295 if c, ok := ccDep.(*Module); ok {
3296 staticLib := c.linker.(libraryInterface)
3297 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3298 staticLib.objs().coverageFiles...)
3299 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3300 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003301 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003302 // Handle non-CC modules here
3303 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003304 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003305 }
3306 }
3307
Colin Cross6e511a92020-07-27 21:26:48 -07003308 if ptr != nil {
3309 if !linkFile.Valid() {
3310 if !ctx.Config().AllowMissingDependencies() {
3311 ctx.ModuleErrorf("module %q missing output file", depName)
3312 } else {
3313 ctx.AddMissingDependencies([]string{depName})
3314 }
3315 return
3316 }
3317 *ptr = append(*ptr, linkFile.Path())
3318 }
3319
3320 if depPtr != nil {
3321 dep := depFile
3322 if !dep.Valid() {
3323 dep = linkFile
3324 }
3325 *depPtr = append(*depPtr, dep.Path())
3326 }
3327
Colin Cross0de8a1e2020-09-18 14:15:30 -07003328 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3329 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3330 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3331 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3332
3333 if libDepTag.reexportFlags {
3334 reexportExporter(depExporterInfo)
3335 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3336 // Re-exported shared library headers must be included as well since they can help us with type information
3337 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003338 c.sabi.Properties.ReexportedIncludes = append(
3339 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003340 c.sabi.Properties.ReexportedSystemIncludes = append(
3341 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003342 }
3343
Spandan Das3faa7922024-02-26 19:42:32 +00003344 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003345 switch {
3346 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003347 c.Properties.AndroidMkHeaderLibs = append(
3348 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003349 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003350 if lib := moduleLibraryInterface(dep); lib != nil {
3351 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003352 // Add the dependency to the APEX(es) providing the library so that
3353 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003354 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003355 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003356 c.Properties.ApexesProvidingSharedLibs = append(
3357 c.Properties.ApexesProvidingSharedLibs, an)
3358 }
3359 }
3360 }
3361
3362 // Note: the order of libs in this list is not important because
3363 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003364 c.Properties.AndroidMkSharedLibs = append(
3365 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003366 case libDepTag.static():
3367 if libDepTag.wholeStatic {
3368 c.Properties.AndroidMkWholeStaticLibs = append(
3369 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3370 } else {
3371 c.Properties.AndroidMkStaticLibs = append(
3372 c.Properties.AndroidMkStaticLibs, makeLibName)
3373 }
3374 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003375 } else if !c.IsStubs() {
3376 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3377
Colin Cross6e511a92020-07-27 21:26:48 -07003378 switch depTag {
3379 case runtimeDepTag:
3380 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003381 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003382 case objDepTag:
3383 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3384 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003385 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003386 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003387 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003388 case dynamicLinkerDepTag:
3389 depPaths.DynamicLinker = linkFile
3390 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003391 }
Colin Crossca860ac2016-01-04 14:34:37 -08003392 })
3393
Jeff Gaston294356f2017-09-27 17:05:30 -07003394 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003395 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3396 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3397 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003398
Colin Crossdd84e052017-05-17 13:44:16 -07003399 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003400 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003401 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3402 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003403 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003404 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3405 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003406 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003407 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003408 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003409
3410 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003411 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003412 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003413 }
Colin Crossdd84e052017-05-17 13:44:16 -07003414
Colin Crossca860ac2016-01-04 14:34:37 -08003415 return depPaths
3416}
3417
Spandan Das604f3762023-03-16 22:51:40 +00003418func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003419 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003420 thisModule, ok := ctx.Module().(android.ApexModule)
3421 if !ok {
3422 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3423 }
3424
Kiyoung Kimaa394802024-01-08 12:55:45 +09003425 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003426 bootstrap := false
3427 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3428 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3429 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003430 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003431 bootstrap = linkable.Bootstrap()
3432 }
3433
Colin Crossff694a82023-12-13 15:54:49 -08003434 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003435
3436 useStubs := false
3437
Kiyoung Kimaa394802024-01-08 12:55:45 +09003438 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003439 if !apexInfo.IsForPlatform() {
3440 // For platform libraries, use current version of LLNDK
3441 // If this is for use_vendor apex we will apply the same rules
3442 // of apex sdk enforcement below to choose right version.
3443 useStubs = true
3444 }
3445 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3446 // If not building for APEX or the containing APEX allows the use of
3447 // platform APIs, use stubs only when it is from an APEX (and not from
3448 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3449 // bootstrap modules, always link to non-stub variant
3450 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3451
3452 isApexImportedApiLibrary := false
3453
3454 if cc, ok := dep.(*Module); ok {
3455 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3456 if apiLibrary.hasApexStubs() {
3457 isApexImportedApiLibrary = true
3458 }
3459 }
3460 }
3461
3462 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3463
3464 if useStubs {
3465 // Another exception: if this module is a test for an APEX, then
3466 // it is linked with the non-stub variant of a module in the APEX
3467 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003468 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003469 for _, apexContents := range testFor.ApexContents {
3470 if apexContents.DirectlyInApex(depName) {
3471 useStubs = false
3472 break
3473 }
3474 }
3475 }
3476 if useStubs {
3477 // Yet another exception: If this module and the dependency are
3478 // available to the same APEXes then skip stubs between their
3479 // platform variants. This complements the test_for case above,
3480 // which avoids the stubs on a direct APEX library dependency, by
3481 // avoiding stubs for indirect test dependencies as well.
3482 //
3483 // TODO(b/183882457): This doesn't work if the two libraries have
3484 // only partially overlapping apex_available. For that test_for
3485 // modules would need to be split into APEX variants and resolved
3486 // separately for each APEX they have access to.
3487 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3488 useStubs = false
3489 }
3490 }
3491 } else {
3492 // If building for APEX, use stubs when the parent is in any APEX that
3493 // the child is not in.
3494 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3495 }
3496
3497 return useStubs
3498}
3499
3500// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3501// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3502// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3503// has different level of updatability. For example, if a library foo in an APEX depends on a
3504// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3505// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3506// same APEX as foo, the non-stub variant of bar is used.
3507func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3508 depTag := ctx.OtherModuleDependencyTag(dep)
3509 libDepTag, ok := depTag.(libraryDependencyTag)
3510 if !ok || !libDepTag.shared() {
3511 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3512 }
3513
Colin Cross313aa542023-12-13 13:47:44 -08003514 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3515 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3516 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003517
3518 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003519 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003520 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003521 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3522 toUse := stubs[len(stubs)-1]
3523 sharedLibraryInfo = toUse.SharedLibraryInfo
3524 depExporterInfo = toUse.FlagExporterInfo
3525 }
3526 }
3527 return sharedLibraryInfo, depExporterInfo
3528}
3529
Colin Cross0de8a1e2020-09-18 14:15:30 -07003530// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3531// to match the topological order of the dependency tree, including any static analogues of
3532// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3533// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003534func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3535 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003536 var staticPaths android.Paths
3537 for _, staticDep := range staticDeps {
3538 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3539 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3540 }
3541 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003542 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3543 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003544 }
3545 }
3546 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3547
3548 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3549
3550 // reorder the dependencies based on transitive dependencies
3551 staticPaths = android.FirstUniquePaths(staticPaths)
3552 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3553
3554 if len(orderedStaticPaths) != len(staticPaths) {
3555 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3556 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3557 }
3558
3559 return orderedStaticPaths, transitiveStaticLibs
3560}
3561
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003562// BaseLibName trims known prefixes and suffixes
3563func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003564 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3565 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003566 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003567 return libName
3568}
3569
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003570func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003571 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003572 ccDepModule, _ := ccDep.(*Module)
3573 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003574 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003575
Justin Yuncbca3732021-02-03 19:24:13 +09003576 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003577 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003578 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003579 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003580
Ivan Lozanod1dec542021-05-26 15:33:11 -04003581 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003582 }
3583 }
3584
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003585 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3586 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003587 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3588 // core module instead.
3589 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003590 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003591 // The vendor and product modules in Make will have been renamed to not conflict with the
3592 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003593 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003594 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003595 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003596 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003597 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003598 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003599 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003600 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003601 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003602 } else {
3603 return libName
3604 }
3605}
3606
Colin Crossca860ac2016-01-04 14:34:37 -08003607func (c *Module) InstallInData() bool {
3608 if c.installer == nil {
3609 return false
3610 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003611 return c.installer.inData()
3612}
3613
3614func (c *Module) InstallInSanitizerDir() bool {
3615 if c.installer == nil {
3616 return false
3617 }
3618 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003619 return true
3620 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003621 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003622}
3623
Yifan Hong1b3348d2020-01-21 15:53:22 -08003624func (c *Module) InstallInRamdisk() bool {
3625 return c.InRamdisk()
3626}
3627
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003628func (c *Module) InstallInVendorRamdisk() bool {
3629 return c.InVendorRamdisk()
3630}
3631
Jiyong Parkf9332f12018-02-01 00:54:12 +09003632func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003633 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003634}
3635
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003636func (c *Module) MakeUninstallable() {
3637 if c.installer == nil {
3638 c.ModuleBase.MakeUninstallable()
3639 return
3640 }
3641 c.installer.makeUninstallable(c)
3642}
3643
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003644func (c *Module) HostToolPath() android.OptionalPath {
3645 if c.installer == nil {
3646 return android.OptionalPath{}
3647 }
3648 return c.installer.hostToolPath()
3649}
3650
Nan Zhangd4e641b2017-07-12 12:55:28 -07003651func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3652 return c.outputFile
3653}
3654
Colin Cross41955e82019-05-29 14:40:35 -07003655func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3656 switch tag {
3657 case "":
3658 if c.outputFile.Valid() {
3659 return android.Paths{c.outputFile.Path()}, nil
3660 }
3661 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003662 case "unstripped":
3663 if c.linker != nil {
3664 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3665 }
3666 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003667 case "stripped_all":
3668 if c.linker != nil {
3669 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3670 }
3671 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003672 default:
3673 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003674 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003675}
3676
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003677func (c *Module) static() bool {
3678 if static, ok := c.linker.(interface {
3679 static() bool
3680 }); ok {
3681 return static.static()
3682 }
3683 return false
3684}
3685
Jiyong Park379de2f2018-12-19 02:47:14 +09003686func (c *Module) staticBinary() bool {
3687 if static, ok := c.linker.(interface {
3688 staticBinary() bool
3689 }); ok {
3690 return static.staticBinary()
3691 }
3692 return false
3693}
3694
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003695func (c *Module) testBinary() bool {
3696 if test, ok := c.linker.(interface {
3697 testBinary() bool
3698 }); ok {
3699 return test.testBinary()
3700 }
3701 return false
3702}
3703
Jingwen Chen537242c2022-08-24 11:53:27 +00003704func (c *Module) testLibrary() bool {
3705 if test, ok := c.linker.(interface {
3706 testLibrary() bool
3707 }); ok {
3708 return test.testLibrary()
3709 }
3710 return false
3711}
3712
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003713func (c *Module) benchmarkBinary() bool {
3714 if b, ok := c.linker.(interface {
3715 benchmarkBinary() bool
3716 }); ok {
3717 return b.benchmarkBinary()
3718 }
3719 return false
3720}
3721
3722func (c *Module) fuzzBinary() bool {
3723 if f, ok := c.linker.(interface {
3724 fuzzBinary() bool
3725 }); ok {
3726 return f.fuzzBinary()
3727 }
3728 return false
3729}
3730
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003731// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3732func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003733 if h, ok := c.linker.(interface {
3734 header() bool
3735 }); ok {
3736 return h.header()
3737 }
3738 return false
3739}
3740
Ivan Lozanod7586b62021-04-01 09:49:36 -04003741func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003742 if b, ok := c.linker.(interface {
3743 binary() bool
3744 }); ok {
3745 return b.binary()
3746 }
3747 return false
3748}
3749
Justin Yun5e035862021-06-29 20:50:37 +09003750func (c *Module) StaticExecutable() bool {
3751 if b, ok := c.linker.(*binaryDecorator); ok {
3752 return b.static()
3753 }
3754 return false
3755}
3756
Ivan Lozanod7586b62021-04-01 09:49:36 -04003757func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003758 if o, ok := c.linker.(interface {
3759 object() bool
3760 }); ok {
3761 return o.object()
3762 }
3763 return false
3764}
3765
Kiyoung Kim37693d02024-04-04 09:56:15 +09003766func (m *Module) Dylib() bool {
3767 return false
3768}
3769
3770func (m *Module) Rlib() bool {
3771 return false
3772}
3773
Ivan Lozanof9e21722020-12-02 09:00:51 -05003774func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003775 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003776 if c.IsLlndk() {
3777 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003778 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003779 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003780 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003781 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003782 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003783 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003784 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003785 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003786 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003787 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003788 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003789 return "native:product"
3790 }
Jooyung Han38002912019-05-16 04:01:54 +09003791 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003792 } else if c.InRamdisk() {
3793 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003794 } else if c.InVendorRamdisk() {
3795 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003796 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003797 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003798 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003799 return "native:ndk:none:none"
3800 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3801 //family, link := getNdkStlFamilyAndLinkType(c)
3802 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003803 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003804 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003805 } else {
3806 return "native:platform"
3807 }
3808}
3809
Jiyong Park9d452992018-10-03 00:38:19 +09003810// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003811// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003812func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003813 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003814 // Stub libs and prebuilt libs in a versioned SDK are not
3815 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003816 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003817 } else if _, ok := c.linker.(testPerSrc); ok {
3818 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003819 }
3820 return false
3821}
3822
Jiyong Parka90ca002019-10-07 15:47:24 +09003823func (c *Module) AvailableFor(what string) bool {
3824 if linker, ok := c.linker.(interface {
3825 availableFor(string) bool
3826 }); ok {
3827 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3828 } else {
3829 return c.ApexModuleBase.AvailableFor(what)
3830 }
3831}
3832
Jiyong Park62304bb2020-04-13 16:19:48 +09003833func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003834 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003835}
3836
Paul Duffin0cb37b92020-03-04 14:52:46 +00003837func (c *Module) EverInstallable() bool {
3838 return c.installer != nil &&
3839 // Check to see whether the module is actually ever installable.
3840 c.installer.everInstallable()
3841}
3842
Ivan Lozanod7586b62021-04-01 09:49:36 -04003843func (c *Module) PreventInstall() bool {
3844 return c.Properties.PreventInstall
3845}
3846
3847func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003848 if c.library != nil {
3849 if i := c.library.installable(); i != nil {
3850 return i
3851 }
3852 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003853 return c.Properties.Installable
3854}
3855
3856func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003857 ret := c.EverInstallable() &&
3858 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003859 proptools.BoolDefault(c.Installable(), true) &&
3860 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003861
3862 // The platform variant doesn't need further condition. Apex variants however might not
3863 // be installable because it will likely to be included in the APEX and won't appear
3864 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003865 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003866 return ret
3867 }
3868
3869 // Special case for modules that are configured to be installed to /data, which includes
3870 // test modules. For these modules, both APEX and non-APEX variants are considered as
3871 // installable. This is because even the APEX variants won't be included in the APEX, but
3872 // will anyway be installed to /data/*.
3873 // See b/146995717
3874 if c.InstallInData() {
3875 return ret
3876 }
3877
3878 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003879}
3880
Logan Chien41eabe62019-04-10 13:33:58 +08003881func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3882 if c.linker != nil {
3883 if library, ok := c.linker.(*libraryDecorator); ok {
3884 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3885 }
3886 }
3887}
3888
Jiyong Park45bf82e2020-12-15 22:29:02 +09003889var _ android.ApexModule = (*Module)(nil)
3890
3891// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003892func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003893 depTag := ctx.OtherModuleDependencyTag(dep)
3894 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3895
3896 if cc, ok := dep.(*Module); ok {
3897 if cc.HasStubsVariants() {
3898 if isLibDepTag && libDepTag.shared() {
3899 // dynamic dep to a stubs lib crosses APEX boundary
3900 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003901 }
Colin Cross6e511a92020-07-27 21:26:48 -07003902 if IsRuntimeDepTag(depTag) {
3903 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003904 return false
3905 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003906 }
Zhijun Heec285872021-04-24 10:47:08 -07003907 if cc.IsLlndk() {
3908 return false
3909 }
Colin Crossaac32222020-07-29 12:51:56 -07003910 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003911 // shared_lib dependency from a static lib is considered as crossing
3912 // the APEX boundary because the dependency doesn't actually is
3913 // linked; the dependency is used only during the compilation phase.
3914 return false
3915 }
Jiyong Parke3867542020-12-03 17:28:25 +09003916
3917 if isLibDepTag && libDepTag.excludeInApex {
3918 return false
3919 }
Colin Cross6e511a92020-07-27 21:26:48 -07003920 }
Colin Crossc1b36442021-05-06 13:42:48 -07003921 if depTag == stubImplDepTag {
3922 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003923 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003924 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003925 if depTag == staticVariantTag {
3926 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3927 // actually mean that the static lib (and its dependencies) are copied into the
3928 // APEX.
3929 return false
3930 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003931 return true
3932}
3933
Jiyong Park45bf82e2020-12-15 22:29:02 +09003934// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003935func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3936 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003937 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3938 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3939 return nil
3940 }
Jooyung Han749dc692020-04-15 11:03:39 +09003941 // We don't check for prebuilt modules
3942 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3943 return nil
3944 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003945
Jooyung Han749dc692020-04-15 11:03:39 +09003946 minSdkVersion := c.MinSdkVersion()
3947 if minSdkVersion == "apex_inherit" {
3948 return nil
3949 }
3950 if minSdkVersion == "" {
3951 // JNI libs within APK-in-APEX fall into here
3952 // Those are okay to set sdk_version instead
3953 // We don't have to check if this is a SDK variant because
3954 // non-SDK variant resets sdk_version, which works too.
3955 minSdkVersion = c.SdkVersion()
3956 }
Dan Albertc8060532020-07-22 22:32:17 -07003957 if minSdkVersion == "" {
3958 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3959 }
3960 // Not using nativeApiLevelFromUser because the context here is not
3961 // necessarily a native context.
3962 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003963 if err != nil {
3964 return err
3965 }
Dan Albertc8060532020-07-22 22:32:17 -07003966
Colin Cross8ca61c12022-10-06 21:00:14 -07003967 // A dependency only needs to support a min_sdk_version at least
3968 // as high as the api level that the architecture was introduced in.
3969 // This allows introducing new architectures in the platform that
3970 // need to be included in apexes that normally require an older
3971 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003972 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003973 if sdkVersion.LessThan(minApiForArch) {
3974 sdkVersion = minApiForArch
3975 }
3976
Dan Albertc8060532020-07-22 22:32:17 -07003977 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003978 return fmt.Errorf("newer SDK(%v)", ver)
3979 }
3980 return nil
3981}
3982
Paul Duffinb5769c12021-05-12 16:16:51 +01003983// Implements android.ApexModule
3984func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3985 // stub libraries and native bridge libraries are always available to platform
3986 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3987}
3988
Jooyung Han91f92032022-02-04 12:36:33 +09003989// Overrides android.ApexModuleBase.UniqueApexVariations
3990func (c *Module) UniqueApexVariations() bool {
3991 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
3992 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
3993 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09003994 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09003995 return c.UseVndk() && c.IsVndk()
3996}
3997
Inseob Kima1888ce2022-10-04 14:42:02 +09003998func (c *Module) overriddenModules() []string {
3999 if o, ok := c.linker.(overridable); ok {
4000 return o.overriddenModules()
4001 }
4002 return nil
4003}
4004
Liz Kammer35ca77e2021-12-22 15:31:40 -05004005type moduleType int
4006
4007const (
4008 unknownType moduleType = iota
4009 binary
4010 object
4011 fullLibrary
4012 staticLibrary
4013 sharedLibrary
4014 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004015 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004016 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004017 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004018)
4019
4020func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004021 if c.testBinary() {
4022 // testBinary is also a binary, so this comes before the c.Binary()
4023 // conditional. A testBinary has additional implicit dependencies and
4024 // other test-only semantics.
4025 return testBin
4026 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004027 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004028 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004029 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004030 } else if c.testLibrary() {
4031 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4032 // will let them add implicit compile deps on gtest, for example.
4033 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004034 // For now, treat them as regular libraries.
4035 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004036 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004037 static := false
4038 shared := false
4039 if library, ok := c.linker.(*libraryDecorator); ok {
4040 static = library.MutatedProperties.BuildStatic
4041 shared = library.MutatedProperties.BuildShared
4042 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4043 static = library.MutatedProperties.BuildStatic
4044 shared = library.MutatedProperties.BuildShared
4045 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004046 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004047 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004048 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004049 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004050 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004051 return staticLibrary
4052 }
4053 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004054 } else if c.isNDKStubLibrary() {
4055 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004056 } else if c.IsNdkPrebuiltStl() {
4057 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004058 }
4059 return unknownType
4060}
4061
Colin Crosscfad1192015-11-02 16:43:11 -08004062// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004063type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004064 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004065 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004066 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08004067}
4068
Patrice Arrudac249c712019-03-19 17:00:29 -07004069// cc_defaults provides a set of properties that can be inherited by other cc
4070// modules. A module can use the properties from a cc_defaults using
4071// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4072// merged (when possible) by prepending the default module's values to the
4073// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004074func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004075 return DefaultsFactory()
4076}
4077
Colin Cross36242852017-06-23 15:06:31 -07004078func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004079 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004080
Colin Cross36242852017-06-23 15:06:31 -07004081 module.AddProperties(props...)
4082 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004083 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004084 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004085 &BaseCompilerProperties{},
4086 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004087 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004088 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004089 &StaticProperties{},
4090 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004091 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004092 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004093 &TestLinkerProperties{},
4094 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004095 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004096 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004097 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004098 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004099 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004100 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004101 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004102 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004103 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004104 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004105 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004106 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004107 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004108 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004109 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004110 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4111 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004112 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004113 )
Colin Crosscfad1192015-11-02 16:43:11 -08004114
Jooyung Hancc372c52019-09-25 15:18:44 +09004115 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004116
4117 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004118}
4119
Jiyong Park2286afd2020-06-16 21:58:53 +09004120func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004121 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004122}
4123
Kiyoung Kim51279d32022-08-24 14:10:46 +09004124func (c *Module) isImportedApiLibrary() bool {
4125 _, ok := c.linker.(*apiLibraryDecorator)
4126 return ok
4127}
4128
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004129func kytheExtractAllFactory() android.Singleton {
4130 return &kytheExtractAllSingleton{}
4131}
4132
4133type kytheExtractAllSingleton struct {
4134}
4135
4136func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4137 var xrefTargets android.Paths
4138 ctx.VisitAllModules(func(module android.Module) {
4139 if ccModule, ok := module.(xref); ok {
4140 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4141 }
4142 })
4143 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4144 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004145 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004146 }
4147}
4148
Jihoon Kangf78a8902022-09-01 22:47:07 +00004149func (c *Module) Partition() string {
4150 if p, ok := c.installer.(interface {
4151 getPartition() string
4152 }); ok {
4153 return p.getPartition()
4154 }
4155 return ""
4156}
4157
Spandan Das2b6dfb52024-01-19 00:22:22 +00004158type sourceModuleName interface {
4159 sourceModuleName() string
4160}
4161
4162func (c *Module) BaseModuleName() string {
4163 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4164 // if the prebuilt module sets a source_module_name in Android.bp, use that
4165 return smn.sourceModuleName()
4166 }
4167 return c.ModuleBase.BaseModuleName()
4168}
4169
Colin Cross06a931b2015-10-28 17:23:31 -07004170var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004171var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004172var BoolPtr = proptools.BoolPtr
4173var String = proptools.String
4174var StringPtr = proptools.StringPtr